net/ice/base: support NVM rollback detection
[dpdk.git] / drivers / net / ice / base / ice_type.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2001-2019
3  */
4
5 #ifndef _ICE_TYPE_H_
6 #define _ICE_TYPE_H_
7
8 #define ETH_ALEN        6
9
10 #define ETH_HEADER_LEN  14
11
12 #define BIT(a) (1UL << (a))
13 #define BIT_ULL(a) (1ULL << (a))
14
15 #define BITS_PER_BYTE   8
16
17 #ifndef _FORCE_
18 #define _FORCE_
19 #endif
20
21 #define ICE_BYTES_PER_WORD      2
22 #define ICE_BYTES_PER_DWORD     4
23 #define ICE_MAX_TRAFFIC_CLASS   8
24
25 #define MIN_T(_t, _a, _b)       min((_t)(_a), (_t)(_b))
26
27 #define IS_ASCII(_ch)   ((_ch) < 0x80)
28
29 #include "ice_status.h"
30 #include "ice_hw_autogen.h"
31 #include "ice_devids.h"
32 #include "ice_osdep.h"
33 #include "ice_bitops.h" /* Must come before ice_controlq.h */
34 #include "ice_controlq.h"
35 #include "ice_lan_tx_rx.h"
36 #include "ice_flex_type.h"
37 #include "ice_protocol_type.h"
38
39 static inline bool ice_is_tc_ena(ice_bitmap_t bitmap, u8 tc)
40 {
41         return ice_is_bit_set(&bitmap, tc);
42 }
43
44 #define DIV_64BIT(n, d) ((n) / (d))
45
46 static inline u64 round_up_64bit(u64 a, u32 b)
47 {
48         return DIV_64BIT(((a) + (b) / 2), (b));
49 }
50
51 static inline u32 ice_round_to_num(u32 N, u32 R)
52 {
53         return ((((N) % (R)) < ((R) / 2)) ? (((N) / (R)) * (R)) :
54                 ((((N) + (R) - 1) / (R)) * (R)));
55 }
56
57 /* Driver always calls main vsi_handle first */
58 #define ICE_MAIN_VSI_HANDLE             0
59
60 /* Switch from ms to the 1usec global time (this is the GTIME resolution) */
61 #define ICE_MS_TO_GTIME(time)           ((time) * 1000)
62
63 /* Data type manipulation macros. */
64 #define ICE_HI_DWORD(x)         ((u32)((((x) >> 16) >> 16) & 0xFFFFFFFF))
65 #define ICE_LO_DWORD(x)         ((u32)((x) & 0xFFFFFFFF))
66 #define ICE_HI_WORD(x)          ((u16)(((x) >> 16) & 0xFFFF))
67
68 /* debug masks - set these bits in hw->debug_mask to control output */
69 #define ICE_DBG_TRACE           BIT_ULL(0) /* for function-trace only */
70 #define ICE_DBG_INIT            BIT_ULL(1)
71 #define ICE_DBG_RELEASE         BIT_ULL(2)
72 #define ICE_DBG_FW_LOG          BIT_ULL(3)
73 #define ICE_DBG_LINK            BIT_ULL(4)
74 #define ICE_DBG_PHY             BIT_ULL(5)
75 #define ICE_DBG_QCTX            BIT_ULL(6)
76 #define ICE_DBG_NVM             BIT_ULL(7)
77 #define ICE_DBG_LAN             BIT_ULL(8)
78 #define ICE_DBG_FLOW            BIT_ULL(9)
79 #define ICE_DBG_DCB             BIT_ULL(10)
80 #define ICE_DBG_DIAG            BIT_ULL(11)
81 #define ICE_DBG_FD              BIT_ULL(12)
82 #define ICE_DBG_SW              BIT_ULL(13)
83 #define ICE_DBG_SCHED           BIT_ULL(14)
84
85 #define ICE_DBG_PKG             BIT_ULL(16)
86 #define ICE_DBG_RES             BIT_ULL(17)
87 #define ICE_DBG_AQ_MSG          BIT_ULL(24)
88 #define ICE_DBG_AQ_DESC         BIT_ULL(25)
89 #define ICE_DBG_AQ_DESC_BUF     BIT_ULL(26)
90 #define ICE_DBG_AQ_CMD          BIT_ULL(27)
91 #define ICE_DBG_AQ              (ICE_DBG_AQ_MSG         | \
92                                  ICE_DBG_AQ_DESC        | \
93                                  ICE_DBG_AQ_DESC_BUF    | \
94                                  ICE_DBG_AQ_CMD)
95
96 #define ICE_DBG_USER            BIT_ULL(31)
97 #define ICE_DBG_ALL             0xFFFFFFFFFFFFFFFFULL
98
99 #ifndef __ALWAYS_UNUSED
100 #define __ALWAYS_UNUSED
101 #endif
102
103
104
105
106
107 enum ice_aq_res_ids {
108         ICE_NVM_RES_ID = 1,
109         ICE_SPD_RES_ID,
110         ICE_CHANGE_LOCK_RES_ID,
111         ICE_GLOBAL_CFG_LOCK_RES_ID
112 };
113
114 /* FW update timeout definitions are in milliseconds */
115 #define ICE_NVM_TIMEOUT                 180000
116 #define ICE_CHANGE_LOCK_TIMEOUT         1000
117 #define ICE_GLOBAL_CFG_LOCK_TIMEOUT     3000
118
119 enum ice_aq_res_access_type {
120         ICE_RES_READ = 1,
121         ICE_RES_WRITE
122 };
123
124 struct ice_driver_ver {
125         u8 major_ver;
126         u8 minor_ver;
127         u8 build_ver;
128         u8 subbuild_ver;
129         u8 driver_string[32];
130 };
131
132 enum ice_fc_mode {
133         ICE_FC_NONE = 0,
134         ICE_FC_RX_PAUSE,
135         ICE_FC_TX_PAUSE,
136         ICE_FC_FULL,
137         ICE_FC_PFC,
138         ICE_FC_DFLT
139 };
140
141 enum ice_phy_cache_mode {
142         ICE_FC_MODE = 0,
143         ICE_SPEED_MODE,
144         ICE_FEC_MODE
145 };
146
147 enum ice_fec_mode {
148         ICE_FEC_NONE = 0,
149         ICE_FEC_RS,
150         ICE_FEC_BASER,
151         ICE_FEC_AUTO
152 };
153
154 struct ice_phy_cache_mode_data {
155         union {
156                 enum ice_fec_mode curr_user_fec_req;
157                 enum ice_fc_mode curr_user_fc_req;
158                 u16 curr_user_speed_req;
159         } data;
160 };
161
162 enum ice_set_fc_aq_failures {
163         ICE_SET_FC_AQ_FAIL_NONE = 0,
164         ICE_SET_FC_AQ_FAIL_GET,
165         ICE_SET_FC_AQ_FAIL_SET,
166         ICE_SET_FC_AQ_FAIL_UPDATE
167 };
168
169 /* These are structs for managing the hardware information and the operations */
170 /* MAC types */
171 enum ice_mac_type {
172         ICE_MAC_UNKNOWN = 0,
173         ICE_MAC_GENERIC,
174 };
175
176 /* Media Types */
177 enum ice_media_type {
178         ICE_MEDIA_UNKNOWN = 0,
179         ICE_MEDIA_FIBER,
180         ICE_MEDIA_BASET,
181         ICE_MEDIA_BACKPLANE,
182         ICE_MEDIA_DA,
183 };
184
185 /* Software VSI types. */
186 enum ice_vsi_type {
187         ICE_VSI_PF = 0,
188         ICE_VSI_CTRL = 3,       /* equates to ICE_VSI_PF with 1 queue pair */
189         ICE_VSI_LB = 6,
190 };
191
192 struct ice_link_status {
193         /* Refer to ice_aq_phy_type for bits definition */
194         u64 phy_type_low;
195         u64 phy_type_high;
196         u8 topo_media_conflict;
197         u16 max_frame_size;
198         u16 link_speed;
199         u16 req_speeds;
200         u8 lse_ena;     /* Link Status Event notification */
201         u8 link_info;
202         u8 an_info;
203         u8 ext_info;
204         u8 fec_info;
205         u8 pacing;
206         /* Refer to #define from module_type[ICE_MODULE_TYPE_TOTAL_BYTE] of
207          * ice_aqc_get_phy_caps structure
208          */
209         u8 module_type[ICE_MODULE_TYPE_TOTAL_BYTE];
210 };
211
212 /* Different data queue types: These are mainly for SW consumption. */
213 enum ice_q {
214         ICE_DATA_Q_DOORBELL,
215         ICE_DATA_Q_CMPL,
216         ICE_DATA_Q_QUANTA,
217         ICE_DATA_Q_RX,
218         ICE_DATA_Q_TX,
219 };
220
221 /* Different reset sources for which a disable queue AQ call has to be made in
222  * order to clean the Tx scheduler as a part of the reset
223  */
224 enum ice_disq_rst_src {
225         ICE_NO_RESET = 0,
226         ICE_VM_RESET,
227 };
228
229 /* PHY info such as phy_type, etc... */
230 struct ice_phy_info {
231         struct ice_link_status link_info;
232         struct ice_link_status link_info_old;
233         u64 phy_type_low;
234         u64 phy_type_high;
235         enum ice_media_type media_type;
236         u8 get_link_info;
237         /* Please refer to struct ice_aqc_get_link_status_data to get
238          * detail of enable bit in curr_user_speed_req
239          */
240         u16 curr_user_speed_req;
241         enum ice_fec_mode curr_user_fec_req;
242         enum ice_fc_mode curr_user_fc_req;
243         struct ice_aqc_set_phy_cfg_data curr_user_phy_cfg;
244 };
245
246 #define ICE_MAX_NUM_MIRROR_RULES        64
247
248 /* protocol enumeration for filters */
249 enum ice_fltr_ptype {
250         /* NONE - used for undef/error */
251         ICE_FLTR_PTYPE_NONF_NONE = 0,
252         ICE_FLTR_PTYPE_NONF_IPV4_UDP,
253         ICE_FLTR_PTYPE_NONF_IPV4_TCP,
254         ICE_FLTR_PTYPE_NONF_IPV4_SCTP,
255         ICE_FLTR_PTYPE_NONF_IPV4_OTHER,
256         ICE_FLTR_PTYPE_FRAG_IPV4,
257         ICE_FLTR_PTYPE_NONF_IPV6_UDP,
258         ICE_FLTR_PTYPE_NONF_IPV6_TCP,
259         ICE_FLTR_PTYPE_NONF_IPV6_SCTP,
260         ICE_FLTR_PTYPE_NONF_IPV6_OTHER,
261         ICE_FLTR_PTYPE_MAX,
262 };
263
264 /* 2 VSI = 1 ICE_VSI_PF + 1 ICE_VSI_CTRL */
265 #define ICE_MAX_FDIR_VSI_PER_FILTER     2
266
267 struct ice_fd_hw_prof {
268         struct ice_flow_seg_info *fdir_seg;
269         int cnt;
270         u64 entry_h[ICE_MAX_FDIR_VSI_PER_FILTER];
271         u16 vsi_h[ICE_MAX_FDIR_VSI_PER_FILTER];
272 };
273
274 /* Common HW capabilities for SW use */
275 struct ice_hw_common_caps {
276         /* Write CSR protection */
277         u64 wr_csr_prot;
278         u32 switching_mode;
279         /* switching mode supported - EVB switching (including cloud) */
280 #define ICE_NVM_IMAGE_TYPE_EVB          0x0
281
282         /* Manageablity mode & supported protocols over MCTP */
283         u32 mgmt_mode;
284 #define ICE_MGMT_MODE_PASS_THRU_MODE_M          0xF
285 #define ICE_MGMT_MODE_CTL_INTERFACE_M           0xF0
286 #define ICE_MGMT_MODE_REDIR_SB_INTERFACE_M      0xF00
287
288         u32 mgmt_protocols_mctp;
289 #define ICE_MGMT_MODE_PROTO_RSVD        BIT(0)
290 #define ICE_MGMT_MODE_PROTO_PLDM        BIT(1)
291 #define ICE_MGMT_MODE_PROTO_OEM         BIT(2)
292 #define ICE_MGMT_MODE_PROTO_NC_SI       BIT(3)
293
294         u32 os2bmc;
295         u32 valid_functions;
296         /* DCB capabilities */
297         u32 active_tc_bitmap;
298         u32 maxtc;
299
300         /* RSS related capabilities */
301         u32 rss_table_size;             /* 512 for PFs and 64 for VFs */
302         u32 rss_table_entry_width;      /* RSS Entry width in bits */
303
304         /* Tx/Rx queues */
305         u32 num_rxq;                    /* Number/Total Rx queues */
306         u32 rxq_first_id;               /* First queue ID for Rx queues */
307         u32 num_txq;                    /* Number/Total Tx queues */
308         u32 txq_first_id;               /* First queue ID for Tx queues */
309
310         /* MSI-X vectors */
311         u32 num_msix_vectors;
312         u32 msix_vector_first_id;
313
314         /* Max MTU for function or device */
315         u32 max_mtu;
316
317         /* WOL related */
318         u32 num_wol_proxy_fltr;
319         u32 wol_proxy_vsi_seid;
320
321         /* LED/SDP pin count */
322         u32 led_pin_num;
323         u32 sdp_pin_num;
324
325         /* LED/SDP - Supports up to 12 LED pins and 8 SDP signals */
326 #define ICE_MAX_SUPPORTED_GPIO_LED      12
327 #define ICE_MAX_SUPPORTED_GPIO_SDP      8
328         u8 led[ICE_MAX_SUPPORTED_GPIO_LED];
329         u8 sdp[ICE_MAX_SUPPORTED_GPIO_SDP];
330
331         /* EVB capabilities */
332         u8 evb_802_1_qbg;               /* Edge Virtual Bridging */
333         u8 evb_802_1_qbh;               /* Bridge Port Extension */
334
335         u8 dcb;
336         u8 iscsi;
337         u8 mgmt_cem;
338
339         /* WoL and APM support */
340 #define ICE_WOL_SUPPORT_M               BIT(0)
341 #define ICE_ACPI_PROG_MTHD_M            BIT(1)
342 #define ICE_PROXY_SUPPORT_M             BIT(2)
343         u8 apm_wol_support;
344         u8 acpi_prog_mthd;
345         u8 proxy_support;
346 };
347
348
349 /* Function specific capabilities */
350 struct ice_hw_func_caps {
351         struct ice_hw_common_caps common_cap;
352         u32 guar_num_vsi;
353         u32 fd_fltr_guar;               /* Number of filters guaranteed */
354         u32 fd_fltr_best_effort;        /* Number of best effort filters */
355 };
356
357 /* Device wide capabilities */
358 struct ice_hw_dev_caps {
359         struct ice_hw_common_caps common_cap;
360         u32 num_vsi_allocd_to_host;     /* Excluding EMP VSI */
361         u32 num_flow_director_fltr;     /* Number of FD filters available */
362 };
363
364
365 /* Information about MAC such as address, etc... */
366 struct ice_mac_info {
367         u8 lan_addr[ETH_ALEN];
368         u8 perm_addr[ETH_ALEN];
369         u8 port_addr[ETH_ALEN];
370         u8 wol_addr[ETH_ALEN];
371 };
372
373 /* PCI bus types */
374 enum ice_bus_type {
375         ice_bus_unknown = 0,
376         ice_bus_pci_express,
377         ice_bus_embedded, /* Is device Embedded versus card */
378         ice_bus_reserved
379 };
380
381 /* PCI bus speeds */
382 enum ice_pcie_bus_speed {
383         ice_pcie_speed_unknown  = 0xff,
384         ice_pcie_speed_2_5GT    = 0x14,
385         ice_pcie_speed_5_0GT    = 0x15,
386         ice_pcie_speed_8_0GT    = 0x16,
387         ice_pcie_speed_16_0GT   = 0x17
388 };
389
390 /* PCI bus widths */
391 enum ice_pcie_link_width {
392         ice_pcie_lnk_width_resrv        = 0x00,
393         ice_pcie_lnk_x1                 = 0x01,
394         ice_pcie_lnk_x2                 = 0x02,
395         ice_pcie_lnk_x4                 = 0x04,
396         ice_pcie_lnk_x8                 = 0x08,
397         ice_pcie_lnk_x12                = 0x0C,
398         ice_pcie_lnk_x16                = 0x10,
399         ice_pcie_lnk_x32                = 0x20,
400         ice_pcie_lnk_width_unknown      = 0xff,
401 };
402
403 /* Reset types used to determine which kind of reset was requested. These
404  * defines match what the RESET_TYPE field of the GLGEN_RSTAT register.
405  * ICE_RESET_PFR does not match any RESET_TYPE field in the GLGEN_RSTAT register
406  * because its reset source is different than the other types listed.
407  */
408 enum ice_reset_req {
409         ICE_RESET_POR   = 0,
410         ICE_RESET_INVAL = 0,
411         ICE_RESET_CORER = 1,
412         ICE_RESET_GLOBR = 2,
413         ICE_RESET_EMPR  = 3,
414         ICE_RESET_PFR   = 4,
415 };
416
417 /* Bus parameters */
418 struct ice_bus_info {
419         enum ice_pcie_bus_speed speed;
420         enum ice_pcie_link_width width;
421         enum ice_bus_type type;
422         u16 domain_num;
423         u16 device;
424         u8 func;
425         u8 bus_num;
426 };
427
428 /* Flow control (FC) parameters */
429 struct ice_fc_info {
430         enum ice_fc_mode current_mode;  /* FC mode in effect */
431         enum ice_fc_mode req_mode;      /* FC mode requested by caller */
432 };
433
434 /* NVM Information */
435 struct ice_nvm_info {
436         u32 eetrack;                    /* NVM data version */
437         u32 oem_ver;                    /* OEM version info */
438         u16 sr_words;                   /* Shadow RAM size in words */
439         u16 ver;                        /* dev starter version */
440         u8 blank_nvm_mode;              /* is NVM empty (no FW present)*/
441 };
442
443 #define ICE_NVM_VER_LEN 32
444
445 /* Max number of port to queue branches w.r.t topology */
446 #define ICE_TXSCHED_MAX_BRANCHES ICE_MAX_TRAFFIC_CLASS
447
448 #define ice_for_each_traffic_class(_i)  \
449         for ((_i) = 0; (_i) < ICE_MAX_TRAFFIC_CLASS; (_i)++)
450
451 /* ICE_DFLT_AGG_ID means that all new VM(s)/VSI node connects
452  * to driver defined policy for default aggregator
453  */
454 #define ICE_INVAL_TEID 0xFFFFFFFF
455 #define ICE_DFLT_AGG_ID 0
456
457 struct ice_sched_node {
458         struct ice_sched_node *parent;
459         struct ice_sched_node *sibling; /* next sibling in the same layer */
460         struct ice_sched_node **children;
461         struct ice_aqc_txsched_elem_data info;
462         u32 agg_id;                     /* aggregator group ID */
463         u16 vsi_handle;
464         u8 in_use;                      /* suspended or in use */
465         u8 tx_sched_layer;              /* Logical Layer (1-9) */
466         u8 num_children;
467         u8 tc_num;
468         u8 owner;
469 #define ICE_SCHED_NODE_OWNER_LAN        0
470 #define ICE_SCHED_NODE_OWNER_AE         1
471 #define ICE_SCHED_NODE_OWNER_RDMA       2
472 };
473
474 /* Access Macros for Tx Sched Elements data */
475 #define ICE_TXSCHED_GET_NODE_TEID(x) LE32_TO_CPU((x)->info.node_teid)
476 #define ICE_TXSCHED_GET_PARENT_TEID(x) LE32_TO_CPU((x)->info.parent_teid)
477 #define ICE_TXSCHED_GET_CIR_RL_ID(x)    \
478         LE16_TO_CPU((x)->info.cir_bw.bw_profile_idx)
479 #define ICE_TXSCHED_GET_EIR_RL_ID(x)    \
480         LE16_TO_CPU((x)->info.eir_bw.bw_profile_idx)
481 #define ICE_TXSCHED_GET_SRL_ID(x) LE16_TO_CPU((x)->info.srl_id)
482 #define ICE_TXSCHED_GET_CIR_BWALLOC(x)  \
483         LE16_TO_CPU((x)->info.cir_bw.bw_alloc)
484 #define ICE_TXSCHED_GET_EIR_BWALLOC(x)  \
485         LE16_TO_CPU((x)->info.eir_bw.bw_alloc)
486
487 struct ice_sched_rl_profle {
488         u32 rate; /* In Kbps */
489         struct ice_aqc_rl_profile_elem info;
490 };
491
492 /* The aggregator type determines if identifier is for a VSI group,
493  * aggregator group, aggregator of queues, or queue group.
494  */
495 enum ice_agg_type {
496         ICE_AGG_TYPE_UNKNOWN = 0,
497         ICE_AGG_TYPE_TC,
498         ICE_AGG_TYPE_AGG, /* aggregator */
499         ICE_AGG_TYPE_VSI,
500         ICE_AGG_TYPE_QG,
501         ICE_AGG_TYPE_Q
502 };
503
504 /* Rate limit types */
505 enum ice_rl_type {
506         ICE_UNKNOWN_BW = 0,
507         ICE_MIN_BW,             /* for CIR profile */
508         ICE_MAX_BW,             /* for EIR profile */
509         ICE_SHARED_BW           /* for shared profile */
510 };
511
512 #define ICE_SCHED_MIN_BW                500             /* in Kbps */
513 #define ICE_SCHED_MAX_BW                100000000       /* in Kbps */
514 #define ICE_SCHED_DFLT_BW               0xFFFFFFFF      /* unlimited */
515 #define ICE_SCHED_NO_PRIORITY           0
516 #define ICE_SCHED_NO_BW_WT              0
517 #define ICE_SCHED_DFLT_RL_PROF_ID       0
518 #define ICE_SCHED_NO_SHARED_RL_PROF_ID  0xFFFF
519 #define ICE_SCHED_DFLT_BW_WT            1
520 #define ICE_SCHED_INVAL_PROF_ID         0xFFFF
521 #define ICE_SCHED_DFLT_BURST_SIZE       (15 * 1024)     /* in bytes (15k) */
522
523 /* Access Macros for Tx Sched RL Profile data */
524 #define ICE_TXSCHED_GET_RL_PROF_ID(p) LE16_TO_CPU((p)->info.profile_id)
525 #define ICE_TXSCHED_GET_RL_MBS(p) LE16_TO_CPU((p)->info.max_burst_size)
526 #define ICE_TXSCHED_GET_RL_MULTIPLIER(p) LE16_TO_CPU((p)->info.rl_multiply)
527 #define ICE_TXSCHED_GET_RL_WAKEUP_MV(p) LE16_TO_CPU((p)->info.wake_up_calc)
528 #define ICE_TXSCHED_GET_RL_ENCODE(p) LE16_TO_CPU((p)->info.rl_encode)
529
530
531 /* The following tree example shows the naming conventions followed under
532  * ice_port_info struct for default scheduler tree topology.
533  *
534  *                 A tree on a port
535  *                       *                ---> root node
536  *        (TC0)/  /  /  / \  \  \  \(TC7) ---> num_branches (range:1- 8)
537  *            *  *  *  *   *  *  *  *     |
538  *           /                            |
539  *          *                             |
540  *         /                              |-> num_elements (range:1 - 9)
541  *        *                               |   implies num_of_layers
542  *       /                                |
543  *   (a)*                                 |
544  *
545  *  (a) is the last_node_teid(not of type Leaf). A leaf node is created under
546  *  (a) as child node where queues get added, add Tx/Rx queue admin commands;
547  *  need TEID of (a) to add queues.
548  *
549  *  This tree
550  *       -> has 8 branches (one for each TC)
551  *       -> First branch (TC0) has 4 elements
552  *       -> has 4 layers
553  *       -> (a) is the topmost layer node created by firmware on branch 0
554  *
555  *  Note: Above asterisk tree covers only basic terminology and scenario.
556  *  Refer to the documentation for more info.
557  */
558
559  /* Data structure for saving BW information */
560 enum ice_bw_type {
561         ICE_BW_TYPE_PRIO,
562         ICE_BW_TYPE_CIR,
563         ICE_BW_TYPE_CIR_WT,
564         ICE_BW_TYPE_EIR,
565         ICE_BW_TYPE_EIR_WT,
566         ICE_BW_TYPE_SHARED,
567         ICE_BW_TYPE_CNT         /* This must be last */
568 };
569
570 struct ice_bw {
571         u32 bw;
572         u16 bw_alloc;
573 };
574
575 struct ice_bw_type_info {
576         ice_declare_bitmap(bw_t_bitmap, ICE_BW_TYPE_CNT);
577         u8 generic;
578         struct ice_bw cir_bw;
579         struct ice_bw eir_bw;
580         u32 shared_bw;
581 };
582
583 /* VSI queue context structure for given TC */
584 struct ice_q_ctx {
585         u16  q_handle;
586         u32  q_teid;
587         /* bw_t_info saves queue BW information */
588         struct ice_bw_type_info bw_t_info;
589 };
590
591 /* VSI type list entry to locate corresponding VSI/aggregator nodes */
592 struct ice_sched_vsi_info {
593         struct ice_sched_node *vsi_node[ICE_MAX_TRAFFIC_CLASS];
594         struct ice_sched_node *ag_node[ICE_MAX_TRAFFIC_CLASS];
595         u16 max_lanq[ICE_MAX_TRAFFIC_CLASS];
596         /* bw_t_info saves VSI BW information */
597         struct ice_bw_type_info bw_t_info[ICE_MAX_TRAFFIC_CLASS];
598 };
599
600 /* CEE or IEEE 802.1Qaz ETS Configuration data */
601 struct ice_dcb_ets_cfg {
602         u8 willing;
603         u8 cbs;
604         u8 maxtcs;
605         u8 prio_table[ICE_MAX_TRAFFIC_CLASS];
606         u8 tcbwtable[ICE_MAX_TRAFFIC_CLASS];
607         u8 tsatable[ICE_MAX_TRAFFIC_CLASS];
608 };
609
610 /* CEE or IEEE 802.1Qaz PFC Configuration data */
611 struct ice_dcb_pfc_cfg {
612         u8 willing;
613         u8 mbc;
614         u8 pfccap;
615         u8 pfcena;
616 };
617
618 /* CEE or IEEE 802.1Qaz Application Priority data */
619 struct ice_dcb_app_priority_table {
620         u16 prot_id;
621         u8 priority;
622         u8 selector;
623 };
624
625 #define ICE_MAX_USER_PRIORITY   8
626 #define ICE_DCBX_MAX_APPS       32
627 #define ICE_LLDPDU_SIZE         1500
628 #define ICE_TLV_STATUS_OPER     0x1
629 #define ICE_TLV_STATUS_SYNC     0x2
630 #define ICE_TLV_STATUS_ERR      0x4
631 #define ICE_APP_PROT_ID_FCOE    0x8906
632 #define ICE_APP_PROT_ID_ISCSI   0x0cbc
633 #define ICE_APP_PROT_ID_FIP     0x8914
634 #define ICE_APP_SEL_ETHTYPE     0x1
635 #define ICE_APP_SEL_TCPIP       0x2
636 #define ICE_CEE_APP_SEL_ETHTYPE 0x0
637 #define ICE_CEE_APP_SEL_TCPIP   0x1
638
639 struct ice_dcbx_cfg {
640         u32 numapps;
641         u32 tlv_status; /* CEE mode TLV status */
642         struct ice_dcb_ets_cfg etscfg;
643         struct ice_dcb_ets_cfg etsrec;
644         struct ice_dcb_pfc_cfg pfc;
645         struct ice_dcb_app_priority_table app[ICE_DCBX_MAX_APPS];
646         u8 dcbx_mode;
647 #define ICE_DCBX_MODE_CEE       0x1
648 #define ICE_DCBX_MODE_IEEE      0x2
649         u8 app_mode;
650 #define ICE_DCBX_APPS_NON_WILLING       0x1
651 };
652
653 struct ice_port_info {
654         struct ice_sched_node *root;    /* Root Node per Port */
655         struct ice_hw *hw;              /* back pointer to HW instance */
656         u32 last_node_teid;             /* scheduler last node info */
657         u16 sw_id;                      /* Initial switch ID belongs to port */
658         u16 pf_vf_num;
659         u8 port_state;
660 #define ICE_SCHED_PORT_STATE_INIT       0x0
661 #define ICE_SCHED_PORT_STATE_READY      0x1
662         u8 lport;
663 #define ICE_LPORT_MASK                  0xff
664         u16 dflt_tx_vsi_rule_id;
665         u16 dflt_tx_vsi_num;
666         u16 dflt_rx_vsi_rule_id;
667         u16 dflt_rx_vsi_num;
668         struct ice_fc_info fc;
669         struct ice_mac_info mac;
670         struct ice_phy_info phy;
671         struct ice_lock sched_lock;     /* protect access to TXSched tree */
672         struct ice_sched_node *
673                 sib_head[ICE_MAX_TRAFFIC_CLASS][ICE_AQC_TOPO_MAX_LEVEL_NUM];
674         /* List contain profile ID(s) and other params per layer */
675         struct LIST_HEAD_TYPE rl_prof_list[ICE_AQC_TOPO_MAX_LEVEL_NUM];
676         struct ice_dcbx_cfg local_dcbx_cfg;     /* Oper/Local Cfg */
677         /* DCBX info */
678         struct ice_dcbx_cfg remote_dcbx_cfg;    /* Peer Cfg */
679         struct ice_dcbx_cfg desired_dcbx_cfg;   /* CEE Desired Cfg */
680         /* LLDP/DCBX Status */
681         u8 dcbx_status:3;               /* see ICE_DCBX_STATUS_DIS */
682         u8 is_sw_lldp:1;
683         u8 is_vf:1;
684 };
685
686 struct ice_switch_info {
687         struct LIST_HEAD_TYPE vsi_list_map_head;
688         struct ice_sw_recipe *recp_list;
689 };
690
691 /* FW logging configuration */
692 struct ice_fw_log_evnt {
693         u8 cfg : 4;     /* New event enables to configure */
694         u8 cur : 4;     /* Current/active event enables */
695 };
696
697 struct ice_fw_log_cfg {
698         u8 cq_en : 1;    /* FW logging is enabled via the control queue */
699         u8 uart_en : 1;  /* FW logging is enabled via UART for all PFs */
700         u8 actv_evnts;   /* Cumulation of currently enabled log events */
701
702 #define ICE_FW_LOG_EVNT_INFO    (ICE_AQC_FW_LOG_INFO_EN >> ICE_AQC_FW_LOG_EN_S)
703 #define ICE_FW_LOG_EVNT_INIT    (ICE_AQC_FW_LOG_INIT_EN >> ICE_AQC_FW_LOG_EN_S)
704 #define ICE_FW_LOG_EVNT_FLOW    (ICE_AQC_FW_LOG_FLOW_EN >> ICE_AQC_FW_LOG_EN_S)
705 #define ICE_FW_LOG_EVNT_ERR     (ICE_AQC_FW_LOG_ERR_EN >> ICE_AQC_FW_LOG_EN_S)
706 #define ICE_FW_LOG_EVNT_ALL     (ICE_FW_LOG_EVNT_INFO | ICE_FW_LOG_EVNT_INIT | \
707                                  ICE_FW_LOG_EVNT_FLOW | ICE_FW_LOG_EVNT_ERR)
708         struct ice_fw_log_evnt evnts[ICE_AQC_FW_LOG_ID_MAX];
709 };
710
711 /* Port hardware description */
712 struct ice_hw {
713         u8 *hw_addr;
714         void *back;
715         struct ice_aqc_layer_props *layer_info;
716         struct ice_port_info *port_info;
717         /* 2D Array for each Tx Sched RL Profile type */
718         struct ice_sched_rl_profile **cir_profiles;
719         struct ice_sched_rl_profile **eir_profiles;
720         struct ice_sched_rl_profile **srl_profiles;
721         u64 debug_mask;         /* BITMAP for debug mask */
722         enum ice_mac_type mac_type;
723
724         u16 fd_ctr_base;        /* FD counter base index */
725         /* pci info */
726         u16 device_id;
727         u16 vendor_id;
728         u16 subsystem_device_id;
729         u16 subsystem_vendor_id;
730         u8 revision_id;
731
732         u8 pf_id;               /* device profile info */
733
734         u16 max_burst_size;     /* driver sets this value */
735
736         /* Tx Scheduler values */
737         u16 num_tx_sched_layers;
738         u16 num_tx_sched_phys_layers;
739         u8 flattened_layers;
740         u8 max_cgds;
741         u8 sw_entry_point_layer;
742         u16 max_children[ICE_AQC_TOPO_MAX_LEVEL_NUM];
743         struct LIST_HEAD_TYPE agg_list; /* lists all aggregator */
744         struct ice_bw_type_info tc_node_bw_t_info[ICE_MAX_TRAFFIC_CLASS];
745         struct ice_vsi_ctx *vsi_ctx[ICE_MAX_VSI];
746         u8 evb_veb;             /* true for VEB, false for VEPA */
747         u8 reset_ongoing;       /* true if HW is in reset, false otherwise */
748         struct ice_bus_info bus;
749         struct ice_nvm_info nvm;
750         struct ice_hw_dev_caps dev_caps;        /* device capabilities */
751         struct ice_hw_func_caps func_caps;      /* function capabilities */
752
753         struct ice_switch_info *switch_info;    /* switch filter lists */
754
755         /* Control Queue info */
756         struct ice_ctl_q_info adminq;
757         struct ice_ctl_q_info mailboxq;
758
759         u8 api_branch;          /* API branch version */
760         u8 api_maj_ver;         /* API major version */
761         u8 api_min_ver;         /* API minor version */
762         u8 api_patch;           /* API patch version */
763         u8 fw_branch;           /* firmware branch version */
764         u8 fw_maj_ver;          /* firmware major version */
765         u8 fw_min_ver;          /* firmware minor version */
766         u8 fw_patch;            /* firmware patch version */
767         u32 fw_build;           /* firmware build number */
768
769         struct ice_fw_log_cfg fw_log;
770
771 /* Device max aggregate bandwidths corresponding to the GL_PWR_MODE_CTL
772  * register. Used for determining the itr/intrl granularity during
773  * initialization.
774  */
775 #define ICE_MAX_AGG_BW_200G     0x0
776 #define ICE_MAX_AGG_BW_100G     0X1
777 #define ICE_MAX_AGG_BW_50G      0x2
778 #define ICE_MAX_AGG_BW_25G      0x3
779         /* ITR granularity for different speeds */
780 #define ICE_ITR_GRAN_ABOVE_25   2
781 #define ICE_ITR_GRAN_MAX_25     4
782         /* ITR granularity in 1 us */
783         u8 itr_gran;
784         /* INTRL granularity for different speeds */
785 #define ICE_INTRL_GRAN_ABOVE_25 4
786 #define ICE_INTRL_GRAN_MAX_25   8
787         /* INTRL granularity in 1 us */
788         u8 intrl_gran;
789
790         u8 ucast_shared;        /* true if VSIs can share unicast addr */
791
792         /* Active package version (currently active) */
793         struct ice_pkg_ver active_pkg_ver;
794         u8 active_pkg_name[ICE_PKG_NAME_SIZE];
795
796         /* Driver's package ver - (from the Metadata seg) */
797         struct ice_pkg_ver pkg_ver;
798         u8 pkg_name[ICE_PKG_NAME_SIZE];
799
800         /* Driver's Ice package version (from the Ice seg) */
801         struct ice_pkg_ver ice_pkg_ver;
802         u8 ice_pkg_name[ICE_PKG_NAME_SIZE];
803
804         /* Pointer to the ice segment */
805         struct ice_seg *seg;
806
807         /* Pointer to allocated copy of pkg memory */
808         u8 *pkg_copy;
809         u32 pkg_size;
810
811         /* tunneling info */
812         struct ice_tunnel_table tnl;
813
814 #define ICE_PKG_FILENAME        "package_file"
815 #define ICE_PKG_FILENAME_EXT    "pkg"
816 #define ICE_PKG_FILE_MAJ_VER    1
817 #define ICE_PKG_FILE_MIN_VER    0
818
819         /* HW block tables */
820         struct ice_blk_info blk[ICE_BLK_COUNT];
821         struct ice_lock fl_profs_locks[ICE_BLK_COUNT];  /* lock fltr profiles */
822         struct LIST_HEAD_TYPE fl_profs[ICE_BLK_COUNT];
823         /* Flow Director filter info */
824         int fdir_active_fltr;
825
826         struct ice_lock fdir_fltr_lock; /* protect Flow Director */
827         struct LIST_HEAD_TYPE fdir_list_head;
828
829         /* Book-keeping of side-band filter count per flow-type.
830          * This is used to detect and handle input set changes for
831          * respective flow-type.
832          */
833         u16 fdir_fltr_cnt[ICE_FLTR_PTYPE_MAX];
834
835         struct ice_fd_hw_prof **fdir_prof;
836         ice_declare_bitmap(fdir_perfect_fltr, ICE_FLTR_PTYPE_MAX);
837         struct ice_lock rss_locks;      /* protect RSS configuration */
838         struct LIST_HEAD_TYPE rss_list_head;
839 };
840
841 /* Statistics collected by each port, VSI, VEB, and S-channel */
842 struct ice_eth_stats {
843         u64 rx_bytes;                   /* gorc */
844         u64 rx_unicast;                 /* uprc */
845         u64 rx_multicast;               /* mprc */
846         u64 rx_broadcast;               /* bprc */
847         u64 rx_discards;                /* rdpc */
848         u64 rx_unknown_protocol;        /* rupp */
849         u64 tx_bytes;                   /* gotc */
850         u64 tx_unicast;                 /* uptc */
851         u64 tx_multicast;               /* mptc */
852         u64 tx_broadcast;               /* bptc */
853         u64 tx_discards;                /* tdpc */
854         u64 tx_errors;                  /* tepc */
855 };
856
857 #define ICE_MAX_UP      8
858
859 /* Statistics collected per VEB per User Priority (UP) for up to 8 UPs */
860 struct ice_veb_up_stats {
861         u64 up_rx_pkts[ICE_MAX_UP];
862         u64 up_rx_bytes[ICE_MAX_UP];
863         u64 up_tx_pkts[ICE_MAX_UP];
864         u64 up_tx_bytes[ICE_MAX_UP];
865 };
866
867 /* Statistics collected by the MAC */
868 struct ice_hw_port_stats {
869         /* eth stats collected by the port */
870         struct ice_eth_stats eth;
871         /* additional port specific stats */
872         u64 tx_dropped_link_down;       /* tdold */
873         u64 crc_errors;                 /* crcerrs */
874         u64 illegal_bytes;              /* illerrc */
875         u64 error_bytes;                /* errbc */
876         u64 mac_local_faults;           /* mlfc */
877         u64 mac_remote_faults;          /* mrfc */
878         u64 rx_len_errors;              /* rlec */
879         u64 link_xon_rx;                /* lxonrxc */
880         u64 link_xoff_rx;               /* lxoffrxc */
881         u64 link_xon_tx;                /* lxontxc */
882         u64 link_xoff_tx;               /* lxofftxc */
883         u64 priority_xon_rx[8];         /* pxonrxc[8] */
884         u64 priority_xoff_rx[8];        /* pxoffrxc[8] */
885         u64 priority_xon_tx[8];         /* pxontxc[8] */
886         u64 priority_xoff_tx[8];        /* pxofftxc[8] */
887         u64 priority_xon_2_xoff[8];     /* pxon2offc[8] */
888         u64 rx_size_64;                 /* prc64 */
889         u64 rx_size_127;                /* prc127 */
890         u64 rx_size_255;                /* prc255 */
891         u64 rx_size_511;                /* prc511 */
892         u64 rx_size_1023;               /* prc1023 */
893         u64 rx_size_1522;               /* prc1522 */
894         u64 rx_size_big;                /* prc9522 */
895         u64 rx_undersize;               /* ruc */
896         u64 rx_fragments;               /* rfc */
897         u64 rx_oversize;                /* roc */
898         u64 rx_jabber;                  /* rjc */
899         u64 tx_size_64;                 /* ptc64 */
900         u64 tx_size_127;                /* ptc127 */
901         u64 tx_size_255;                /* ptc255 */
902         u64 tx_size_511;                /* ptc511 */
903         u64 tx_size_1023;               /* ptc1023 */
904         u64 tx_size_1522;               /* ptc1522 */
905         u64 tx_size_big;                /* ptc9522 */
906         u64 mac_short_pkt_dropped;      /* mspdc */
907         /* flow director stats */
908         u32 fd_sb_status;
909         u64 fd_sb_match;
910 };
911
912 enum ice_sw_fwd_act_type {
913         ICE_FWD_TO_VSI = 0,
914         ICE_FWD_TO_VSI_LIST, /* Do not use this when adding filter */
915         ICE_FWD_TO_Q,
916         ICE_FWD_TO_QGRP,
917         ICE_DROP_PACKET,
918         ICE_INVAL_ACT
919 };
920
921 /* Checksum and Shadow RAM pointers */
922 #define ICE_SR_NVM_CTRL_WORD                    0x00
923 #define ICE_SR_PHY_ANALOG_PTR                   0x04
924 #define ICE_SR_OPTION_ROM_PTR                   0x05
925 #define ICE_SR_RO_PCIR_REGS_AUTO_LOAD_PTR       0x06
926 #define ICE_SR_AUTO_GENERATED_POINTERS_PTR      0x07
927 #define ICE_SR_PCIR_REGS_AUTO_LOAD_PTR          0x08
928 #define ICE_SR_EMP_GLOBAL_MODULE_PTR            0x09
929 #define ICE_SR_EMP_IMAGE_PTR                    0x0B
930 #define ICE_SR_PE_IMAGE_PTR                     0x0C
931 #define ICE_SR_CSR_PROTECTED_LIST_PTR           0x0D
932 #define ICE_SR_MNG_CFG_PTR                      0x0E
933 #define ICE_SR_EMP_MODULE_PTR                   0x0F
934 #define ICE_SR_PBA_BLOCK_PTR                    0x16
935 #define ICE_SR_BOOT_CFG_PTR                     0x17
936 #define ICE_SR_NVM_WOL_CFG                      0x19
937 #define ICE_NVM_OEM_VER_OFF                     0x83
938 #define ICE_SR_NVM_DEV_STARTER_VER              0x18
939 #define ICE_SR_ALTERNATE_SAN_MAC_ADDR_PTR       0x27
940 #define ICE_SR_PERMANENT_SAN_MAC_ADDR_PTR       0x28
941 #define ICE_SR_NVM_MAP_VER                      0x29
942 #define ICE_SR_NVM_IMAGE_VER                    0x2A
943 #define ICE_SR_NVM_STRUCTURE_VER                0x2B
944 #define ICE_SR_NVM_EETRACK_LO                   0x2D
945 #define ICE_SR_NVM_EETRACK_HI                   0x2E
946 #define ICE_NVM_VER_LO_SHIFT                    0
947 #define ICE_NVM_VER_LO_MASK                     (0xff << ICE_NVM_VER_LO_SHIFT)
948 #define ICE_NVM_VER_HI_SHIFT                    12
949 #define ICE_NVM_VER_HI_MASK                     (0xf << ICE_NVM_VER_HI_SHIFT)
950 #define ICE_OEM_EETRACK_ID                      0xffffffff
951 #define ICE_OEM_VER_PATCH_SHIFT                 0
952 #define ICE_OEM_VER_PATCH_MASK          (0xff << ICE_OEM_VER_PATCH_SHIFT)
953 #define ICE_OEM_VER_BUILD_SHIFT                 8
954 #define ICE_OEM_VER_BUILD_MASK          (0xffff << ICE_OEM_VER_BUILD_SHIFT)
955 #define ICE_OEM_VER_SHIFT                       24
956 #define ICE_OEM_VER_MASK                        (0xff << ICE_OEM_VER_SHIFT)
957 #define ICE_SR_VPD_PTR                          0x2F
958 #define ICE_SR_PXE_SETUP_PTR                    0x30
959 #define ICE_SR_PXE_CFG_CUST_OPTIONS_PTR         0x31
960 #define ICE_SR_NVM_ORIGINAL_EETRACK_LO          0x34
961 #define ICE_SR_NVM_ORIGINAL_EETRACK_HI          0x35
962 #define ICE_SR_VLAN_CFG_PTR                     0x37
963 #define ICE_SR_POR_REGS_AUTO_LOAD_PTR           0x38
964 #define ICE_SR_EMPR_REGS_AUTO_LOAD_PTR          0x3A
965 #define ICE_SR_GLOBR_REGS_AUTO_LOAD_PTR         0x3B
966 #define ICE_SR_CORER_REGS_AUTO_LOAD_PTR         0x3C
967 #define ICE_SR_PHY_CFG_SCRIPT_PTR               0x3D
968 #define ICE_SR_PCIE_ALT_AUTO_LOAD_PTR           0x3E
969 #define ICE_SR_SW_CHECKSUM_WORD                 0x3F
970 #define ICE_SR_PFA_PTR                          0x40
971 #define ICE_SR_1ST_SCRATCH_PAD_PTR              0x41
972 #define ICE_SR_1ST_NVM_BANK_PTR                 0x42
973 #define ICE_SR_NVM_BANK_SIZE                    0x43
974 #define ICE_SR_1ND_OROM_BANK_PTR                0x44
975 #define ICE_SR_OROM_BANK_SIZE                   0x45
976 #define ICE_SR_NETLIST_BANK_PTR                 0x46
977 #define ICE_SR_NETLIST_BANK_SIZE                0x47
978 #define ICE_SR_EMP_SR_SETTINGS_PTR              0x48
979 #define ICE_SR_CONFIGURATION_METADATA_PTR       0x4D
980 #define ICE_SR_IMMEDIATE_VALUES_PTR             0x4E
981 #define ICE_SR_POR_REGISTERS_AUTOLOAD_PTR       0x118
982
983 /* Auxiliary field, mask and shift definition for Shadow RAM and NVM Flash */
984 #define ICE_SR_VPD_SIZE_WORDS           512
985 #define ICE_SR_PCIE_ALT_SIZE_WORDS      512
986 #define ICE_SR_CTRL_WORD_1_S            0x06
987 #define ICE_SR_CTRL_WORD_1_M            (0x03 << ICE_SR_CTRL_WORD_1_S)
988
989 /* Shadow RAM related */
990 #define ICE_SR_SECTOR_SIZE_IN_WORDS     0x800
991 #define ICE_SR_BUF_ALIGNMENT            4096
992 #define ICE_SR_WORDS_IN_1KB             512
993 /* Checksum should be calculated such that after adding all the words,
994  * including the checksum word itself, the sum should be 0xBABA.
995  */
996 #define ICE_SR_SW_CHECKSUM_BASE         0xBABA
997
998 #define ICE_PBA_FLAG_DFLT               0xFAFA
999 /* Hash redirection LUT for VSI - maximum array size */
1000 #define ICE_VSIQF_HLUT_ARRAY_SIZE       ((VSIQF_HLUT_MAX_INDEX + 1) * 4)
1001
1002 /*
1003  * Defines for values in the VF_PE_DB_SIZE bits in the GLPCI_LBARCTRL register.
1004  * This is needed to determine the BAR0 space for the VFs
1005  */
1006 #define GLPCI_LBARCTRL_VF_PE_DB_SIZE_0KB 0x0
1007 #define GLPCI_LBARCTRL_VF_PE_DB_SIZE_8KB 0x1
1008 #define GLPCI_LBARCTRL_VF_PE_DB_SIZE_64KB 0x2
1009
1010 #endif /* _ICE_TYPE_H_ */