Bit ops
[akaros.git] / kern / drivers / net / bxe / ecore_sp.h
1 /*-
2  * Copyright (c) 2007-2014 QLogic Corporation. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS'
15  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
18  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
20  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
21  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
22  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
23  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
24  * THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27
28 //__FBSDID("$FreeBSD: head/sys/dev/bxe/ecore_sp.h 271728 2014-09-17 22:49:29Z davidcs $");
29
30 #ifndef ECORE_SP_H
31 #define ECORE_SP_H
32
33 #if _BYTE_ORDER == _LITTLE_ENDIAN
34 #ifndef LITTLE_ENDIAN
35 #define LITTLE_ENDIAN
36 #endif
37 #ifndef __LITTLE_ENDIAN
38 #define __LITTLE_ENDIAN
39 #endif
40 #undef BIG_ENDIAN
41 #undef __BIG_ENDIAN
42 #else /* _BIG_ENDIAN */
43 #ifndef BIG_ENDIAN
44 #define BIG_ENDIAN
45 #endif
46 #ifndef __BIG_ENDIAN
47 #define __BIG_ENDIAN
48 #endif
49 #undef LITTLE_ENDIAN
50 #undef __LITTLE_ENDIAN
51 #endif
52
53 #include "ecore_mfw_req.h"
54 #include "ecore_fw_defs.h"
55 #include "ecore_hsi.h"
56 #include "ecore_reg.h"
57 #include <time.h>       /* udelay */
58
59 struct bxe_adapter;
60 typedef bus_addr_t ecore_dma_addr_t; /* expected to be 64 bit wide */
61 typedef volatile int ecore_atomic_t;
62
63 #ifndef __bool_true_false_are_defined
64 #ifndef __cplusplus
65 #define bool _Bool
66 #if __STDC_VERSION__ < 199901L && __GNUC__ < 3 && !defined(__INTEL_COMPILER)
67 typedef _Bool bool;
68 #endif
69 #endif /* !__cplusplus */
70 #endif /* !__bool_true_false_are_defined$ */
71
72 #define ETH_ALEN 6
73
74 #define ECORE_SWCID_SHIFT   17
75 #define ECORE_SWCID_MASK    ((0x1 << ECORE_SWCID_SHIFT) - 1)
76
77 #define ECORE_MC_HASH_SIZE 8
78 #define ECORE_MC_HASH_OFFSET(sc, i)                                          \
79     (BAR_TSTRORM_INTMEM +                                                    \
80      TSTORM_APPROXIMATE_MATCH_MULTICAST_FILTERING_OFFSET(FUNC_ID(sc)) + i*4)
81
82 #define ECORE_MAX_MULTICAST   64
83 #define ECORE_MAX_EMUL_MULTI  1
84
85 #define IRO sc->iro_array
86
87 //typedef struct mtx ECORE_MUTEX;
88 #define ECORE_MUTEX_INIT(_mutex) 
89 //                                                              \
90 //    mtx_init(_mutex, "ecore_lock", "ECORE Lock", MTX_DEF)
91 #define ECORE_MUTEX_LOCK(_mutex)   mtx_lock(_mutex)
92 #define ECORE_MUTEX_UNLOCK(_mutex) mtx_unlock(_mutex)
93
94 //typedef struct mtx ECORE_MUTEX_SPIN;
95 #define ECORE_SPIN_LOCK_INIT(_spin, _sc)
96 //                                                              \
97 //    mtx_init(_spin, "ecore_lock", "ECORE Lock", MTX_DEF)
98 #define ECORE_SPIN_LOCK_BH(_spin)   mtx_lock(_spin) /* bh = bottom-half */
99 #define ECORE_SPIN_UNLOCK_BH(_spin) mtx_unlock(_spin) /* bh = bottom-half */
100
101 #define ECORE_SMP_MB_AFTER_CLEAR_BIT()  mb()
102 #define ECORE_SMP_MB_BEFORE_CLEAR_BIT() mb()
103 #define ECORE_SMP_MB()                  mb()
104 #define ECORE_SMP_RMB()                 rmb()
105 #define ECORE_SMP_WMB()                 wmb()
106 #define ECORE_MMIOWB()                  wmb()
107
108 #define ECORE_SET_BIT_NA(bit, var)   __set_bit(bit, var) /* non-atomic */
109 #define ECORE_CLEAR_BIT_NA(bit, var) __clear_bit(bit, var) /* non-atomic */
110 #define ECORE_TEST_BIT(bit, var)     test_bit(bit, var)
111 #define ECORE_SET_BIT(bit, var)      set_bit(bit, var)
112 #define ECORE_CLEAR_BIT(bit, var)    clear_bit(bit, var)
113 #define ECORE_TEST_AND_CLEAR_BIT(bit, var) test_and_clear_bit(bit, var)
114
115 #define ECORE_ATOMIC_READ(a) atomic_load_acq_int((volatile int *)a)
116 #define ECORE_ATOMIC_SET(a, v) atomic_store_rel_int((volatile int *)a, v)
117 #define ECORE_ATOMIC_CMPXCHG(a, o, n) bxe_cmpxchg((volatile int *)a, o, n)
118
119 #define ECORE_RET_PENDING(pending_bit, pending) \
120     (ECORE_TEST_BIT(pending_bit, pending) ? ECORE_PENDING : ECORE_SUCCESS)
121
122 #define ECORE_SET_FLAG(value, mask, flag)      \
123     do {                                       \
124         (value) &= ~(mask);                    \
125         (value) |= ((flag) << (mask##_SHIFT)); \
126     } while (0)
127
128 #define ECORE_GET_FLAG(value, mask) \
129     (((value) &= (mask)) >> (mask##_SHIFT))
130
131 #define ECORE_MIGHT_SLEEP()
132
133 #define ECORE_FCOE_CID(sc) ((sc)->fp[FCOE_IDX(sc)].cl_id)
134
135 #define ECORE_MEMCMP(_a, _b, _s) memcmp(_a, _b, _s)
136 #define ECORE_MEMCPY(_a, _b, _s) memcpy(_a, _b, _s)
137 #define ECORE_MEMSET(_a, _c, _s) memset(_a, _c, _s)
138
139 #define ECORE_CPU_TO_LE16(x) htole16(x)
140 #define ECORE_CPU_TO_LE32(x) htole32(x)
141
142 #define ECORE_WAIT(_s, _t) udelay(1000)
143 #define ECORE_MSLEEP(_t)   udelay((_t) * 1000)
144
145 #define ECORE_LIKELY(x)   (x)
146 #define ECORE_UNLIKELY(x) (x)
147
148 #define ECORE_ZALLOC(_size, _flags, _sc) \
149         kzmalloc(_size, KMALLOC_WAIT) /*M_TEMP, (M_NOWAIT | M_ZERO))*/
150
151 #define ECORE_CALLOC(_len, _size, _flags, _sc) \
152     kzmalloc(_len * _size, KMALLOC_WAIT) /*M_TEMP, (M_NOWAIT | M_ZERO))*/
153
154 #define ECORE_FREE(_s, _buf, _size) kfree(_buf); /*, M_TEMP)*/
155
156 #define SC_ILT(sc)  ((sc)->ilt)
157 #define ILOG2(x)    bxe_ilog2(x)
158 #if 0
159
160 #define ECORE_ILT_ZALLOC(x, y, size)                                       \
161     do {                                                                   \
162         x = malloc(sizeof(struct bxe_dma), M_DEVBUF, (M_NOWAIT | M_ZERO)); \
163         if (x) {                                                           \
164             if (bxe_dma_alloc((struct bxe_adapter *)sc,                      \
165                               size, (struct bxe_dma *)x,                   \
166                               "ECORE_ILT") != 0) {                         \
167                 free(x, M_DEVBUF);                                         \
168                 x = NULL;                                                  \
169                 *y = 0;                                                    \
170             } else {                                                       \
171                 *y = ((struct bxe_dma *)x)->paddr;                         \
172             }                                                              \
173         }                                                                  \
174     } while (0)
175
176 #define ECORE_ILT_FREE(x, y, size)                   \
177     do {                                             \
178         if (x) {                                     \
179             bxe_dma_free((struct bxe_adapter *)sc, x); \
180             free(x, M_DEVBUF);                       \
181             x = NULL;                                \
182             y = 0;                                   \
183         }                                            \
184     } while (0)
185 #endif
186 #define ECORE_IS_VALID_ETHER_ADDR(_mac) TRUE
187
188 #define ECORE_IS_MF_SD_MODE   IS_MF_SD_MODE
189 #define ECORE_IS_MF_SI_MODE   IS_MF_SI_MODE
190 #define ECORE_IS_MF_AFEX_MODE IS_MF_AFEX_MODE
191
192 #define ECORE_SET_CTX_VALIDATION bxe_set_ctx_validation
193
194 #define ECORE_UPDATE_COALESCE_SB_INDEX bxe_update_coalesce_sb_index
195
196 #define ECORE_ALIGN(x, a) ((((x) + (a) - 1) / (a)) * (a))
197
198 #define ECORE_REG_WR_DMAE_LEN REG_WR_DMAE_LEN
199
200 #define ECORE_PATH_ID     SC_PATH
201 #define ECORE_PORT_ID     SC_PORT
202 #define ECORE_FUNC_ID     SC_FUNC
203 #define ECORE_ABS_FUNC_ID SC_ABS_FUNC
204
205 uint32_t calc_crc32(uint8_t *crc32_packet, uint32_t crc32_length,
206                     uint32_t crc32_seed, uint8_t complement);
207 #warning "no bswap32"
208 static inline uint32_t
209 ECORE_CRC32_LE(uint32_t seed, uint8_t *mac, uint32_t len)
210 {
211     uint32_t packet_buf[2] = {0};
212     memcpy(((uint8_t *)(&packet_buf[0]))+2, &mac[0], 2);
213     memcpy(&packet_buf[1], &mac[2], 4);
214     return 0; //bswap32(calc_crc32((uint8_t *)packet_buf, 8, seed, 0));
215 }
216
217 #define ecore_sp_post(_sc, _a, _b, _c, _d) \
218     bxe_sp_post(_sc, _a, _b, U64_HI(_c), U64_LO(_c), _d)
219
220 #ifdef ECORE_STOP_ON_ERROR
221
222 #define ECORE_DBG_BREAK_IF(exp)     \
223     do {                            \
224         if (__predict_false(exp)) { \
225             panic("ECORE");         \
226         }                           \
227     } while (0)
228
229 #define ECORE_BUG()                               \
230     do {                                          \
231         panic("BUG (%s:%d)", __FILE__, __LINE__); \
232     } while(0);
233
234 #define ECORE_BUG_ON(exp)                                \
235     do {                                                 \
236         if (__predict_true(exp)) {                       \
237             panic("BUG_ON (%s:%d)", __FILE__, __LINE__); \
238         }                                                \
239     } while (0)
240
241 #else
242
243 extern unsigned long bxe_debug;
244
245 #define BXE_DEBUG_ECORE_DBG_BREAK_IF   0x01
246 #define BXE_DEBUG_ECORE_BUG            0x02
247 #define BXE_DEBUG_ECORE_BUG_ON         0x04
248
249 #define ECORE_DBG_BREAK_IF(exp)     \
250     if (bxe_debug & BXE_DEBUG_ECORE_DBG_BREAK_IF) \
251         printk("%s (%s,%d)\n", __FUNCTION__, __FILE__, __LINE__);
252
253 #define ECORE_BUG(exp)     \
254     if (bxe_debug & BXE_DEBUG_ECORE_BUG) \
255         printk("%s (%s,%d)\n", __FUNCTION__, __FILE__, __LINE__);
256
257 #define ECORE_BUG_ON(exp)     \
258     if (bxe_debug & BXE_DEBUG_ECORE_BUG_ON) \
259         printk("%s (%s,%d)\n", __FUNCTION__, __FILE__, __LINE__);
260
261
262 #endif /* #ifdef ECORE_STOP_ON_ERROR */
263
264 #define ECORE_ERR(str, ...) \
265     BLOGE(sc, "ECORE: " str, ##__VA_ARGS__)
266
267 #define DBG_SP 0x00000004 /* defined in bxe.h */
268
269 #define ECORE_MSG(sc, m, ...) \
270     BLOGD(sc, DBG_SP, "ECORE: " m, ##__VA_ARGS__)
271
272 typedef struct _ecore_list_entry_t
273 {
274     struct _ecore_list_entry_t *next, *prev;
275 } ecore_list_entry_t;
276
277 typedef struct ecore_list_t
278 {
279     ecore_list_entry_t *head, *tail;
280     unsigned long cnt;
281 } ecore_list_t;
282
283 /* initialize the list */
284 #define ECORE_LIST_INIT(_list) \
285     do {                       \
286         (_list)->head = NULL;  \
287         (_list)->tail = NULL;  \
288         (_list)->cnt  = 0;     \
289     } while (0)
290
291 /* return TRUE if the element is the last on the list */
292 #define ECORE_LIST_IS_LAST(_elem, _list) \
293     (_elem == (_list)->tail)
294
295 /* return TRUE if the list is empty */
296 #define ECORE_LIST_IS_EMPTY(_list) \
297     ((_list)->cnt == 0)
298
299 /* return the first element */
300 #define ECORE_LIST_FIRST_ENTRY(_list, cast, _link) \
301     (cast *)((_list)->head)
302
303 /* return the next element */
304 #define ECORE_LIST_NEXT(_elem, _link, cast) \
305     (cast *)((&((_elem)->_link))->next)
306
307 /* push an element on the head of the list */
308 #define ECORE_LIST_PUSH_HEAD(_elem, _list)              \
309     do {                                                \
310         (_elem)->prev = (ecore_list_entry_t *)0;        \
311         (_elem)->next = (_list)->head;                  \
312         if ((_list)->tail == (ecore_list_entry_t *)0) { \
313             (_list)->tail = (_elem);                    \
314         } else {                                        \
315             (_list)->head->prev = (_elem);              \
316         }                                               \
317         (_list)->head = (_elem);                        \
318         (_list)->cnt++;                                 \
319     } while (0)
320
321 /* push an element on the tail of the list */
322 #define ECORE_LIST_PUSH_TAIL(_elem, _list)       \
323     do {                                         \
324         (_elem)->next = (ecore_list_entry_t *)0; \
325         (_elem)->prev = (_list)->tail;           \
326         if ((_list)->tail) {                     \
327             (_list)->tail->next = (_elem);       \
328         } else {                                 \
329             (_list)->head = (_elem);             \
330         }                                        \
331         (_list)->tail = (_elem);                 \
332         (_list)->cnt++;                          \
333     } while (0)
334
335 /* push list1 on the head of list2 and return with list1 as empty */
336 #define ECORE_LIST_SPLICE_INIT(_list1, _list2)     \
337     do {                                           \
338         (_list1)->tail->next = (_list2)->head;     \
339         if ((_list2)->head) {                      \
340             (_list2)->head->prev = (_list1)->tail; \
341         } else {                                   \
342             (_list2)->tail = (_list1)->tail;       \
343         }                                          \
344         (_list2)->head = (_list1)->head;           \
345         (_list2)->cnt += (_list1)->cnt;            \
346         (_list1)->head = NULL;                     \
347         (_list1)->tail = NULL;                     \
348         (_list1)->cnt  = 0;                        \
349     } while (0)
350
351 /* remove an element from the list */
352 #define ECORE_LIST_REMOVE_ENTRY(_elem, _list)                      \
353     do {                                                           \
354         if ((_list)->head == (_elem)) {                            \
355             if ((_list)->head) {                                   \
356                 (_list)->head = (_list)->head->next;               \
357                 if ((_list)->head) {                               \
358                     (_list)->head->prev = (ecore_list_entry_t *)0; \
359                 } else {                                           \
360                     (_list)->tail = (ecore_list_entry_t *)0;       \
361                 }                                                  \
362                 (_list)->cnt--;                                    \
363             }                                                      \
364         } else if ((_list)->tail == (_elem)) {                     \
365             if ((_list)->tail) {                                   \
366                 (_list)->tail = (_list)->tail->prev;               \
367                 if ((_list)->tail) {                               \
368                     (_list)->tail->next = (ecore_list_entry_t *)0; \
369                 } else {                                           \
370                     (_list)->head = (ecore_list_entry_t *)0;       \
371                 }                                                  \
372                 (_list)->cnt--;                                    \
373             }                                                      \
374         } else {                                                   \
375             (_elem)->prev->next = (_elem)->next;                   \
376             (_elem)->next->prev = (_elem)->prev;                   \
377             (_list)->cnt--;                                        \
378         }                                                          \
379     } while (0)
380
381 /* walk the list */
382 #define ECORE_LIST_FOR_EACH_ENTRY(pos, _list, _link, cast) \
383     for (pos = ECORE_LIST_FIRST_ENTRY(_list, cast, _link); \
384          pos;                                              \
385          pos = ECORE_LIST_NEXT(pos, _link, cast))
386
387 /* walk the list (safely) */
388 #define ECORE_LIST_FOR_EACH_ENTRY_SAFE(pos, n, _list, _link, cast) \
389      for (pos = ECORE_LIST_FIRST_ENTRY(_list, cast, _lint),        \
390           n = (pos) ? ECORE_LIST_NEXT(pos, _link, cast) : NULL;    \
391           pos != NULL;                                             \
392           pos = (cast *)n,                                         \
393           n = (pos) ? ECORE_LIST_NEXT(pos, _link, cast) : NULL)
394
395
396 /* Manipulate a bit vector defined as an array of uint64_t */
397
398 /* Number of bits in one sge_mask array element */
399 #define BIT_VEC64_ELEM_SZ     64
400 #define BIT_VEC64_ELEM_SHIFT  6
401 #define BIT_VEC64_ELEM_MASK   ((uint64_t)BIT_VEC64_ELEM_SZ - 1)
402
403 #define __BIT_VEC64_SET_BIT(el, bit)            \
404     do {                                        \
405         el = ((el) | ((uint64_t)0x1 << (bit))); \
406     } while (0)
407
408 #define __BIT_VEC64_CLEAR_BIT(el, bit)             \
409     do {                                           \
410         el = ((el) & (~((uint64_t)0x1 << (bit)))); \
411     } while (0)
412
413 #define BIT_VEC64_SET_BIT(vec64, idx)                           \
414     __BIT_VEC64_SET_BIT((vec64)[(idx) >> BIT_VEC64_ELEM_SHIFT], \
415                         (idx) & BIT_VEC64_ELEM_MASK)
416
417 #define BIT_VEC64_CLEAR_BIT(vec64, idx)                           \
418     __BIT_VEC64_CLEAR_BIT((vec64)[(idx) >> BIT_VEC64_ELEM_SHIFT], \
419                           (idx) & BIT_VEC64_ELEM_MASK)
420
421 #define BIT_VEC64_TEST_BIT(vec64, idx)          \
422     (((vec64)[(idx) >> BIT_VEC64_ELEM_SHIFT] >> \
423       ((idx) & BIT_VEC64_ELEM_MASK)) & 0x1)
424
425 /*
426  * Creates a bitmask of all ones in less significant bits.
427  * idx - index of the most significant bit in the created mask
428  */
429 #define BIT_VEC64_ONES_MASK(idx)                                 \
430     (((uint64_t)0x1 << (((idx) & BIT_VEC64_ELEM_MASK) + 1)) - 1)
431 #define BIT_VEC64_ELEM_ONE_MASK ((uint64_t)(~0))
432
433 /* fill in a MAC address the way the FW likes it */
434 static inline void
435 ecore_set_fw_mac_addr(uint16_t *fw_hi,
436                       uint16_t *fw_mid,
437                       uint16_t *fw_lo,
438                       uint8_t  *mac)
439 {
440     ((uint8_t *)fw_hi)[0]  = mac[1];
441     ((uint8_t *)fw_hi)[1]  = mac[0];
442     ((uint8_t *)fw_mid)[0] = mac[3];
443     ((uint8_t *)fw_mid)[1] = mac[2];
444     ((uint8_t *)fw_lo)[0]  = mac[5];
445     ((uint8_t *)fw_lo)[1]  = mac[4];
446 }
447
448
449 enum ecore_status_t {
450     ECORE_EXISTS  = -6,
451     ECORE_IO      = -5,
452     ECORE_TIMEOUT = -4,
453     ECORE_INVAL   = -3,
454     ECORE_BUSY    = -2,
455     ECORE_NOMEM   = -1,
456     ECORE_SUCCESS = 0,
457     /* PENDING is not an error and should be positive */
458     ECORE_PENDING = 1,
459 };
460
461 enum {
462     SWITCH_UPDATE,
463     AFEX_UPDATE,
464 };
465
466
467
468
469 struct bxe_adapter;
470 struct eth_context;
471
472 /* Bits representing general command's configuration */
473 enum {
474         RAMROD_TX,
475         RAMROD_RX,
476         /* Wait until all pending commands complete */
477         RAMROD_COMP_WAIT,
478         /* Don't send a ramrod, only update a registry */
479         RAMROD_DRV_CLR_ONLY,
480         /* Configure HW according to the current object state */
481         RAMROD_RESTORE,
482          /* Execute the next command now */
483         RAMROD_EXEC,
484         /* Don't add a new command and continue execution of posponed
485          * commands. If not set a new command will be added to the
486          * pending commands list.
487          */
488         RAMROD_CONT,
489         /* If there is another pending ramrod, wait until it finishes and
490          * re-try to submit this one. This flag can be set only in sleepable
491          * context, and should not be set from the context that completes the
492          * ramrods as deadlock will occur.
493          */
494         RAMROD_RETRY,
495 };
496
497 typedef enum {
498         ECORE_OBJ_TYPE_RX,
499         ECORE_OBJ_TYPE_TX,
500         ECORE_OBJ_TYPE_RX_TX,
501 } ecore_obj_type;
502
503 /* Public slow path states */
504 enum {
505         ECORE_FILTER_MAC_PENDING,
506         ECORE_FILTER_VLAN_PENDING,
507         ECORE_FILTER_VLAN_MAC_PENDING,
508         ECORE_FILTER_RX_MODE_PENDING,
509         ECORE_FILTER_RX_MODE_SCHED,
510         ECORE_FILTER_ISCSI_ETH_START_SCHED,
511         ECORE_FILTER_ISCSI_ETH_STOP_SCHED,
512         ECORE_FILTER_FCOE_ETH_START_SCHED,
513         ECORE_FILTER_FCOE_ETH_STOP_SCHED,
514         ECORE_FILTER_BYPASS_RX_MODE_PENDING,
515         ECORE_FILTER_BYPASS_MAC_PENDING,
516         ECORE_FILTER_BYPASS_RSS_CONF_PENDING,
517         ECORE_FILTER_MCAST_PENDING,
518         ECORE_FILTER_MCAST_SCHED,
519         ECORE_FILTER_RSS_CONF_PENDING,
520         ECORE_AFEX_FCOE_Q_UPDATE_PENDING,
521         ECORE_AFEX_PENDING_VIFSET_MCP_ACK
522 };
523
524 struct ecore_raw_obj {
525         uint8_t         func_id;
526
527         /* Queue params */
528         uint8_t         cl_id;
529         uint32_t                cid;
530
531         /* Ramrod data buffer params */
532         void            *rdata;
533         ecore_dma_addr_t        rdata_mapping;
534
535         /* Ramrod state params */
536         int             state;   /* "ramrod is pending" state bit */
537         unsigned long   *pstate; /* pointer to state buffer */
538
539         ecore_obj_type  obj_type;
540
541         int (*wait_comp)(struct bxe_adapter *sc,
542                          struct ecore_raw_obj *o);
543
544         bool (*check_pending)(struct ecore_raw_obj *o);
545         void (*clear_pending)(struct ecore_raw_obj *o);
546         void (*set_pending)(struct ecore_raw_obj *o);
547 };
548
549 /************************* VLAN-MAC commands related parameters ***************/
550 struct ecore_mac_ramrod_data {
551         uint8_t mac[ETH_ALEN];
552         uint8_t is_inner_mac;
553 };
554
555 struct ecore_vlan_ramrod_data {
556         uint16_t vlan;
557 };
558
559 struct ecore_vlan_mac_ramrod_data {
560         uint8_t mac[ETH_ALEN];
561         uint8_t is_inner_mac;
562         uint16_t vlan;
563 };
564
565 union ecore_classification_ramrod_data {
566         struct ecore_mac_ramrod_data mac;
567         struct ecore_vlan_ramrod_data vlan;
568         struct ecore_vlan_mac_ramrod_data vlan_mac;
569 };
570
571 /* VLAN_MAC commands */
572 enum ecore_vlan_mac_cmd {
573         ECORE_VLAN_MAC_ADD,
574         ECORE_VLAN_MAC_DEL,
575         ECORE_VLAN_MAC_MOVE,
576 };
577
578 struct ecore_vlan_mac_data {
579         /* Requested command: ECORE_VLAN_MAC_XX */
580         enum ecore_vlan_mac_cmd cmd;
581         /* used to contain the data related vlan_mac_flags bits from
582          * ramrod parameters.
583          */
584         unsigned long vlan_mac_flags;
585
586         /* Needed for MOVE command */
587         struct ecore_vlan_mac_obj *target_obj;
588
589         union ecore_classification_ramrod_data u;
590 };
591
592 /*************************** Exe Queue obj ************************************/
593 union ecore_exe_queue_cmd_data {
594         struct ecore_vlan_mac_data vlan_mac;
595
596         struct {
597                 /* TODO */
598         } mcast;
599 };
600
601 struct ecore_exeq_elem {
602         ecore_list_entry_t              link;
603
604         /* Length of this element in the exe_chunk. */
605         int                             cmd_len;
606
607         union ecore_exe_queue_cmd_data  cmd_data;
608 };
609
610 union ecore_qable_obj;
611
612 union ecore_exeq_comp_elem {
613         union event_ring_elem *elem;
614 };
615
616 struct ecore_exe_queue_obj;
617
618 typedef int (*exe_q_validate)(struct bxe_adapter *sc,
619                               union ecore_qable_obj *o,
620                               struct ecore_exeq_elem *elem);
621
622 typedef int (*exe_q_remove)(struct bxe_adapter *sc,
623                             union ecore_qable_obj *o,
624                             struct ecore_exeq_elem *elem);
625
626 /* Return positive if entry was optimized, 0 - if not, negative
627  * in case of an error.
628  */
629 typedef int (*exe_q_optimize)(struct bxe_adapter *sc,
630                               union ecore_qable_obj *o,
631                               struct ecore_exeq_elem *elem);
632 typedef int (*exe_q_execute)(struct bxe_adapter *sc,
633                              union ecore_qable_obj *o,
634                              ecore_list_t *exe_chunk,
635                              unsigned long *ramrod_flags);
636 typedef struct ecore_exeq_elem *
637                         (*exe_q_get)(struct ecore_exe_queue_obj *o,
638                                      struct ecore_exeq_elem *elem);
639
640 struct ecore_exe_queue_obj {
641         /* Commands pending for an execution. */
642         ecore_list_t    exe_queue;
643
644         /* Commands pending for an completion. */
645         ecore_list_t    pending_comp;
646
647         ECORE_MUTEX_SPIN                lock;
648
649         /* Maximum length of commands' list for one execution */
650         int                     exe_chunk_len;
651
652         union ecore_qable_obj   *owner;
653
654         /****** Virtual functions ******/
655         /**
656          * Called before commands execution for commands that are really
657          * going to be executed (after 'optimize').
658          *
659          * Must run under exe_queue->lock
660          */
661         exe_q_validate          validate;
662
663         /**
664          * Called before removing pending commands, cleaning allocated
665          * resources (e.g., credits from validate)
666          */
667          exe_q_remove           remove;
668
669         /**
670          * This will try to cancel the current pending commands list
671          * considering the new command.
672          *
673          * Returns the number of optimized commands or a negative error code
674          *
675          * Must run under exe_queue->lock
676          */
677         exe_q_optimize          optimize;
678
679         /**
680          * Run the next commands chunk (owner specific).
681          */
682         exe_q_execute           execute;
683
684         /**
685          * Return the exe_queue element containing the specific command
686          * if any. Otherwise return NULL.
687          */
688         exe_q_get               get;
689 };
690 /***************** Classification verbs: Set/Del MAC/VLAN/VLAN-MAC ************/
691 /*
692  * Element in the VLAN_MAC registry list having all current configured
693  * rules.
694  */
695 struct ecore_vlan_mac_registry_elem {
696         ecore_list_entry_t      link;
697
698         /* Used to store the cam offset used for the mac/vlan/vlan-mac.
699          * Relevant for 57710 and 57711 only. VLANs and MACs share the
700          * same CAM for these chips.
701          */
702         int                     cam_offset;
703
704         /* Needed for DEL and RESTORE flows */
705         unsigned long           vlan_mac_flags;
706
707         union ecore_classification_ramrod_data u;
708 };
709
710 /* Bits representing VLAN_MAC commands specific flags */
711 enum {
712         ECORE_UC_LIST_MAC,
713         ECORE_ETH_MAC,
714         ECORE_ISCSI_ETH_MAC,
715         ECORE_NETQ_ETH_MAC,
716         ECORE_DONT_CONSUME_CAM_CREDIT,
717         ECORE_DONT_CONSUME_CAM_CREDIT_DEST,
718 };
719
720 struct ecore_vlan_mac_ramrod_params {
721         /* Object to run the command from */
722         struct ecore_vlan_mac_obj *vlan_mac_obj;
723
724         /* General command flags: COMP_WAIT, etc. */
725         unsigned long ramrod_flags;
726
727         /* Command specific configuration request */
728         struct ecore_vlan_mac_data user_req;
729 };
730
731 struct ecore_vlan_mac_obj {
732         struct ecore_raw_obj raw;
733
734         /* Bookkeeping list: will prevent the addition of already existing
735          * entries.
736          */
737         ecore_list_t            head;
738         /* Implement a simple reader/writer lock on the head list.
739          * all these fields should only be accessed under the exe_queue lock
740          */
741         uint8_t         head_reader; /* Num. of readers accessing head list */
742         bool            head_exe_request; /* Pending execution request. */
743         unsigned long   saved_ramrod_flags; /* Ramrods of pending execution */
744
745         /* Execution queue interface instance */
746         struct ecore_exe_queue_obj      exe_queue;
747
748         /* MACs credit pool */
749         struct ecore_credit_pool_obj    *macs_pool;
750
751         /* VLANs credit pool */
752         struct ecore_credit_pool_obj    *vlans_pool;
753
754         /* RAMROD command to be used */
755         int                             ramrod_cmd;
756
757         /* copy first n elements onto preallocated buffer
758          *
759          * @param n number of elements to get
760          * @param buf buffer preallocated by caller into which elements
761          *            will be copied. Note elements are 4-byte aligned
762          *            so buffer size must be able to accommodate the
763          *            aligned elements.
764          *
765          * @return number of copied bytes
766          */
767
768         int (*get_n_elements)(struct bxe_adapter *sc,
769                               struct ecore_vlan_mac_obj *o, int n, uint8_t *base,
770                               uint8_t stride, uint8_t size);
771
772         /**
773          * Checks if ADD-ramrod with the given params may be performed.
774          *
775          * @return zero if the element may be added
776          */
777
778         int (*check_add)(struct bxe_adapter *sc,
779                          struct ecore_vlan_mac_obj *o,
780                          union ecore_classification_ramrod_data *data);
781
782         /**
783          * Checks if DEL-ramrod with the given params may be performed.
784          *
785          * @return TRUE if the element may be deleted
786          */
787         struct ecore_vlan_mac_registry_elem *
788                 (*check_del)(struct bxe_adapter *sc,
789                              struct ecore_vlan_mac_obj *o,
790                              union ecore_classification_ramrod_data *data);
791
792         /**
793          * Checks if DEL-ramrod with the given params may be performed.
794          *
795          * @return TRUE if the element may be deleted
796          */
797         bool (*check_move)(struct bxe_adapter *sc,
798                            struct ecore_vlan_mac_obj *src_o,
799                            struct ecore_vlan_mac_obj *dst_o,
800                            union ecore_classification_ramrod_data *data);
801
802         /**
803          *  Update the relevant credit object(s) (consume/return
804          *  correspondingly).
805          */
806         bool (*get_credit)(struct ecore_vlan_mac_obj *o);
807         bool (*put_credit)(struct ecore_vlan_mac_obj *o);
808         bool (*get_cam_offset)(struct ecore_vlan_mac_obj *o, int *offset);
809         bool (*put_cam_offset)(struct ecore_vlan_mac_obj *o, int offset);
810
811         /**
812          * Configures one rule in the ramrod data buffer.
813          */
814         void (*set_one_rule)(struct bxe_adapter *sc,
815                              struct ecore_vlan_mac_obj *o,
816                              struct ecore_exeq_elem *elem, int rule_idx,
817                              int cam_offset);
818
819         /**
820         *  Delete all configured elements having the given
821         *  vlan_mac_flags specification. Assumes no pending for
822         *  execution commands. Will schedule all all currently
823         *  configured MACs/VLANs/VLAN-MACs matching the vlan_mac_flags
824         *  specification for deletion and will use the given
825         *  ramrod_flags for the last DEL operation.
826          *
827          * @param sc
828          * @param o
829          * @param ramrod_flags RAMROD_XX flags
830          *
831          * @return 0 if the last operation has completed successfully
832          *         and there are no more elements left, positive value
833          *         if there are pending for completion commands,
834          *         negative value in case of failure.
835          */
836         int (*delete_all)(struct bxe_adapter *sc,
837                           struct ecore_vlan_mac_obj *o,
838                           unsigned long *vlan_mac_flags,
839                           unsigned long *ramrod_flags);
840
841         /**
842          * Reconfigures the next MAC/VLAN/VLAN-MAC element from the previously
843          * configured elements list.
844          *
845          * @param sc
846          * @param p Command parameters (RAMROD_COMP_WAIT bit in
847          *          ramrod_flags is only taken into an account)
848          * @param ppos a pointer to the cookie that should be given back in the
849          *        next call to make function handle the next element. If
850          *        *ppos is set to NULL it will restart the iterator.
851          *        If returned *ppos == NULL this means that the last
852          *        element has been handled.
853          *
854          * @return int
855          */
856         int (*restore)(struct bxe_adapter *sc,
857                        struct ecore_vlan_mac_ramrod_params *p,
858                        struct ecore_vlan_mac_registry_elem **ppos);
859
860         /**
861          * Should be called on a completion arrival.
862          *
863          * @param sc
864          * @param o
865          * @param cqe Completion element we are handling
866          * @param ramrod_flags if RAMROD_CONT is set the next bulk of
867          *                     pending commands will be executed.
868          *                     RAMROD_DRV_CLR_ONLY and RAMROD_RESTORE
869          *                     may also be set if needed.
870          *
871          * @return 0 if there are neither pending nor waiting for
872          *         completion commands. Positive value if there are
873          *         pending for execution or for completion commands.
874          *         Negative value in case of an error (including an
875          *         error in the cqe).
876          */
877         int (*complete)(struct bxe_adapter *sc, struct ecore_vlan_mac_obj *o,
878                         union event_ring_elem *cqe,
879                         unsigned long *ramrod_flags);
880
881         /**
882          * Wait for completion of all commands. Don't schedule new ones,
883          * just wait. It assumes that the completion code will schedule
884          * for new commands.
885          */
886         int (*wait)(struct bxe_adapter *sc, struct ecore_vlan_mac_obj *o);
887 };
888
889 enum {
890         ECORE_LLH_CAM_ISCSI_ETH_LINE = 0,
891         ECORE_LLH_CAM_ETH_LINE,
892         ECORE_LLH_CAM_MAX_PF_LINE = NIG_REG_LLH1_FUNC_MEM_SIZE / 2
893 };
894
895 void ecore_set_mac_in_nig(struct bxe_adapter *sc,
896                           bool add, unsigned char *dev_addr, int index);
897
898 /** RX_MODE verbs:DROP_ALL/ACCEPT_ALL/ACCEPT_ALL_MULTI/ACCEPT_ALL_VLAN/NORMAL */
899
900 /* RX_MODE ramrod special flags: set in rx_mode_flags field in
901  * a ecore_rx_mode_ramrod_params.
902  */
903 enum {
904         ECORE_RX_MODE_FCOE_ETH,
905         ECORE_RX_MODE_ISCSI_ETH,
906 };
907
908 enum {
909         ECORE_ACCEPT_UNICAST,
910         ECORE_ACCEPT_MULTICAST,
911         ECORE_ACCEPT_ALL_UNICAST,
912         ECORE_ACCEPT_ALL_MULTICAST,
913         ECORE_ACCEPT_BROADCAST,
914         ECORE_ACCEPT_UNMATCHED,
915         ECORE_ACCEPT_ANY_VLAN
916 };
917
918 struct ecore_rx_mode_ramrod_params {
919         struct ecore_rx_mode_obj *rx_mode_obj;
920         unsigned long *pstate;
921         int state;
922         uint8_t cl_id;
923         uint32_t cid;
924         uint8_t func_id;
925         unsigned long ramrod_flags;
926         unsigned long rx_mode_flags;
927
928         /* rdata is either a pointer to eth_filter_rules_ramrod_data(e2) or to
929          * a tstorm_eth_mac_filter_config (e1x).
930          */
931         void *rdata;
932         ecore_dma_addr_t rdata_mapping;
933
934         /* Rx mode settings */
935         unsigned long rx_accept_flags;
936
937         /* internal switching settings */
938         unsigned long tx_accept_flags;
939 };
940
941 struct ecore_rx_mode_obj {
942         int (*config_rx_mode)(struct bxe_adapter *sc,
943                               struct ecore_rx_mode_ramrod_params *p);
944
945         int (*wait_comp)(struct bxe_adapter *sc,
946                          struct ecore_rx_mode_ramrod_params *p);
947 };
948
949 /********************** Set multicast group ***********************************/
950
951 struct ecore_mcast_list_elem {
952         ecore_list_entry_t link;
953         uint8_t *mac;
954 };
955
956 union ecore_mcast_config_data {
957         uint8_t *mac;
958         uint8_t bin; /* used in a RESTORE flow */
959 };
960
961 struct ecore_mcast_ramrod_params {
962         struct ecore_mcast_obj *mcast_obj;
963
964         /* Relevant options are RAMROD_COMP_WAIT and RAMROD_DRV_CLR_ONLY */
965         unsigned long ramrod_flags;
966
967         ecore_list_t mcast_list; /* list of struct ecore_mcast_list_elem */
968         /** TODO:
969          *      - rename it to macs_num.
970          *      - Add a new command type for handling pending commands
971          *        (remove "zero semantics").
972          *
973          *  Length of mcast_list. If zero and ADD_CONT command - post
974          *  pending commands.
975          */
976         int mcast_list_len;
977 };
978
979 enum ecore_mcast_cmd {
980         ECORE_MCAST_CMD_ADD,
981         ECORE_MCAST_CMD_CONT,
982         ECORE_MCAST_CMD_DEL,
983         ECORE_MCAST_CMD_RESTORE,
984 };
985
986 struct ecore_mcast_obj {
987         struct ecore_raw_obj raw;
988
989         union {
990                 struct {
991                 #define ECORE_MCAST_BINS_NUM    256
992                 #define ECORE_MCAST_VEC_SZ      (ECORE_MCAST_BINS_NUM / 64)
993                         uint64_t vec[ECORE_MCAST_VEC_SZ];
994
995                         /** Number of BINs to clear. Should be updated
996                          *  immediately when a command arrives in order to
997                          *  properly create DEL commands.
998                          */
999                         int num_bins_set;
1000                 } aprox_match;
1001
1002                 struct {
1003                         ecore_list_t macs;
1004                         int num_macs_set;
1005                 } exact_match;
1006         } registry;
1007
1008         /* Pending commands */
1009         ecore_list_t pending_cmds_head;
1010
1011         /* A state that is set in raw.pstate, when there are pending commands */
1012         int sched_state;
1013
1014         /* Maximal number of mcast MACs configured in one command */
1015         int max_cmd_len;
1016
1017         /* Total number of currently pending MACs to configure: both
1018          * in the pending commands list and in the current command.
1019          */
1020         int total_pending_num;
1021
1022         uint8_t engine_id;
1023
1024         /**
1025          * @param cmd command to execute (ECORE_MCAST_CMD_X, see above)
1026          */
1027         int (*config_mcast)(struct bxe_adapter *sc,
1028                             struct ecore_mcast_ramrod_params *p,
1029                             enum ecore_mcast_cmd cmd);
1030
1031         /**
1032          * Fills the ramrod data during the RESTORE flow.
1033          *
1034          * @param sc
1035          * @param o
1036          * @param start_idx Registry index to start from
1037          * @param rdata_idx Index in the ramrod data to start from
1038          *
1039          * @return -1 if we handled the whole registry or index of the last
1040          *         handled registry element.
1041          */
1042         int (*hdl_restore)(struct bxe_adapter *sc, struct ecore_mcast_obj *o,
1043                            int start_bin, int *rdata_idx);
1044
1045         int (*enqueue_cmd)(struct bxe_adapter *sc, struct ecore_mcast_obj *o,
1046                            struct ecore_mcast_ramrod_params *p,
1047                            enum ecore_mcast_cmd cmd);
1048
1049         void (*set_one_rule)(struct bxe_adapter *sc,
1050                              struct ecore_mcast_obj *o, int idx,
1051                              union ecore_mcast_config_data *cfg_data,
1052                              enum ecore_mcast_cmd cmd);
1053
1054         /** Checks if there are more mcast MACs to be set or a previous
1055          *  command is still pending.
1056          */
1057         bool (*check_pending)(struct ecore_mcast_obj *o);
1058
1059         /**
1060          * Set/Clear/Check SCHEDULED state of the object
1061          */
1062         void (*set_sched)(struct ecore_mcast_obj *o);
1063         void (*clear_sched)(struct ecore_mcast_obj *o);
1064         bool (*check_sched)(struct ecore_mcast_obj *o);
1065
1066         /* Wait until all pending commands complete */
1067         int (*wait_comp)(struct bxe_adapter *sc, struct ecore_mcast_obj *o);
1068
1069         /**
1070          * Handle the internal object counters needed for proper
1071          * commands handling. Checks that the provided parameters are
1072          * feasible.
1073          */
1074         int (*validate)(struct bxe_adapter *sc,
1075                         struct ecore_mcast_ramrod_params *p,
1076                         enum ecore_mcast_cmd cmd);
1077
1078         /**
1079          * Restore the values of internal counters in case of a failure.
1080          */
1081         void (*revert)(struct bxe_adapter *sc,
1082                        struct ecore_mcast_ramrod_params *p,
1083                        int old_num_bins);
1084
1085         int (*get_registry_size)(struct ecore_mcast_obj *o);
1086         void (*set_registry_size)(struct ecore_mcast_obj *o, int n);
1087 };
1088
1089 /*************************** Credit handling **********************************/
1090 struct ecore_credit_pool_obj {
1091
1092         /* Current amount of credit in the pool */
1093         ecore_atomic_t  credit;
1094
1095         /* Maximum allowed credit. put() will check against it. */
1096         int             pool_sz;
1097
1098         /* Allocate a pool table statically.
1099          *
1100          * Currently the maximum allowed size is MAX_MAC_CREDIT_E2(272)
1101          *
1102          * The set bit in the table will mean that the entry is available.
1103          */
1104 #define ECORE_POOL_VEC_SIZE     (MAX_MAC_CREDIT_E2 / 64)
1105         uint64_t                pool_mirror[ECORE_POOL_VEC_SIZE];
1106
1107         /* Base pool offset (initialized differently */
1108         int             base_pool_offset;
1109
1110         /**
1111          * Get the next free pool entry.
1112          *
1113          * @return TRUE if there was a free entry in the pool
1114          */
1115         bool (*get_entry)(struct ecore_credit_pool_obj *o, int *entry);
1116
1117         /**
1118          * Return the entry back to the pool.
1119          *
1120          * @return TRUE if entry is legal and has been successfully
1121          *         returned to the pool.
1122          */
1123         bool (*put_entry)(struct ecore_credit_pool_obj *o, int entry);
1124
1125         /**
1126          * Get the requested amount of credit from the pool.
1127          *
1128          * @param cnt Amount of requested credit
1129          * @return TRUE if the operation is successful
1130          */
1131         bool (*get)(struct ecore_credit_pool_obj *o, int cnt);
1132
1133         /**
1134          * Returns the credit to the pool.
1135          *
1136          * @param cnt Amount of credit to return
1137          * @return TRUE if the operation is successful
1138          */
1139         bool (*put)(struct ecore_credit_pool_obj *o, int cnt);
1140
1141         /**
1142          * Reads the current amount of credit.
1143          */
1144         int (*check)(struct ecore_credit_pool_obj *o);
1145 };
1146
1147 /*************************** RSS configuration ********************************/
1148 enum {
1149         /* RSS_MODE bits are mutually exclusive */
1150         ECORE_RSS_MODE_DISABLED,
1151         ECORE_RSS_MODE_REGULAR,
1152
1153         ECORE_RSS_SET_SRCH, /* Setup searcher, E1x specific flag */
1154
1155         ECORE_RSS_IPV4,
1156         ECORE_RSS_IPV4_TCP,
1157         ECORE_RSS_IPV4_UDP,
1158         ECORE_RSS_IPV6,
1159         ECORE_RSS_IPV6_TCP,
1160         ECORE_RSS_IPV6_UDP,
1161
1162         ECORE_RSS_TUNNELING,
1163 #if defined(__VMKLNX__) && (VMWARE_ESX_DDK_VERSION < 55000) /* ! BNX2X_UPSTREAM */
1164         ECORE_RSS_MODE_ESX51,
1165 #endif
1166 };
1167
1168 struct ecore_config_rss_params {
1169         struct ecore_rss_config_obj *rss_obj;
1170
1171         /* may have RAMROD_COMP_WAIT set only */
1172         unsigned long   ramrod_flags;
1173
1174         /* ECORE_RSS_X bits */
1175         unsigned long   rss_flags;
1176
1177         /* Number hash bits to take into an account */
1178         uint8_t         rss_result_mask;
1179
1180         /* Indirection table */
1181         uint8_t         ind_table[T_ETH_INDIRECTION_TABLE_SIZE];
1182
1183         /* RSS hash values */
1184         uint32_t                rss_key[10];
1185
1186         /* valid only iff ECORE_RSS_UPDATE_TOE is set */
1187         uint16_t                toe_rss_bitmap;
1188
1189         /* valid iff ECORE_RSS_TUNNELING is set */
1190         uint16_t                tunnel_value;
1191         uint16_t                tunnel_mask;
1192 };
1193
1194 struct ecore_rss_config_obj {
1195         struct ecore_raw_obj    raw;
1196
1197         /* RSS engine to use */
1198         uint8_t                 engine_id;
1199
1200         /* Last configured indirection table */
1201         uint8_t                 ind_table[T_ETH_INDIRECTION_TABLE_SIZE];
1202
1203         /* flags for enabling 4-tupple hash on UDP */
1204         uint8_t                 udp_rss_v4;
1205         uint8_t                 udp_rss_v6;
1206
1207         int (*config_rss)(struct bxe_adapter *sc,
1208                           struct ecore_config_rss_params *p);
1209 };
1210
1211 /*********************** Queue state update ***********************************/
1212
1213 /* UPDATE command options */
1214 enum {
1215         ECORE_Q_UPDATE_IN_VLAN_REM,
1216         ECORE_Q_UPDATE_IN_VLAN_REM_CHNG,
1217         ECORE_Q_UPDATE_OUT_VLAN_REM,
1218         ECORE_Q_UPDATE_OUT_VLAN_REM_CHNG,
1219         ECORE_Q_UPDATE_ANTI_SPOOF,
1220         ECORE_Q_UPDATE_ANTI_SPOOF_CHNG,
1221         ECORE_Q_UPDATE_ACTIVATE,
1222         ECORE_Q_UPDATE_ACTIVATE_CHNG,
1223         ECORE_Q_UPDATE_DEF_VLAN_EN,
1224         ECORE_Q_UPDATE_DEF_VLAN_EN_CHNG,
1225         ECORE_Q_UPDATE_SILENT_VLAN_REM_CHNG,
1226         ECORE_Q_UPDATE_SILENT_VLAN_REM,
1227         ECORE_Q_UPDATE_TX_SWITCHING_CHNG,
1228         ECORE_Q_UPDATE_TX_SWITCHING,
1229 };
1230
1231 /* Allowed Queue states */
1232 enum ecore_q_state {
1233         ECORE_Q_STATE_RESET,
1234         ECORE_Q_STATE_INITIALIZED,
1235         ECORE_Q_STATE_ACTIVE,
1236         ECORE_Q_STATE_MULTI_COS,
1237         ECORE_Q_STATE_MCOS_TERMINATED,
1238         ECORE_Q_STATE_INACTIVE,
1239         ECORE_Q_STATE_STOPPED,
1240         ECORE_Q_STATE_TERMINATED,
1241         ECORE_Q_STATE_FLRED,
1242         ECORE_Q_STATE_MAX,
1243 };
1244
1245 /* Allowed Queue states */
1246 enum ecore_q_logical_state {
1247         ECORE_Q_LOGICAL_STATE_ACTIVE,
1248         ECORE_Q_LOGICAL_STATE_STOPPED,
1249 };
1250
1251 /* Allowed commands */
1252 enum ecore_queue_cmd {
1253         ECORE_Q_CMD_INIT,
1254         ECORE_Q_CMD_SETUP,
1255         ECORE_Q_CMD_SETUP_TX_ONLY,
1256         ECORE_Q_CMD_DEACTIVATE,
1257         ECORE_Q_CMD_ACTIVATE,
1258         ECORE_Q_CMD_UPDATE,
1259         ECORE_Q_CMD_UPDATE_TPA,
1260         ECORE_Q_CMD_HALT,
1261         ECORE_Q_CMD_CFC_DEL,
1262         ECORE_Q_CMD_TERMINATE,
1263         ECORE_Q_CMD_EMPTY,
1264         ECORE_Q_CMD_MAX,
1265 };
1266
1267 /* queue SETUP + INIT flags */
1268 enum {
1269         ECORE_Q_FLG_TPA,
1270         ECORE_Q_FLG_TPA_IPV6,
1271         ECORE_Q_FLG_TPA_GRO,
1272         ECORE_Q_FLG_STATS,
1273         ECORE_Q_FLG_ZERO_STATS,
1274         ECORE_Q_FLG_ACTIVE,
1275         ECORE_Q_FLG_OV,
1276         ECORE_Q_FLG_VLAN,
1277         ECORE_Q_FLG_COS,
1278         ECORE_Q_FLG_HC,
1279         ECORE_Q_FLG_HC_EN,
1280         ECORE_Q_FLG_DHC,
1281         ECORE_Q_FLG_OOO,
1282         ECORE_Q_FLG_FCOE,
1283         ECORE_Q_FLG_LEADING_RSS,
1284         ECORE_Q_FLG_MCAST,
1285         ECORE_Q_FLG_DEF_VLAN,
1286         ECORE_Q_FLG_TX_SWITCH,
1287         ECORE_Q_FLG_TX_SEC,
1288         ECORE_Q_FLG_ANTI_SPOOF,
1289         ECORE_Q_FLG_SILENT_VLAN_REM,
1290         ECORE_Q_FLG_FORCE_DEFAULT_PRI,
1291         ECORE_Q_FLG_REFUSE_OUTBAND_VLAN,
1292         ECORE_Q_FLG_PCSUM_ON_PKT,
1293         ECORE_Q_FLG_TUN_INC_INNER_IP_ID
1294 };
1295
1296 /* Queue type options: queue type may be a combination of below. */
1297 enum ecore_q_type {
1298         ECORE_Q_TYPE_FWD,
1299         /** TODO: Consider moving both these flags into the init()
1300          *        ramrod params.
1301          */
1302         ECORE_Q_TYPE_HAS_RX,
1303         ECORE_Q_TYPE_HAS_TX,
1304 };
1305
1306 #define ECORE_PRIMARY_CID_INDEX                 0
1307 #define ECORE_MULTI_TX_COS_E1X                  3 /* QM only */
1308 #define ECORE_MULTI_TX_COS_E2_E3A0              2
1309 #define ECORE_MULTI_TX_COS_E3B0                 3
1310 #define ECORE_MULTI_TX_COS                      3 /* Maximum possible */
1311 #define MAC_PAD (ECORE_ALIGN(ETH_ALEN, sizeof(uint32_t)) - ETH_ALEN)
1312
1313 struct ecore_queue_init_params {
1314         struct {
1315                 unsigned long   flags;
1316                 uint16_t                hc_rate;
1317                 uint8_t         fw_sb_id;
1318                 uint8_t         sb_cq_index;
1319         } tx;
1320
1321         struct {
1322                 unsigned long   flags;
1323                 uint16_t                hc_rate;
1324                 uint8_t         fw_sb_id;
1325                 uint8_t         sb_cq_index;
1326         } rx;
1327
1328         /* CID context in the host memory */
1329         struct eth_context *cxts[ECORE_MULTI_TX_COS];
1330
1331         /* maximum number of cos supported by hardware */
1332         uint8_t max_cos;
1333 };
1334
1335 struct ecore_queue_terminate_params {
1336         /* index within the tx_only cids of this queue object */
1337         uint8_t cid_index;
1338 };
1339
1340 struct ecore_queue_cfc_del_params {
1341         /* index within the tx_only cids of this queue object */
1342         uint8_t cid_index;
1343 };
1344
1345 struct ecore_queue_update_params {
1346         unsigned long   update_flags; /* ECORE_Q_UPDATE_XX bits */
1347         uint16_t                def_vlan;
1348         uint16_t                silent_removal_value;
1349         uint16_t                silent_removal_mask;
1350 /* index within the tx_only cids of this queue object */
1351         uint8_t         cid_index;
1352 };
1353
1354 struct rxq_pause_params {
1355         uint16_t                bd_th_lo;
1356         uint16_t                bd_th_hi;
1357         uint16_t                rcq_th_lo;
1358         uint16_t                rcq_th_hi;
1359         uint16_t                sge_th_lo; /* valid iff ECORE_Q_FLG_TPA */
1360         uint16_t                sge_th_hi; /* valid iff ECORE_Q_FLG_TPA */
1361         uint16_t                pri_map;
1362 };
1363
1364 /* general */
1365 struct ecore_general_setup_params {
1366         /* valid iff ECORE_Q_FLG_STATS */
1367         uint8_t         stat_id;
1368
1369         uint8_t         spcl_id;
1370         uint16_t                mtu;
1371         uint8_t         cos;
1372 };
1373
1374 struct ecore_rxq_setup_params {
1375         /* dma */
1376         ecore_dma_addr_t        dscr_map;
1377         ecore_dma_addr_t        sge_map;
1378         ecore_dma_addr_t        rcq_map;
1379         ecore_dma_addr_t        rcq_np_map;
1380
1381         uint16_t                drop_flags;
1382         uint16_t                buf_sz;
1383         uint8_t         fw_sb_id;
1384         uint8_t         cl_qzone_id;
1385
1386         /* valid iff ECORE_Q_FLG_TPA */
1387         uint16_t                tpa_agg_sz;
1388         uint16_t                sge_buf_sz;
1389         uint8_t         max_sges_pkt;
1390         uint8_t         max_tpa_queues;
1391         uint8_t         rss_engine_id;
1392
1393         /* valid iff ECORE_Q_FLG_MCAST */
1394         uint8_t         mcast_engine_id;
1395
1396         uint8_t         cache_line_log;
1397
1398         uint8_t         sb_cq_index;
1399
1400         /* valid iff BXN2X_Q_FLG_SILENT_VLAN_REM */
1401         uint16_t silent_removal_value;
1402         uint16_t silent_removal_mask;
1403 };
1404
1405 struct ecore_txq_setup_params {
1406         /* dma */
1407         ecore_dma_addr_t        dscr_map;
1408
1409         uint8_t         fw_sb_id;
1410         uint8_t         sb_cq_index;
1411         uint8_t         cos;            /* valid iff ECORE_Q_FLG_COS */
1412         uint16_t                traffic_type;
1413         /* equals to the leading rss client id, used for TX classification*/
1414         uint8_t         tss_leading_cl_id;
1415
1416         /* valid iff ECORE_Q_FLG_DEF_VLAN */
1417         uint16_t                default_vlan;
1418 };
1419
1420 struct ecore_queue_setup_params {
1421         struct ecore_general_setup_params gen_params;
1422         struct ecore_txq_setup_params txq_params;
1423         struct ecore_rxq_setup_params rxq_params;
1424         struct rxq_pause_params pause_params;
1425         unsigned long flags;
1426 };
1427
1428 struct ecore_queue_setup_tx_only_params {
1429         struct ecore_general_setup_params       gen_params;
1430         struct ecore_txq_setup_params           txq_params;
1431         unsigned long                           flags;
1432         /* index within the tx_only cids of this queue object */
1433         uint8_t                                 cid_index;
1434 };
1435
1436 struct ecore_queue_state_params {
1437         struct ecore_queue_sp_obj *q_obj;
1438
1439         /* Current command */
1440         enum ecore_queue_cmd cmd;
1441
1442         /* may have RAMROD_COMP_WAIT set only */
1443         unsigned long ramrod_flags;
1444
1445         /* Params according to the current command */
1446         union {
1447                 struct ecore_queue_update_params        update;
1448                 struct ecore_queue_setup_params         setup;
1449                 struct ecore_queue_init_params          init;
1450                 struct ecore_queue_setup_tx_only_params tx_only;
1451                 struct ecore_queue_terminate_params     terminate;
1452                 struct ecore_queue_cfc_del_params       cfc_del;
1453         } params;
1454 };
1455
1456 struct ecore_viflist_params {
1457         uint8_t echo_res;
1458         uint8_t func_bit_map_res;
1459 };
1460
1461 struct ecore_queue_sp_obj {
1462         uint32_t                cids[ECORE_MULTI_TX_COS];
1463         uint8_t         cl_id;
1464         uint8_t         func_id;
1465
1466         /* number of traffic classes supported by queue.
1467          * The primary connection of the queue supports the first traffic
1468          * class. Any further traffic class is supported by a tx-only
1469          * connection.
1470          *
1471          * Therefore max_cos is also a number of valid entries in the cids
1472          * array.
1473          */
1474         uint8_t max_cos;
1475         uint8_t num_tx_only, next_tx_only;
1476
1477         enum ecore_q_state state, next_state;
1478
1479         /* bits from enum ecore_q_type */
1480         unsigned long   type;
1481
1482         /* ECORE_Q_CMD_XX bits. This object implements "one
1483          * pending" paradigm but for debug and tracing purposes it's
1484          * more convenient to have different bits for different
1485          * commands.
1486          */
1487         unsigned long   pending;
1488
1489         /* Buffer to use as a ramrod data and its mapping */
1490         void            *rdata;
1491         ecore_dma_addr_t        rdata_mapping;
1492
1493         /**
1494          * Performs one state change according to the given parameters.
1495          *
1496          * @return 0 in case of success and negative value otherwise.
1497          */
1498         int (*send_cmd)(struct bxe_adapter *sc,
1499                         struct ecore_queue_state_params *params);
1500
1501         /**
1502          * Sets the pending bit according to the requested transition.
1503          */
1504         int (*set_pending)(struct ecore_queue_sp_obj *o,
1505                            struct ecore_queue_state_params *params);
1506
1507         /**
1508          * Checks that the requested state transition is legal.
1509          */
1510         int (*check_transition)(struct bxe_adapter *sc,
1511                                 struct ecore_queue_sp_obj *o,
1512                                 struct ecore_queue_state_params *params);
1513
1514         /**
1515          * Completes the pending command.
1516          */
1517         int (*complete_cmd)(struct bxe_adapter *sc,
1518                             struct ecore_queue_sp_obj *o,
1519                             enum ecore_queue_cmd);
1520
1521         int (*wait_comp)(struct bxe_adapter *sc,
1522                          struct ecore_queue_sp_obj *o,
1523                          enum ecore_queue_cmd cmd);
1524 };
1525
1526 /********************** Function state update *********************************/
1527 /* Allowed Function states */
1528 enum ecore_func_state {
1529         ECORE_F_STATE_RESET,
1530         ECORE_F_STATE_INITIALIZED,
1531         ECORE_F_STATE_STARTED,
1532         ECORE_F_STATE_TX_STOPPED,
1533         ECORE_F_STATE_MAX,
1534 };
1535
1536 /* Allowed Function commands */
1537 enum ecore_func_cmd {
1538         ECORE_F_CMD_HW_INIT,
1539         ECORE_F_CMD_START,
1540         ECORE_F_CMD_STOP,
1541         ECORE_F_CMD_HW_RESET,
1542         ECORE_F_CMD_AFEX_UPDATE,
1543         ECORE_F_CMD_AFEX_VIFLISTS,
1544         ECORE_F_CMD_TX_STOP,
1545         ECORE_F_CMD_TX_START,
1546         ECORE_F_CMD_SWITCH_UPDATE,
1547         ECORE_F_CMD_MAX,
1548 };
1549
1550 struct ecore_func_hw_init_params {
1551         /* A load phase returned by MCP.
1552          *
1553          * May be:
1554          *              FW_MSG_CODE_DRV_LOAD_COMMON_CHIP
1555          *              FW_MSG_CODE_DRV_LOAD_COMMON
1556          *              FW_MSG_CODE_DRV_LOAD_PORT
1557          *              FW_MSG_CODE_DRV_LOAD_FUNCTION
1558          */
1559         uint32_t load_phase;
1560 };
1561
1562 struct ecore_func_hw_reset_params {
1563         /* A load phase returned by MCP.
1564          *
1565          * May be:
1566          *              FW_MSG_CODE_DRV_LOAD_COMMON_CHIP
1567          *              FW_MSG_CODE_DRV_LOAD_COMMON
1568          *              FW_MSG_CODE_DRV_LOAD_PORT
1569          *              FW_MSG_CODE_DRV_LOAD_FUNCTION
1570          */
1571         uint32_t reset_phase;
1572 };
1573
1574 struct ecore_func_start_params {
1575         /* Multi Function mode:
1576          *      - Single Function
1577          *      - Switch Dependent
1578          *      - Switch Independent
1579          */
1580         uint16_t mf_mode;
1581
1582         /* Switch Dependent mode outer VLAN tag */
1583         uint16_t sd_vlan_tag;
1584
1585         /* Function cos mode */
1586         uint8_t network_cos_mode;
1587
1588         /* NVGRE classification enablement */
1589         uint8_t nvgre_clss_en;
1590
1591         /* NO_GRE_TUNNEL/NVGRE_TUNNEL/L2GRE_TUNNEL/IPGRE_TUNNEL */
1592         uint8_t gre_tunnel_mode;
1593
1594         /* GRE_OUTER_HEADERS_RSS/GRE_INNER_HEADERS_RSS/NVGRE_KEY_ENTROPY_RSS */
1595         uint8_t gre_tunnel_rss;
1596
1597 };
1598
1599 struct ecore_func_switch_update_params {
1600         uint8_t suspend;
1601 };
1602
1603 struct ecore_func_afex_update_params {
1604         uint16_t vif_id;
1605         uint16_t afex_default_vlan;
1606         uint8_t allowed_priorities;
1607 };
1608
1609 struct ecore_func_afex_viflists_params {
1610         uint16_t vif_list_index;
1611         uint8_t func_bit_map;
1612         uint8_t afex_vif_list_command;
1613         uint8_t func_to_clear;
1614 };
1615 struct ecore_func_tx_start_params {
1616         struct priority_cos traffic_type_to_priority_cos[MAX_TRAFFIC_TYPES];
1617         uint8_t dcb_enabled;
1618         uint8_t dcb_version;
1619         uint8_t dont_add_pri_0;
1620 };
1621
1622 struct ecore_func_state_params {
1623         struct ecore_func_sp_obj *f_obj;
1624
1625         /* Current command */
1626         enum ecore_func_cmd cmd;
1627
1628         /* may have RAMROD_COMP_WAIT set only */
1629         unsigned long   ramrod_flags;
1630
1631         /* Params according to the current command */
1632         union {
1633                 struct ecore_func_hw_init_params hw_init;
1634                 struct ecore_func_hw_reset_params hw_reset;
1635                 struct ecore_func_start_params start;
1636                 struct ecore_func_switch_update_params switch_update;
1637                 struct ecore_func_afex_update_params afex_update;
1638                 struct ecore_func_afex_viflists_params afex_viflists;
1639                 struct ecore_func_tx_start_params tx_start;
1640         } params;
1641 };
1642
1643 struct ecore_func_sp_drv_ops {
1644         /* Init tool + runtime initialization:
1645          *      - Common Chip
1646          *      - Common (per Path)
1647          *      - Port
1648          *      - Function phases
1649          */
1650         int (*init_hw_cmn_chip)(struct bxe_adapter *sc);
1651         int (*init_hw_cmn)(struct bxe_adapter *sc);
1652         int (*init_hw_port)(struct bxe_adapter *sc);
1653         int (*init_hw_func)(struct bxe_adapter *sc);
1654
1655         /* Reset Function HW: Common, Port, Function phases. */
1656         void (*reset_hw_cmn)(struct bxe_adapter *sc);
1657         void (*reset_hw_port)(struct bxe_adapter *sc);
1658         void (*reset_hw_func)(struct bxe_adapter *sc);
1659
1660         /* Init/Free GUNZIP resources */
1661         int (*gunzip_init)(struct bxe_adapter *sc);
1662         void (*gunzip_end)(struct bxe_adapter *sc);
1663
1664         /* Prepare/Release FW resources */
1665         int (*init_fw)(struct bxe_adapter *sc);
1666         void (*release_fw)(struct bxe_adapter *sc);
1667 };
1668
1669 struct ecore_func_sp_obj {
1670         enum ecore_func_state   state, next_state;
1671
1672         /* ECORE_FUNC_CMD_XX bits. This object implements "one
1673          * pending" paradigm but for debug and tracing purposes it's
1674          * more convenient to have different bits for different
1675          * commands.
1676          */
1677         unsigned long           pending;
1678
1679         /* Buffer to use as a ramrod data and its mapping */
1680         void                    *rdata;
1681         ecore_dma_addr_t                rdata_mapping;
1682
1683         /* Buffer to use as a afex ramrod data and its mapping.
1684          * This can't be same rdata as above because afex ramrod requests
1685          * can arrive to the object in parallel to other ramrod requests.
1686          */
1687         void                    *afex_rdata;
1688         ecore_dma_addr_t                afex_rdata_mapping;
1689
1690         /* this mutex validates that when pending flag is taken, the next
1691          * ramrod to be sent will be the one set the pending bit
1692          */
1693         ECORE_MUTEX             one_pending_mutex;
1694
1695         /* Driver interface */
1696         struct ecore_func_sp_drv_ops    *drv;
1697
1698         /**
1699          * Performs one state change according to the given parameters.
1700          *
1701          * @return 0 in case of success and negative value otherwise.
1702          */
1703         int (*send_cmd)(struct bxe_adapter *sc,
1704                         struct ecore_func_state_params *params);
1705
1706         /**
1707          * Checks that the requested state transition is legal.
1708          */
1709         int (*check_transition)(struct bxe_adapter *sc,
1710                                 struct ecore_func_sp_obj *o,
1711                                 struct ecore_func_state_params *params);
1712
1713         /**
1714          * Completes the pending command.
1715          */
1716         int (*complete_cmd)(struct bxe_adapter *sc,
1717                             struct ecore_func_sp_obj *o,
1718                             enum ecore_func_cmd cmd);
1719
1720         int (*wait_comp)(struct bxe_adapter *sc, struct ecore_func_sp_obj *o,
1721                          enum ecore_func_cmd cmd);
1722 };
1723
1724 /********************** Interfaces ********************************************/
1725 /* Queueable objects set */
1726 union ecore_qable_obj {
1727         struct ecore_vlan_mac_obj vlan_mac;
1728 };
1729 /************** Function state update *********/
1730 void ecore_init_func_obj(struct bxe_adapter *sc,
1731                          struct ecore_func_sp_obj *obj,
1732                          void *rdata, ecore_dma_addr_t rdata_mapping,
1733                          void *afex_rdata, ecore_dma_addr_t afex_rdata_mapping,
1734                          struct ecore_func_sp_drv_ops *drv_iface);
1735
1736 int ecore_func_state_change(struct bxe_adapter *sc,
1737                             struct ecore_func_state_params *params);
1738
1739 enum ecore_func_state ecore_func_get_state(struct bxe_adapter *sc,
1740                                            struct ecore_func_sp_obj *o);
1741 /******************* Queue State **************/
1742 void ecore_init_queue_obj(struct bxe_adapter *sc,
1743                           struct ecore_queue_sp_obj *obj, uint8_t cl_id, uint32_t *cids,
1744                           uint8_t cid_cnt, uint8_t func_id, void *rdata,
1745                           ecore_dma_addr_t rdata_mapping, unsigned long type);
1746
1747 int ecore_queue_state_change(struct bxe_adapter *sc,
1748                              struct ecore_queue_state_params *params);
1749
1750 int ecore_get_q_logical_state(struct bxe_adapter *sc,
1751                                struct ecore_queue_sp_obj *obj);
1752
1753 /********************* VLAN-MAC ****************/
1754 void ecore_init_mac_obj(struct bxe_adapter *sc,
1755                         struct ecore_vlan_mac_obj *mac_obj,
1756                         uint8_t cl_id, uint32_t cid, uint8_t func_id, void *rdata,
1757                         ecore_dma_addr_t rdata_mapping, int state,
1758                         unsigned long *pstate, ecore_obj_type type,
1759                         struct ecore_credit_pool_obj *macs_pool);
1760
1761 void ecore_init_vlan_obj(struct bxe_adapter *sc,
1762                          struct ecore_vlan_mac_obj *vlan_obj,
1763                          uint8_t cl_id, uint32_t cid, uint8_t func_id, void *rdata,
1764                          ecore_dma_addr_t rdata_mapping, int state,
1765                          unsigned long *pstate, ecore_obj_type type,
1766                          struct ecore_credit_pool_obj *vlans_pool);
1767
1768 void ecore_init_vlan_mac_obj(struct bxe_adapter *sc,
1769                              struct ecore_vlan_mac_obj *vlan_mac_obj,
1770                              uint8_t cl_id, uint32_t cid, uint8_t func_id, void *rdata,
1771                              ecore_dma_addr_t rdata_mapping, int state,
1772                              unsigned long *pstate, ecore_obj_type type,
1773                              struct ecore_credit_pool_obj *macs_pool,
1774                              struct ecore_credit_pool_obj *vlans_pool);
1775
1776 int ecore_vlan_mac_h_read_lock(struct bxe_adapter *sc,
1777                                         struct ecore_vlan_mac_obj *o);
1778 void ecore_vlan_mac_h_read_unlock(struct bxe_adapter *sc,
1779                                   struct ecore_vlan_mac_obj *o);
1780 int ecore_vlan_mac_h_write_lock(struct bxe_adapter *sc,
1781                                 struct ecore_vlan_mac_obj *o);
1782 void ecore_vlan_mac_h_write_unlock(struct bxe_adapter *sc,
1783                                           struct ecore_vlan_mac_obj *o);
1784 int ecore_config_vlan_mac(struct bxe_adapter *sc,
1785                            struct ecore_vlan_mac_ramrod_params *p);
1786
1787 int ecore_vlan_mac_move(struct bxe_adapter *sc,
1788                         struct ecore_vlan_mac_ramrod_params *p,
1789                         struct ecore_vlan_mac_obj *dest_o);
1790
1791 /********************* RX MODE ****************/
1792
1793 void ecore_init_rx_mode_obj(struct bxe_adapter *sc,
1794                             struct ecore_rx_mode_obj *o);
1795
1796 /**
1797  * ecore_config_rx_mode - Send and RX_MODE ramrod according to the provided parameters.
1798  *
1799  * @p: Command parameters
1800  *
1801  * Return: 0 - if operation was successful and there is no pending completions,
1802  *         positive number - if there are pending completions,
1803  *         negative - if there were errors
1804  */
1805 int ecore_config_rx_mode(struct bxe_adapter *sc,
1806                          struct ecore_rx_mode_ramrod_params *p);
1807
1808 /****************** MULTICASTS ****************/
1809
1810 void ecore_init_mcast_obj(struct bxe_adapter *sc,
1811                           struct ecore_mcast_obj *mcast_obj,
1812                           uint8_t mcast_cl_id, uint32_t mcast_cid, uint8_t func_id,
1813                           uint8_t engine_id, void *rdata, ecore_dma_addr_t rdata_mapping,
1814                           int state, unsigned long *pstate,
1815                           ecore_obj_type type);
1816
1817 /**
1818  * ecore_config_mcast - Configure multicast MACs list.
1819  *
1820  * @cmd: command to execute: BNX2X_MCAST_CMD_X
1821  *
1822  * May configure a new list
1823  * provided in p->mcast_list (ECORE_MCAST_CMD_ADD), clean up
1824  * (ECORE_MCAST_CMD_DEL) or restore (ECORE_MCAST_CMD_RESTORE) a current
1825  * configuration, continue to execute the pending commands
1826  * (ECORE_MCAST_CMD_CONT).
1827  *
1828  * If previous command is still pending or if number of MACs to
1829  * configure is more that maximum number of MACs in one command,
1830  * the current command will be enqueued to the tail of the
1831  * pending commands list.
1832  *
1833  * Return: 0 is operation was successfull and there are no pending completions,
1834  *         negative if there were errors, positive if there are pending
1835  *         completions.
1836  */
1837 int ecore_config_mcast(struct bxe_adapter *sc,
1838                        struct ecore_mcast_ramrod_params *p,
1839                        enum ecore_mcast_cmd cmd);
1840
1841 /****************** CREDIT POOL ****************/
1842 void ecore_init_mac_credit_pool(struct bxe_adapter *sc,
1843                                 struct ecore_credit_pool_obj *p, uint8_t func_id,
1844                                 uint8_t func_num);
1845 void ecore_init_vlan_credit_pool(struct bxe_adapter *sc,
1846                                  struct ecore_credit_pool_obj *p, uint8_t func_id,
1847                                  uint8_t func_num);
1848
1849 /****************** RSS CONFIGURATION ****************/
1850 void ecore_init_rss_config_obj(struct bxe_adapter *sc,
1851                                struct ecore_rss_config_obj *rss_obj,
1852                                uint8_t cl_id, uint32_t cid, uint8_t func_id, uint8_t engine_id,
1853                                void *rdata, ecore_dma_addr_t rdata_mapping,
1854                                int state, unsigned long *pstate,
1855                                ecore_obj_type type);
1856
1857 /**
1858  * ecore_config_rss - Updates RSS configuration according to provided parameters
1859  *
1860  * Return: 0 in case of success
1861  */
1862 int ecore_config_rss(struct bxe_adapter *sc,
1863                      struct ecore_config_rss_params *p);
1864
1865 /**
1866  * ecore_get_rss_ind_table - Return the current ind_table configuration.
1867  *
1868  * @ind_table: buffer to fill with the current indirection
1869  *                  table content. Should be at least
1870  *                  T_ETH_INDIRECTION_TABLE_SIZE bytes long.
1871  */
1872 void ecore_get_rss_ind_table(struct ecore_rss_config_obj *rss_obj,
1873                              uint8_t *ind_table);
1874
1875 /* set as inline so printout will show the offending function */
1876 int validate_vlan_mac(struct bxe_adapter *sc,
1877                       struct ecore_vlan_mac_obj *vlan_mac);
1878
1879 #endif /* ECORE_SP_H */
1880