1 /* bnx2x_sp.h: Broadcom Everest network driver.
2  *
3  * Copyright (c) 2011-2013 Broadcom Corporation
4  *
5  * Unless you and Broadcom execute a separate written software license
6  * agreement governing use of this software, this software is licensed to you
7  * under the terms of the GNU General Public License version 2, available
8  * at http://www.gnu.org/licenses/old-licenses/gpl-2.0.html (the "GPL").
9  *
10  * Notwithstanding the above, under no circumstances may you combine this
11  * software in any way with any other Broadcom software provided under a
12  * license other than the GPL, without Broadcom's express prior written
13  * consent.
14  *
15  * Maintained by: Ariel Elior <ariel.elior@qlogic.com>
16  * Written by: Vladislav Zolotarov
17  *
18  */
19 #ifndef BNX2X_SP_VERBS
20 #define BNX2X_SP_VERBS
21 
22 struct bnx2x;
23 struct eth_context;
24 
25 /* Bits representing general command's configuration */
26 enum {
27 	RAMROD_TX,
28 	RAMROD_RX,
29 	/* Wait until all pending commands complete */
30 	RAMROD_COMP_WAIT,
31 	/* Don't send a ramrod, only update a registry */
32 	RAMROD_DRV_CLR_ONLY,
33 	/* Configure HW according to the current object state */
34 	RAMROD_RESTORE,
35 	 /* Execute the next command now */
36 	RAMROD_EXEC,
37 	/* Don't add a new command and continue execution of postponed
38 	 * commands. If not set a new command will be added to the
39 	 * pending commands list.
40 	 */
41 	RAMROD_CONT,
42 	/* If there is another pending ramrod, wait until it finishes and
43 	 * re-try to submit this one. This flag can be set only in sleepable
44 	 * context, and should not be set from the context that completes the
45 	 * ramrods as deadlock will occur.
46 	 */
47 	RAMROD_RETRY,
48 };
49 
50 typedef enum {
51 	BNX2X_OBJ_TYPE_RX,
52 	BNX2X_OBJ_TYPE_TX,
53 	BNX2X_OBJ_TYPE_RX_TX,
54 } bnx2x_obj_type;
55 
56 /* Public slow path states */
57 enum {
58 	BNX2X_FILTER_MAC_PENDING,
59 	BNX2X_FILTER_VLAN_PENDING,
60 	BNX2X_FILTER_VLAN_MAC_PENDING,
61 	BNX2X_FILTER_RX_MODE_PENDING,
62 	BNX2X_FILTER_RX_MODE_SCHED,
63 	BNX2X_FILTER_ISCSI_ETH_START_SCHED,
64 	BNX2X_FILTER_ISCSI_ETH_STOP_SCHED,
65 	BNX2X_FILTER_FCOE_ETH_START_SCHED,
66 	BNX2X_FILTER_FCOE_ETH_STOP_SCHED,
67 	BNX2X_FILTER_MCAST_PENDING,
68 	BNX2X_FILTER_MCAST_SCHED,
69 	BNX2X_FILTER_RSS_CONF_PENDING,
70 	BNX2X_AFEX_FCOE_Q_UPDATE_PENDING,
71 	BNX2X_AFEX_PENDING_VIFSET_MCP_ACK
72 };
73 
74 struct bnx2x_raw_obj {
75 	u8		func_id;
76 
77 	/* Queue params */
78 	u8		cl_id;
79 	u32		cid;
80 
81 	/* Ramrod data buffer params */
82 	void		*rdata;
83 	dma_addr_t	rdata_mapping;
84 
85 	/* Ramrod state params */
86 	int		state;   /* "ramrod is pending" state bit */
87 	unsigned long	*pstate; /* pointer to state buffer */
88 
89 	bnx2x_obj_type	obj_type;
90 
91 	int (*wait_comp)(struct bnx2x *bp,
92 			 struct bnx2x_raw_obj *o);
93 
94 	bool (*check_pending)(struct bnx2x_raw_obj *o);
95 	void (*clear_pending)(struct bnx2x_raw_obj *o);
96 	void (*set_pending)(struct bnx2x_raw_obj *o);
97 };
98 
99 /************************* VLAN-MAC commands related parameters ***************/
100 struct bnx2x_mac_ramrod_data {
101 	u8 mac[ETH_ALEN];
102 	u8 is_inner_mac;
103 };
104 
105 struct bnx2x_vlan_ramrod_data {
106 	u16 vlan;
107 };
108 
109 struct bnx2x_vlan_mac_ramrod_data {
110 	u8 mac[ETH_ALEN];
111 	u8 is_inner_mac;
112 	u16 vlan;
113 };
114 
115 union bnx2x_classification_ramrod_data {
116 	struct bnx2x_mac_ramrod_data mac;
117 	struct bnx2x_vlan_ramrod_data vlan;
118 	struct bnx2x_vlan_mac_ramrod_data vlan_mac;
119 };
120 
121 /* VLAN_MAC commands */
122 enum bnx2x_vlan_mac_cmd {
123 	BNX2X_VLAN_MAC_ADD,
124 	BNX2X_VLAN_MAC_DEL,
125 	BNX2X_VLAN_MAC_MOVE,
126 };
127 
128 struct bnx2x_vlan_mac_data {
129 	/* Requested command: BNX2X_VLAN_MAC_XX */
130 	enum bnx2x_vlan_mac_cmd cmd;
131 	/* used to contain the data related vlan_mac_flags bits from
132 	 * ramrod parameters.
133 	 */
134 	unsigned long vlan_mac_flags;
135 
136 	/* Needed for MOVE command */
137 	struct bnx2x_vlan_mac_obj *target_obj;
138 
139 	union bnx2x_classification_ramrod_data u;
140 };
141 
142 /*************************** Exe Queue obj ************************************/
143 union bnx2x_exe_queue_cmd_data {
144 	struct bnx2x_vlan_mac_data vlan_mac;
145 
146 	struct {
147 		/* TODO */
148 	} mcast;
149 };
150 
151 struct bnx2x_exeq_elem {
152 	struct list_head		link;
153 
154 	/* Length of this element in the exe_chunk. */
155 	int				cmd_len;
156 
157 	union bnx2x_exe_queue_cmd_data	cmd_data;
158 };
159 
160 union bnx2x_qable_obj;
161 
162 union bnx2x_exeq_comp_elem {
163 	union event_ring_elem *elem;
164 };
165 
166 struct bnx2x_exe_queue_obj;
167 
168 typedef int (*exe_q_validate)(struct bnx2x *bp,
169 			      union bnx2x_qable_obj *o,
170 			      struct bnx2x_exeq_elem *elem);
171 
172 typedef int (*exe_q_remove)(struct bnx2x *bp,
173 			    union bnx2x_qable_obj *o,
174 			    struct bnx2x_exeq_elem *elem);
175 
176 /* Return positive if entry was optimized, 0 - if not, negative
177  * in case of an error.
178  */
179 typedef int (*exe_q_optimize)(struct bnx2x *bp,
180 			      union bnx2x_qable_obj *o,
181 			      struct bnx2x_exeq_elem *elem);
182 typedef int (*exe_q_execute)(struct bnx2x *bp,
183 			     union bnx2x_qable_obj *o,
184 			     struct list_head *exe_chunk,
185 			     unsigned long *ramrod_flags);
186 typedef struct bnx2x_exeq_elem *
187 			(*exe_q_get)(struct bnx2x_exe_queue_obj *o,
188 				     struct bnx2x_exeq_elem *elem);
189 
190 struct bnx2x_exe_queue_obj {
191 	/* Commands pending for an execution. */
192 	struct list_head	exe_queue;
193 
194 	/* Commands pending for an completion. */
195 	struct list_head	pending_comp;
196 
197 	spinlock_t		lock;
198 
199 	/* Maximum length of commands' list for one execution */
200 	int			exe_chunk_len;
201 
202 	union bnx2x_qable_obj	*owner;
203 
204 	/****** Virtual functions ******/
205 	/**
206 	 * Called before commands execution for commands that are really
207 	 * going to be executed (after 'optimize').
208 	 *
209 	 * Must run under exe_queue->lock
210 	 */
211 	exe_q_validate		validate;
212 
213 	/**
214 	 * Called before removing pending commands, cleaning allocated
215 	 * resources (e.g., credits from validate)
216 	 */
217 	 exe_q_remove		remove;
218 
219 	/**
220 	 * This will try to cancel the current pending commands list
221 	 * considering the new command.
222 	 *
223 	 * Returns the number of optimized commands or a negative error code
224 	 *
225 	 * Must run under exe_queue->lock
226 	 */
227 	exe_q_optimize		optimize;
228 
229 	/**
230 	 * Run the next commands chunk (owner specific).
231 	 */
232 	exe_q_execute		execute;
233 
234 	/**
235 	 * Return the exe_queue element containing the specific command
236 	 * if any. Otherwise return NULL.
237 	 */
238 	exe_q_get		get;
239 };
240 /***************** Classification verbs: Set/Del MAC/VLAN/VLAN-MAC ************/
241 /*
242  * Element in the VLAN_MAC registry list having all currently configured
243  * rules.
244  */
245 struct bnx2x_vlan_mac_registry_elem {
246 	struct list_head	link;
247 
248 	/* Used to store the cam offset used for the mac/vlan/vlan-mac.
249 	 * Relevant for 57710 and 57711 only. VLANs and MACs share the
250 	 * same CAM for these chips.
251 	 */
252 	int			cam_offset;
253 
254 	/* Needed for DEL and RESTORE flows */
255 	unsigned long		vlan_mac_flags;
256 
257 	union bnx2x_classification_ramrod_data u;
258 };
259 
260 /* Bits representing VLAN_MAC commands specific flags */
261 enum {
262 	BNX2X_UC_LIST_MAC,
263 	BNX2X_ETH_MAC,
264 	BNX2X_ISCSI_ETH_MAC,
265 	BNX2X_NETQ_ETH_MAC,
266 	BNX2X_DONT_CONSUME_CAM_CREDIT,
267 	BNX2X_DONT_CONSUME_CAM_CREDIT_DEST,
268 };
269 /* When looking for matching filters, some flags are not interesting */
270 #define BNX2X_VLAN_MAC_CMP_MASK	(1 << BNX2X_UC_LIST_MAC | \
271 				 1 << BNX2X_ETH_MAC | \
272 				 1 << BNX2X_ISCSI_ETH_MAC | \
273 				 1 << BNX2X_NETQ_ETH_MAC)
274 #define BNX2X_VLAN_MAC_CMP_FLAGS(flags) \
275 	((flags) & BNX2X_VLAN_MAC_CMP_MASK)
276 
277 struct bnx2x_vlan_mac_ramrod_params {
278 	/* Object to run the command from */
279 	struct bnx2x_vlan_mac_obj *vlan_mac_obj;
280 
281 	/* General command flags: COMP_WAIT, etc. */
282 	unsigned long ramrod_flags;
283 
284 	/* Command specific configuration request */
285 	struct bnx2x_vlan_mac_data user_req;
286 };
287 
288 struct bnx2x_vlan_mac_obj {
289 	struct bnx2x_raw_obj raw;
290 
291 	/* Bookkeeping list: will prevent the addition of already existing
292 	 * entries.
293 	 */
294 	struct list_head		head;
295 	/* Implement a simple reader/writer lock on the head list.
296 	 * all these fields should only be accessed under the exe_queue lock
297 	 */
298 	u8		head_reader; /* Num. of readers accessing head list */
299 	bool		head_exe_request; /* Pending execution request. */
300 	unsigned long	saved_ramrod_flags; /* Ramrods of pending execution */
301 
302 	/* TODO: Add it's initialization in the init functions */
303 	struct bnx2x_exe_queue_obj	exe_queue;
304 
305 	/* MACs credit pool */
306 	struct bnx2x_credit_pool_obj	*macs_pool;
307 
308 	/* VLANs credit pool */
309 	struct bnx2x_credit_pool_obj	*vlans_pool;
310 
311 	/* RAMROD command to be used */
312 	int				ramrod_cmd;
313 
314 	/* copy first n elements onto preallocated buffer
315 	 *
316 	 * @param n number of elements to get
317 	 * @param buf buffer preallocated by caller into which elements
318 	 *            will be copied. Note elements are 4-byte aligned
319 	 *            so buffer size must be able to accommodate the
320 	 *            aligned elements.
321 	 *
322 	 * @return number of copied bytes
323 	 */
324 	int (*get_n_elements)(struct bnx2x *bp,
325 			      struct bnx2x_vlan_mac_obj *o, int n, u8 *base,
326 			      u8 stride, u8 size);
327 
328 	/**
329 	 * Checks if ADD-ramrod with the given params may be performed.
330 	 *
331 	 * @return zero if the element may be added
332 	 */
333 
334 	int (*check_add)(struct bnx2x *bp,
335 			 struct bnx2x_vlan_mac_obj *o,
336 			 union bnx2x_classification_ramrod_data *data);
337 
338 	/**
339 	 * Checks if DEL-ramrod with the given params may be performed.
340 	 *
341 	 * @return true if the element may be deleted
342 	 */
343 	struct bnx2x_vlan_mac_registry_elem *
344 		(*check_del)(struct bnx2x *bp,
345 			     struct bnx2x_vlan_mac_obj *o,
346 			     union bnx2x_classification_ramrod_data *data);
347 
348 	/**
349 	 * Checks if DEL-ramrod with the given params may be performed.
350 	 *
351 	 * @return true if the element may be deleted
352 	 */
353 	bool (*check_move)(struct bnx2x *bp,
354 			   struct bnx2x_vlan_mac_obj *src_o,
355 			   struct bnx2x_vlan_mac_obj *dst_o,
356 			   union bnx2x_classification_ramrod_data *data);
357 
358 	/**
359 	 *  Update the relevant credit object(s) (consume/return
360 	 *  correspondingly).
361 	 */
362 	bool (*get_credit)(struct bnx2x_vlan_mac_obj *o);
363 	bool (*put_credit)(struct bnx2x_vlan_mac_obj *o);
364 	bool (*get_cam_offset)(struct bnx2x_vlan_mac_obj *o, int *offset);
365 	bool (*put_cam_offset)(struct bnx2x_vlan_mac_obj *o, int offset);
366 
367 	/**
368 	 * Configures one rule in the ramrod data buffer.
369 	 */
370 	void (*set_one_rule)(struct bnx2x *bp,
371 			     struct bnx2x_vlan_mac_obj *o,
372 			     struct bnx2x_exeq_elem *elem, int rule_idx,
373 			     int cam_offset);
374 
375 	/**
376 	*  Delete all configured elements having the given
377 	*  vlan_mac_flags specification. Assumes no pending for
378 	*  execution commands. Will schedule all all currently
379 	*  configured MACs/VLANs/VLAN-MACs matching the vlan_mac_flags
380 	*  specification for deletion and will use the given
381 	*  ramrod_flags for the last DEL operation.
382 	 *
383 	 * @param bp
384 	 * @param o
385 	 * @param ramrod_flags RAMROD_XX flags
386 	 *
387 	 * @return 0 if the last operation has completed successfully
388 	 *         and there are no more elements left, positive value
389 	 *         if there are pending for completion commands,
390 	 *         negative value in case of failure.
391 	 */
392 	int (*delete_all)(struct bnx2x *bp,
393 			  struct bnx2x_vlan_mac_obj *o,
394 			  unsigned long *vlan_mac_flags,
395 			  unsigned long *ramrod_flags);
396 
397 	/**
398 	 * Reconfigures the next MAC/VLAN/VLAN-MAC element from the previously
399 	 * configured elements list.
400 	 *
401 	 * @param bp
402 	 * @param p Command parameters (RAMROD_COMP_WAIT bit in
403 	 *          ramrod_flags is only taken into an account)
404 	 * @param ppos a pointer to the cookie that should be given back in the
405 	 *        next call to make function handle the next element. If
406 	 *        *ppos is set to NULL it will restart the iterator.
407 	 *        If returned *ppos == NULL this means that the last
408 	 *        element has been handled.
409 	 *
410 	 * @return int
411 	 */
412 	int (*restore)(struct bnx2x *bp,
413 		       struct bnx2x_vlan_mac_ramrod_params *p,
414 		       struct bnx2x_vlan_mac_registry_elem **ppos);
415 
416 	/**
417 	 * Should be called on a completion arrival.
418 	 *
419 	 * @param bp
420 	 * @param o
421 	 * @param cqe Completion element we are handling
422 	 * @param ramrod_flags if RAMROD_CONT is set the next bulk of
423 	 *		       pending commands will be executed.
424 	 *		       RAMROD_DRV_CLR_ONLY and RAMROD_RESTORE
425 	 *		       may also be set if needed.
426 	 *
427 	 * @return 0 if there are neither pending nor waiting for
428 	 *         completion commands. Positive value if there are
429 	 *         pending for execution or for completion commands.
430 	 *         Negative value in case of an error (including an
431 	 *         error in the cqe).
432 	 */
433 	int (*complete)(struct bnx2x *bp, struct bnx2x_vlan_mac_obj *o,
434 			union event_ring_elem *cqe,
435 			unsigned long *ramrod_flags);
436 
437 	/**
438 	 * Wait for completion of all commands. Don't schedule new ones,
439 	 * just wait. It assumes that the completion code will schedule
440 	 * for new commands.
441 	 */
442 	int (*wait)(struct bnx2x *bp, struct bnx2x_vlan_mac_obj *o);
443 };
444 
445 enum {
446 	BNX2X_LLH_CAM_ISCSI_ETH_LINE = 0,
447 	BNX2X_LLH_CAM_ETH_LINE,
448 	BNX2X_LLH_CAM_MAX_PF_LINE = NIG_REG_LLH1_FUNC_MEM_SIZE / 2
449 };
450 
451 /** RX_MODE verbs:DROP_ALL/ACCEPT_ALL/ACCEPT_ALL_MULTI/ACCEPT_ALL_VLAN/NORMAL */
452 
453 /* RX_MODE ramrod special flags: set in rx_mode_flags field in
454  * a bnx2x_rx_mode_ramrod_params.
455  */
456 enum {
457 	BNX2X_RX_MODE_FCOE_ETH,
458 	BNX2X_RX_MODE_ISCSI_ETH,
459 };
460 
461 enum {
462 	BNX2X_ACCEPT_UNICAST,
463 	BNX2X_ACCEPT_MULTICAST,
464 	BNX2X_ACCEPT_ALL_UNICAST,
465 	BNX2X_ACCEPT_ALL_MULTICAST,
466 	BNX2X_ACCEPT_BROADCAST,
467 	BNX2X_ACCEPT_UNMATCHED,
468 	BNX2X_ACCEPT_ANY_VLAN
469 };
470 
471 struct bnx2x_rx_mode_ramrod_params {
472 	struct bnx2x_rx_mode_obj *rx_mode_obj;
473 	unsigned long *pstate;
474 	int state;
475 	u8 cl_id;
476 	u32 cid;
477 	u8 func_id;
478 	unsigned long ramrod_flags;
479 	unsigned long rx_mode_flags;
480 
481 	/* rdata is either a pointer to eth_filter_rules_ramrod_data(e2) or to
482 	 * a tstorm_eth_mac_filter_config (e1x).
483 	 */
484 	void *rdata;
485 	dma_addr_t rdata_mapping;
486 
487 	/* Rx mode settings */
488 	unsigned long rx_accept_flags;
489 
490 	/* internal switching settings */
491 	unsigned long tx_accept_flags;
492 };
493 
494 struct bnx2x_rx_mode_obj {
495 	int (*config_rx_mode)(struct bnx2x *bp,
496 			      struct bnx2x_rx_mode_ramrod_params *p);
497 
498 	int (*wait_comp)(struct bnx2x *bp,
499 			 struct bnx2x_rx_mode_ramrod_params *p);
500 };
501 
502 /********************** Set multicast group ***********************************/
503 
504 struct bnx2x_mcast_list_elem {
505 	struct list_head link;
506 	u8 *mac;
507 };
508 
509 union bnx2x_mcast_config_data {
510 	u8 *mac;
511 	u8 bin; /* used in a RESTORE flow */
512 };
513 
514 struct bnx2x_mcast_ramrod_params {
515 	struct bnx2x_mcast_obj *mcast_obj;
516 
517 	/* Relevant options are RAMROD_COMP_WAIT and RAMROD_DRV_CLR_ONLY */
518 	unsigned long ramrod_flags;
519 
520 	struct list_head mcast_list; /* list of struct bnx2x_mcast_list_elem */
521 	/** TODO:
522 	 *      - rename it to macs_num.
523 	 *      - Add a new command type for handling pending commands
524 	 *        (remove "zero semantics").
525 	 *
526 	 *  Length of mcast_list. If zero and ADD_CONT command - post
527 	 *  pending commands.
528 	 */
529 	int mcast_list_len;
530 };
531 
532 enum bnx2x_mcast_cmd {
533 	BNX2X_MCAST_CMD_ADD,
534 	BNX2X_MCAST_CMD_CONT,
535 	BNX2X_MCAST_CMD_DEL,
536 	BNX2X_MCAST_CMD_RESTORE,
537 };
538 
539 struct bnx2x_mcast_obj {
540 	struct bnx2x_raw_obj raw;
541 
542 	union {
543 		struct {
544 		#define BNX2X_MCAST_BINS_NUM	256
545 		#define BNX2X_MCAST_VEC_SZ	(BNX2X_MCAST_BINS_NUM / 64)
546 			u64 vec[BNX2X_MCAST_VEC_SZ];
547 
548 			/** Number of BINs to clear. Should be updated
549 			 *  immediately when a command arrives in order to
550 			 *  properly create DEL commands.
551 			 */
552 			int num_bins_set;
553 		} aprox_match;
554 
555 		struct {
556 			struct list_head macs;
557 			int num_macs_set;
558 		} exact_match;
559 	} registry;
560 
561 	/* Pending commands */
562 	struct list_head pending_cmds_head;
563 
564 	/* A state that is set in raw.pstate, when there are pending commands */
565 	int sched_state;
566 
567 	/* Maximal number of mcast MACs configured in one command */
568 	int max_cmd_len;
569 
570 	/* Total number of currently pending MACs to configure: both
571 	 * in the pending commands list and in the current command.
572 	 */
573 	int total_pending_num;
574 
575 	u8 engine_id;
576 
577 	/**
578 	 * @param cmd command to execute (BNX2X_MCAST_CMD_X, see above)
579 	 */
580 	int (*config_mcast)(struct bnx2x *bp,
581 			    struct bnx2x_mcast_ramrod_params *p,
582 			    enum bnx2x_mcast_cmd cmd);
583 
584 	/**
585 	 * Fills the ramrod data during the RESTORE flow.
586 	 *
587 	 * @param bp
588 	 * @param o
589 	 * @param start_idx Registry index to start from
590 	 * @param rdata_idx Index in the ramrod data to start from
591 	 *
592 	 * @return -1 if we handled the whole registry or index of the last
593 	 *         handled registry element.
594 	 */
595 	int (*hdl_restore)(struct bnx2x *bp, struct bnx2x_mcast_obj *o,
596 			   int start_bin, int *rdata_idx);
597 
598 	int (*enqueue_cmd)(struct bnx2x *bp, struct bnx2x_mcast_obj *o,
599 			   struct bnx2x_mcast_ramrod_params *p,
600 			   enum bnx2x_mcast_cmd cmd);
601 
602 	void (*set_one_rule)(struct bnx2x *bp,
603 			     struct bnx2x_mcast_obj *o, int idx,
604 			     union bnx2x_mcast_config_data *cfg_data,
605 			     enum bnx2x_mcast_cmd cmd);
606 
607 	/** Checks if there are more mcast MACs to be set or a previous
608 	 *  command is still pending.
609 	 */
610 	bool (*check_pending)(struct bnx2x_mcast_obj *o);
611 
612 	/**
613 	 * Set/Clear/Check SCHEDULED state of the object
614 	 */
615 	void (*set_sched)(struct bnx2x_mcast_obj *o);
616 	void (*clear_sched)(struct bnx2x_mcast_obj *o);
617 	bool (*check_sched)(struct bnx2x_mcast_obj *o);
618 
619 	/* Wait until all pending commands complete */
620 	int (*wait_comp)(struct bnx2x *bp, struct bnx2x_mcast_obj *o);
621 
622 	/**
623 	 * Handle the internal object counters needed for proper
624 	 * commands handling. Checks that the provided parameters are
625 	 * feasible.
626 	 */
627 	int (*validate)(struct bnx2x *bp,
628 			struct bnx2x_mcast_ramrod_params *p,
629 			enum bnx2x_mcast_cmd cmd);
630 
631 	/**
632 	 * Restore the values of internal counters in case of a failure.
633 	 */
634 	void (*revert)(struct bnx2x *bp,
635 		       struct bnx2x_mcast_ramrod_params *p,
636 		       int old_num_bins);
637 
638 	int (*get_registry_size)(struct bnx2x_mcast_obj *o);
639 	void (*set_registry_size)(struct bnx2x_mcast_obj *o, int n);
640 };
641 
642 /*************************** Credit handling **********************************/
643 struct bnx2x_credit_pool_obj {
644 
645 	/* Current amount of credit in the pool */
646 	atomic_t	credit;
647 
648 	/* Maximum allowed credit. put() will check against it. */
649 	int		pool_sz;
650 
651 	/* Allocate a pool table statically.
652 	 *
653 	 * Currently the maximum allowed size is MAX_MAC_CREDIT_E2(272)
654 	 *
655 	 * The set bit in the table will mean that the entry is available.
656 	 */
657 #define BNX2X_POOL_VEC_SIZE	(MAX_MAC_CREDIT_E2 / 64)
658 	u64		pool_mirror[BNX2X_POOL_VEC_SIZE];
659 
660 	/* Base pool offset (initialized differently */
661 	int		base_pool_offset;
662 
663 	/**
664 	 * Get the next free pool entry.
665 	 *
666 	 * @return true if there was a free entry in the pool
667 	 */
668 	bool (*get_entry)(struct bnx2x_credit_pool_obj *o, int *entry);
669 
670 	/**
671 	 * Return the entry back to the pool.
672 	 *
673 	 * @return true if entry is legal and has been successfully
674 	 *         returned to the pool.
675 	 */
676 	bool (*put_entry)(struct bnx2x_credit_pool_obj *o, int entry);
677 
678 	/**
679 	 * Get the requested amount of credit from the pool.
680 	 *
681 	 * @param cnt Amount of requested credit
682 	 * @return true if the operation is successful
683 	 */
684 	bool (*get)(struct bnx2x_credit_pool_obj *o, int cnt);
685 
686 	/**
687 	 * Returns the credit to the pool.
688 	 *
689 	 * @param cnt Amount of credit to return
690 	 * @return true if the operation is successful
691 	 */
692 	bool (*put)(struct bnx2x_credit_pool_obj *o, int cnt);
693 
694 	/**
695 	 * Reads the current amount of credit.
696 	 */
697 	int (*check)(struct bnx2x_credit_pool_obj *o);
698 };
699 
700 /*************************** RSS configuration ********************************/
701 enum {
702 	/* RSS_MODE bits are mutually exclusive */
703 	BNX2X_RSS_MODE_DISABLED,
704 	BNX2X_RSS_MODE_REGULAR,
705 
706 	BNX2X_RSS_SET_SRCH, /* Setup searcher, E1x specific flag */
707 
708 	BNX2X_RSS_IPV4,
709 	BNX2X_RSS_IPV4_TCP,
710 	BNX2X_RSS_IPV4_UDP,
711 	BNX2X_RSS_IPV6,
712 	BNX2X_RSS_IPV6_TCP,
713 	BNX2X_RSS_IPV6_UDP,
714 	BNX2X_RSS_GRE_INNER_HDRS,
715 };
716 
717 struct bnx2x_config_rss_params {
718 	struct bnx2x_rss_config_obj *rss_obj;
719 
720 	/* may have RAMROD_COMP_WAIT set only */
721 	unsigned long	ramrod_flags;
722 
723 	/* BNX2X_RSS_X bits */
724 	unsigned long	rss_flags;
725 
726 	/* Number hash bits to take into an account */
727 	u8		rss_result_mask;
728 
729 	/* Indirection table */
730 	u8		ind_table[T_ETH_INDIRECTION_TABLE_SIZE];
731 
732 	/* RSS hash values */
733 	u32		rss_key[10];
734 
735 	/* valid only iff BNX2X_RSS_UPDATE_TOE is set */
736 	u16		toe_rss_bitmap;
737 };
738 
739 struct bnx2x_rss_config_obj {
740 	struct bnx2x_raw_obj	raw;
741 
742 	/* RSS engine to use */
743 	u8			engine_id;
744 
745 	/* Last configured indirection table */
746 	u8			ind_table[T_ETH_INDIRECTION_TABLE_SIZE];
747 
748 	/* flags for enabling 4-tupple hash on UDP */
749 	u8			udp_rss_v4;
750 	u8			udp_rss_v6;
751 
752 	int (*config_rss)(struct bnx2x *bp,
753 			  struct bnx2x_config_rss_params *p);
754 };
755 
756 /*********************** Queue state update ***********************************/
757 
758 /* UPDATE command options */
759 enum {
760 	BNX2X_Q_UPDATE_IN_VLAN_REM,
761 	BNX2X_Q_UPDATE_IN_VLAN_REM_CHNG,
762 	BNX2X_Q_UPDATE_OUT_VLAN_REM,
763 	BNX2X_Q_UPDATE_OUT_VLAN_REM_CHNG,
764 	BNX2X_Q_UPDATE_ANTI_SPOOF,
765 	BNX2X_Q_UPDATE_ANTI_SPOOF_CHNG,
766 	BNX2X_Q_UPDATE_ACTIVATE,
767 	BNX2X_Q_UPDATE_ACTIVATE_CHNG,
768 	BNX2X_Q_UPDATE_DEF_VLAN_EN,
769 	BNX2X_Q_UPDATE_DEF_VLAN_EN_CHNG,
770 	BNX2X_Q_UPDATE_SILENT_VLAN_REM_CHNG,
771 	BNX2X_Q_UPDATE_SILENT_VLAN_REM,
772 	BNX2X_Q_UPDATE_TX_SWITCHING_CHNG,
773 	BNX2X_Q_UPDATE_TX_SWITCHING,
774 	BNX2X_Q_UPDATE_PTP_PKTS_CHNG,
775 	BNX2X_Q_UPDATE_PTP_PKTS,
776 };
777 
778 /* Allowed Queue states */
779 enum bnx2x_q_state {
780 	BNX2X_Q_STATE_RESET,
781 	BNX2X_Q_STATE_INITIALIZED,
782 	BNX2X_Q_STATE_ACTIVE,
783 	BNX2X_Q_STATE_MULTI_COS,
784 	BNX2X_Q_STATE_MCOS_TERMINATED,
785 	BNX2X_Q_STATE_INACTIVE,
786 	BNX2X_Q_STATE_STOPPED,
787 	BNX2X_Q_STATE_TERMINATED,
788 	BNX2X_Q_STATE_FLRED,
789 	BNX2X_Q_STATE_MAX,
790 };
791 
792 /* Allowed Queue states */
793 enum bnx2x_q_logical_state {
794 	BNX2X_Q_LOGICAL_STATE_ACTIVE,
795 	BNX2X_Q_LOGICAL_STATE_STOPPED,
796 };
797 
798 /* Allowed commands */
799 enum bnx2x_queue_cmd {
800 	BNX2X_Q_CMD_INIT,
801 	BNX2X_Q_CMD_SETUP,
802 	BNX2X_Q_CMD_SETUP_TX_ONLY,
803 	BNX2X_Q_CMD_DEACTIVATE,
804 	BNX2X_Q_CMD_ACTIVATE,
805 	BNX2X_Q_CMD_UPDATE,
806 	BNX2X_Q_CMD_UPDATE_TPA,
807 	BNX2X_Q_CMD_HALT,
808 	BNX2X_Q_CMD_CFC_DEL,
809 	BNX2X_Q_CMD_TERMINATE,
810 	BNX2X_Q_CMD_EMPTY,
811 	BNX2X_Q_CMD_MAX,
812 };
813 
814 /* queue SETUP + INIT flags */
815 enum {
816 	BNX2X_Q_FLG_TPA,
817 	BNX2X_Q_FLG_TPA_IPV6,
818 	BNX2X_Q_FLG_TPA_GRO,
819 	BNX2X_Q_FLG_STATS,
820 	BNX2X_Q_FLG_ZERO_STATS,
821 	BNX2X_Q_FLG_ACTIVE,
822 	BNX2X_Q_FLG_OV,
823 	BNX2X_Q_FLG_VLAN,
824 	BNX2X_Q_FLG_COS,
825 	BNX2X_Q_FLG_HC,
826 	BNX2X_Q_FLG_HC_EN,
827 	BNX2X_Q_FLG_DHC,
828 	BNX2X_Q_FLG_FCOE,
829 	BNX2X_Q_FLG_LEADING_RSS,
830 	BNX2X_Q_FLG_MCAST,
831 	BNX2X_Q_FLG_DEF_VLAN,
832 	BNX2X_Q_FLG_TX_SWITCH,
833 	BNX2X_Q_FLG_TX_SEC,
834 	BNX2X_Q_FLG_ANTI_SPOOF,
835 	BNX2X_Q_FLG_SILENT_VLAN_REM,
836 	BNX2X_Q_FLG_FORCE_DEFAULT_PRI,
837 	BNX2X_Q_FLG_REFUSE_OUTBAND_VLAN,
838 	BNX2X_Q_FLG_PCSUM_ON_PKT,
839 	BNX2X_Q_FLG_TUN_INC_INNER_IP_ID
840 };
841 
842 /* Queue type options: queue type may be a combination of below. */
843 enum bnx2x_q_type {
844 	/** TODO: Consider moving both these flags into the init()
845 	 *        ramrod params.
846 	 */
847 	BNX2X_Q_TYPE_HAS_RX,
848 	BNX2X_Q_TYPE_HAS_TX,
849 };
850 
851 #define BNX2X_PRIMARY_CID_INDEX			0
852 #define BNX2X_MULTI_TX_COS_E1X			3 /* QM only */
853 #define BNX2X_MULTI_TX_COS_E2_E3A0		2
854 #define BNX2X_MULTI_TX_COS_E3B0			3
855 #define BNX2X_MULTI_TX_COS			3 /* Maximum possible */
856 
857 #define MAC_PAD (ALIGN(ETH_ALEN, sizeof(u32)) - ETH_ALEN)
858 /* DMAE channel to be used by FW for timesync workaroun. A driver that sends
859  * timesync-related ramrods must not use this DMAE command ID.
860  */
861 #define FW_DMAE_CMD_ID 6
862 
863 struct bnx2x_queue_init_params {
864 	struct {
865 		unsigned long	flags;
866 		u16		hc_rate;
867 		u8		fw_sb_id;
868 		u8		sb_cq_index;
869 	} tx;
870 
871 	struct {
872 		unsigned long	flags;
873 		u16		hc_rate;
874 		u8		fw_sb_id;
875 		u8		sb_cq_index;
876 	} rx;
877 
878 	/* CID context in the host memory */
879 	struct eth_context *cxts[BNX2X_MULTI_TX_COS];
880 
881 	/* maximum number of cos supported by hardware */
882 	u8 max_cos;
883 };
884 
885 struct bnx2x_queue_terminate_params {
886 	/* index within the tx_only cids of this queue object */
887 	u8 cid_index;
888 };
889 
890 struct bnx2x_queue_cfc_del_params {
891 	/* index within the tx_only cids of this queue object */
892 	u8 cid_index;
893 };
894 
895 struct bnx2x_queue_update_params {
896 	unsigned long	update_flags; /* BNX2X_Q_UPDATE_XX bits */
897 	u16		def_vlan;
898 	u16		silent_removal_value;
899 	u16		silent_removal_mask;
900 /* index within the tx_only cids of this queue object */
901 	u8		cid_index;
902 };
903 
904 struct bnx2x_queue_update_tpa_params {
905 	dma_addr_t sge_map;
906 	u8 update_ipv4;
907 	u8 update_ipv6;
908 	u8 max_tpa_queues;
909 	u8 max_sges_pkt;
910 	u8 complete_on_both_clients;
911 	u8 dont_verify_thr;
912 	u8 tpa_mode;
913 	u8 _pad;
914 
915 	u16 sge_buff_sz;
916 	u16 max_agg_sz;
917 
918 	u16 sge_pause_thr_low;
919 	u16 sge_pause_thr_high;
920 };
921 
922 struct rxq_pause_params {
923 	u16		bd_th_lo;
924 	u16		bd_th_hi;
925 	u16		rcq_th_lo;
926 	u16		rcq_th_hi;
927 	u16		sge_th_lo; /* valid iff BNX2X_Q_FLG_TPA */
928 	u16		sge_th_hi; /* valid iff BNX2X_Q_FLG_TPA */
929 	u16		pri_map;
930 };
931 
932 /* general */
933 struct bnx2x_general_setup_params {
934 	/* valid iff BNX2X_Q_FLG_STATS */
935 	u8		stat_id;
936 
937 	u8		spcl_id;
938 	u16		mtu;
939 	u8		cos;
940 };
941 
942 struct bnx2x_rxq_setup_params {
943 	/* dma */
944 	dma_addr_t	dscr_map;
945 	dma_addr_t	sge_map;
946 	dma_addr_t	rcq_map;
947 	dma_addr_t	rcq_np_map;
948 
949 	u16		drop_flags;
950 	u16		buf_sz;
951 	u8		fw_sb_id;
952 	u8		cl_qzone_id;
953 
954 	/* valid iff BNX2X_Q_FLG_TPA */
955 	u16		tpa_agg_sz;
956 	u16		sge_buf_sz;
957 	u8		max_sges_pkt;
958 	u8		max_tpa_queues;
959 	u8		rss_engine_id;
960 
961 	/* valid iff BNX2X_Q_FLG_MCAST */
962 	u8		mcast_engine_id;
963 
964 	u8		cache_line_log;
965 
966 	u8		sb_cq_index;
967 
968 	/* valid iff BXN2X_Q_FLG_SILENT_VLAN_REM */
969 	u16 silent_removal_value;
970 	u16 silent_removal_mask;
971 };
972 
973 struct bnx2x_txq_setup_params {
974 	/* dma */
975 	dma_addr_t	dscr_map;
976 
977 	u8		fw_sb_id;
978 	u8		sb_cq_index;
979 	u8		cos;		/* valid iff BNX2X_Q_FLG_COS */
980 	u16		traffic_type;
981 	/* equals to the leading rss client id, used for TX classification*/
982 	u8		tss_leading_cl_id;
983 
984 	/* valid iff BNX2X_Q_FLG_DEF_VLAN */
985 	u16		default_vlan;
986 };
987 
988 struct bnx2x_queue_setup_params {
989 	struct bnx2x_general_setup_params gen_params;
990 	struct bnx2x_txq_setup_params txq_params;
991 	struct bnx2x_rxq_setup_params rxq_params;
992 	struct rxq_pause_params pause_params;
993 	unsigned long flags;
994 };
995 
996 struct bnx2x_queue_setup_tx_only_params {
997 	struct bnx2x_general_setup_params	gen_params;
998 	struct bnx2x_txq_setup_params		txq_params;
999 	unsigned long				flags;
1000 	/* index within the tx_only cids of this queue object */
1001 	u8					cid_index;
1002 };
1003 
1004 struct bnx2x_queue_state_params {
1005 	struct bnx2x_queue_sp_obj *q_obj;
1006 
1007 	/* Current command */
1008 	enum bnx2x_queue_cmd cmd;
1009 
1010 	/* may have RAMROD_COMP_WAIT set only */
1011 	unsigned long ramrod_flags;
1012 
1013 	/* Params according to the current command */
1014 	union {
1015 		struct bnx2x_queue_update_params	update;
1016 		struct bnx2x_queue_update_tpa_params    update_tpa;
1017 		struct bnx2x_queue_setup_params		setup;
1018 		struct bnx2x_queue_init_params		init;
1019 		struct bnx2x_queue_setup_tx_only_params	tx_only;
1020 		struct bnx2x_queue_terminate_params	terminate;
1021 		struct bnx2x_queue_cfc_del_params	cfc_del;
1022 	} params;
1023 };
1024 
1025 struct bnx2x_viflist_params {
1026 	u8 echo_res;
1027 	u8 func_bit_map_res;
1028 };
1029 
1030 struct bnx2x_queue_sp_obj {
1031 	u32		cids[BNX2X_MULTI_TX_COS];
1032 	u8		cl_id;
1033 	u8		func_id;
1034 
1035 	/* number of traffic classes supported by queue.
1036 	 * The primary connection of the queue supports the first traffic
1037 	 * class. Any further traffic class is supported by a tx-only
1038 	 * connection.
1039 	 *
1040 	 * Therefore max_cos is also a number of valid entries in the cids
1041 	 * array.
1042 	 */
1043 	u8 max_cos;
1044 	u8 num_tx_only, next_tx_only;
1045 
1046 	enum bnx2x_q_state state, next_state;
1047 
1048 	/* bits from enum bnx2x_q_type */
1049 	unsigned long	type;
1050 
1051 	/* BNX2X_Q_CMD_XX bits. This object implements "one
1052 	 * pending" paradigm but for debug and tracing purposes it's
1053 	 * more convenient to have different bits for different
1054 	 * commands.
1055 	 */
1056 	unsigned long	pending;
1057 
1058 	/* Buffer to use as a ramrod data and its mapping */
1059 	void		*rdata;
1060 	dma_addr_t	rdata_mapping;
1061 
1062 	/**
1063 	 * Performs one state change according to the given parameters.
1064 	 *
1065 	 * @return 0 in case of success and negative value otherwise.
1066 	 */
1067 	int (*send_cmd)(struct bnx2x *bp,
1068 			struct bnx2x_queue_state_params *params);
1069 
1070 	/**
1071 	 * Sets the pending bit according to the requested transition.
1072 	 */
1073 	int (*set_pending)(struct bnx2x_queue_sp_obj *o,
1074 			   struct bnx2x_queue_state_params *params);
1075 
1076 	/**
1077 	 * Checks that the requested state transition is legal.
1078 	 */
1079 	int (*check_transition)(struct bnx2x *bp,
1080 				struct bnx2x_queue_sp_obj *o,
1081 				struct bnx2x_queue_state_params *params);
1082 
1083 	/**
1084 	 * Completes the pending command.
1085 	 */
1086 	int (*complete_cmd)(struct bnx2x *bp,
1087 			    struct bnx2x_queue_sp_obj *o,
1088 			    enum bnx2x_queue_cmd);
1089 
1090 	int (*wait_comp)(struct bnx2x *bp,
1091 			 struct bnx2x_queue_sp_obj *o,
1092 			 enum bnx2x_queue_cmd cmd);
1093 };
1094 
1095 /********************** Function state update *********************************/
1096 
1097 /* UPDATE command options */
1098 enum {
1099 	BNX2X_F_UPDATE_TX_SWITCH_SUSPEND_CHNG,
1100 	BNX2X_F_UPDATE_TX_SWITCH_SUSPEND,
1101 	BNX2X_F_UPDATE_SD_VLAN_TAG_CHNG,
1102 	BNX2X_F_UPDATE_SD_VLAN_ETH_TYPE_CHNG,
1103 	BNX2X_F_UPDATE_VLAN_FORCE_PRIO_CHNG,
1104 	BNX2X_F_UPDATE_VLAN_FORCE_PRIO_FLAG,
1105 	BNX2X_F_UPDATE_TUNNEL_CFG_CHNG,
1106 	BNX2X_F_UPDATE_TUNNEL_CLSS_EN,
1107 	BNX2X_F_UPDATE_TUNNEL_INNER_GRE_RSS_EN,
1108 };
1109 
1110 /* Allowed Function states */
1111 enum bnx2x_func_state {
1112 	BNX2X_F_STATE_RESET,
1113 	BNX2X_F_STATE_INITIALIZED,
1114 	BNX2X_F_STATE_STARTED,
1115 	BNX2X_F_STATE_TX_STOPPED,
1116 	BNX2X_F_STATE_MAX,
1117 };
1118 
1119 /* Allowed Function commands */
1120 enum bnx2x_func_cmd {
1121 	BNX2X_F_CMD_HW_INIT,
1122 	BNX2X_F_CMD_START,
1123 	BNX2X_F_CMD_STOP,
1124 	BNX2X_F_CMD_HW_RESET,
1125 	BNX2X_F_CMD_AFEX_UPDATE,
1126 	BNX2X_F_CMD_AFEX_VIFLISTS,
1127 	BNX2X_F_CMD_TX_STOP,
1128 	BNX2X_F_CMD_TX_START,
1129 	BNX2X_F_CMD_SWITCH_UPDATE,
1130 	BNX2X_F_CMD_SET_TIMESYNC,
1131 	BNX2X_F_CMD_MAX,
1132 };
1133 
1134 struct bnx2x_func_hw_init_params {
1135 	/* A load phase returned by MCP.
1136 	 *
1137 	 * May be:
1138 	 *		FW_MSG_CODE_DRV_LOAD_COMMON_CHIP
1139 	 *		FW_MSG_CODE_DRV_LOAD_COMMON
1140 	 *		FW_MSG_CODE_DRV_LOAD_PORT
1141 	 *		FW_MSG_CODE_DRV_LOAD_FUNCTION
1142 	 */
1143 	u32 load_phase;
1144 };
1145 
1146 struct bnx2x_func_hw_reset_params {
1147 	/* A load phase returned by MCP.
1148 	 *
1149 	 * May be:
1150 	 *		FW_MSG_CODE_DRV_LOAD_COMMON_CHIP
1151 	 *		FW_MSG_CODE_DRV_LOAD_COMMON
1152 	 *		FW_MSG_CODE_DRV_LOAD_PORT
1153 	 *		FW_MSG_CODE_DRV_LOAD_FUNCTION
1154 	 */
1155 	u32 reset_phase;
1156 };
1157 
1158 struct bnx2x_func_start_params {
1159 	/* Multi Function mode:
1160 	 *	- Single Function
1161 	 *	- Switch Dependent
1162 	 *	- Switch Independent
1163 	 */
1164 	u16 mf_mode;
1165 
1166 	/* Switch Dependent mode outer VLAN tag */
1167 	u16 sd_vlan_tag;
1168 
1169 	/* Function cos mode */
1170 	u8 network_cos_mode;
1171 
1172 	/* TUNN_MODE_NONE/TUNN_MODE_VXLAN/TUNN_MODE_GRE */
1173 	u8 tunnel_mode;
1174 
1175 	/* tunneling classification enablement */
1176 	u8 tunn_clss_en;
1177 
1178 	/* NVGRE_TUNNEL/L2GRE_TUNNEL/IPGRE_TUNNEL */
1179 	u8 gre_tunnel_type;
1180 
1181 	/* Enables Inner GRE RSS on the function, depends on the client RSS
1182 	 * capailities
1183 	 */
1184 	u8 inner_gre_rss_en;
1185 
1186 	/* Allows accepting of packets failing MF classification, possibly
1187 	 * only matching a given ethertype
1188 	 */
1189 	u8 class_fail;
1190 	u16 class_fail_ethtype;
1191 
1192 	/* Override priority of output packets */
1193 	u8 sd_vlan_force_pri;
1194 	u8 sd_vlan_force_pri_val;
1195 
1196 	/* Replace vlan's ethertype */
1197 	u16 sd_vlan_eth_type;
1198 
1199 	/* Prevent inner vlans from being added by FW */
1200 	u8 no_added_tags;
1201 };
1202 
1203 struct bnx2x_func_switch_update_params {
1204 	unsigned long changes; /* BNX2X_F_UPDATE_XX bits */
1205 	u16 vlan;
1206 	u16 vlan_eth_type;
1207 	u8 vlan_force_prio;
1208 	u8 tunnel_mode;
1209 	u8 gre_tunnel_type;
1210 };
1211 
1212 struct bnx2x_func_afex_update_params {
1213 	u16 vif_id;
1214 	u16 afex_default_vlan;
1215 	u8 allowed_priorities;
1216 };
1217 
1218 struct bnx2x_func_afex_viflists_params {
1219 	u16 vif_list_index;
1220 	u8 func_bit_map;
1221 	u8 afex_vif_list_command;
1222 	u8 func_to_clear;
1223 };
1224 
1225 struct bnx2x_func_tx_start_params {
1226 	struct priority_cos traffic_type_to_priority_cos[MAX_TRAFFIC_TYPES];
1227 	u8 dcb_enabled;
1228 	u8 dcb_version;
1229 	u8 dont_add_pri_0_en;
1230 };
1231 
1232 struct bnx2x_func_set_timesync_params {
1233 	/* Reset, set or keep the current drift value */
1234 	u8 drift_adjust_cmd;
1235 
1236 	/* Dec, inc or keep the current offset */
1237 	u8 offset_cmd;
1238 
1239 	/* Drift value direction */
1240 	u8 add_sub_drift_adjust_value;
1241 
1242 	/* Drift, period and offset values to be used according to the commands
1243 	 * above.
1244 	 */
1245 	u8 drift_adjust_value;
1246 	u32 drift_adjust_period;
1247 	u64 offset_delta;
1248 };
1249 
1250 struct bnx2x_func_state_params {
1251 	struct bnx2x_func_sp_obj *f_obj;
1252 
1253 	/* Current command */
1254 	enum bnx2x_func_cmd cmd;
1255 
1256 	/* may have RAMROD_COMP_WAIT set only */
1257 	unsigned long	ramrod_flags;
1258 
1259 	/* Params according to the current command */
1260 	union {
1261 		struct bnx2x_func_hw_init_params hw_init;
1262 		struct bnx2x_func_hw_reset_params hw_reset;
1263 		struct bnx2x_func_start_params start;
1264 		struct bnx2x_func_switch_update_params switch_update;
1265 		struct bnx2x_func_afex_update_params afex_update;
1266 		struct bnx2x_func_afex_viflists_params afex_viflists;
1267 		struct bnx2x_func_tx_start_params tx_start;
1268 		struct bnx2x_func_set_timesync_params set_timesync;
1269 	} params;
1270 };
1271 
1272 struct bnx2x_func_sp_drv_ops {
1273 	/* Init tool + runtime initialization:
1274 	 *      - Common Chip
1275 	 *      - Common (per Path)
1276 	 *      - Port
1277 	 *      - Function phases
1278 	 */
1279 	int (*init_hw_cmn_chip)(struct bnx2x *bp);
1280 	int (*init_hw_cmn)(struct bnx2x *bp);
1281 	int (*init_hw_port)(struct bnx2x *bp);
1282 	int (*init_hw_func)(struct bnx2x *bp);
1283 
1284 	/* Reset Function HW: Common, Port, Function phases. */
1285 	void (*reset_hw_cmn)(struct bnx2x *bp);
1286 	void (*reset_hw_port)(struct bnx2x *bp);
1287 	void (*reset_hw_func)(struct bnx2x *bp);
1288 
1289 	/* Init/Free GUNZIP resources */
1290 	int (*gunzip_init)(struct bnx2x *bp);
1291 	void (*gunzip_end)(struct bnx2x *bp);
1292 
1293 	/* Prepare/Release FW resources */
1294 	int (*init_fw)(struct bnx2x *bp);
1295 	void (*release_fw)(struct bnx2x *bp);
1296 };
1297 
1298 struct bnx2x_func_sp_obj {
1299 	enum bnx2x_func_state	state, next_state;
1300 
1301 	/* BNX2X_FUNC_CMD_XX bits. This object implements "one
1302 	 * pending" paradigm but for debug and tracing purposes it's
1303 	 * more convenient to have different bits for different
1304 	 * commands.
1305 	 */
1306 	unsigned long		pending;
1307 
1308 	/* Buffer to use as a ramrod data and its mapping */
1309 	void			*rdata;
1310 	dma_addr_t		rdata_mapping;
1311 
1312 	/* Buffer to use as a afex ramrod data and its mapping.
1313 	 * This can't be same rdata as above because afex ramrod requests
1314 	 * can arrive to the object in parallel to other ramrod requests.
1315 	 */
1316 	void			*afex_rdata;
1317 	dma_addr_t		afex_rdata_mapping;
1318 
1319 	/* this mutex validates that when pending flag is taken, the next
1320 	 * ramrod to be sent will be the one set the pending bit
1321 	 */
1322 	struct mutex		one_pending_mutex;
1323 
1324 	/* Driver interface */
1325 	struct bnx2x_func_sp_drv_ops	*drv;
1326 
1327 	/**
1328 	 * Performs one state change according to the given parameters.
1329 	 *
1330 	 * @return 0 in case of success and negative value otherwise.
1331 	 */
1332 	int (*send_cmd)(struct bnx2x *bp,
1333 			struct bnx2x_func_state_params *params);
1334 
1335 	/**
1336 	 * Checks that the requested state transition is legal.
1337 	 */
1338 	int (*check_transition)(struct bnx2x *bp,
1339 				struct bnx2x_func_sp_obj *o,
1340 				struct bnx2x_func_state_params *params);
1341 
1342 	/**
1343 	 * Completes the pending command.
1344 	 */
1345 	int (*complete_cmd)(struct bnx2x *bp,
1346 			    struct bnx2x_func_sp_obj *o,
1347 			    enum bnx2x_func_cmd cmd);
1348 
1349 	int (*wait_comp)(struct bnx2x *bp, struct bnx2x_func_sp_obj *o,
1350 			 enum bnx2x_func_cmd cmd);
1351 };
1352 
1353 /********************** Interfaces ********************************************/
1354 /* Queueable objects set */
1355 union bnx2x_qable_obj {
1356 	struct bnx2x_vlan_mac_obj vlan_mac;
1357 };
1358 /************** Function state update *********/
1359 void bnx2x_init_func_obj(struct bnx2x *bp,
1360 			 struct bnx2x_func_sp_obj *obj,
1361 			 void *rdata, dma_addr_t rdata_mapping,
1362 			 void *afex_rdata, dma_addr_t afex_rdata_mapping,
1363 			 struct bnx2x_func_sp_drv_ops *drv_iface);
1364 
1365 int bnx2x_func_state_change(struct bnx2x *bp,
1366 			    struct bnx2x_func_state_params *params);
1367 
1368 enum bnx2x_func_state bnx2x_func_get_state(struct bnx2x *bp,
1369 					   struct bnx2x_func_sp_obj *o);
1370 /******************* Queue State **************/
1371 void bnx2x_init_queue_obj(struct bnx2x *bp,
1372 			  struct bnx2x_queue_sp_obj *obj, u8 cl_id, u32 *cids,
1373 			  u8 cid_cnt, u8 func_id, void *rdata,
1374 			  dma_addr_t rdata_mapping, unsigned long type);
1375 
1376 int bnx2x_queue_state_change(struct bnx2x *bp,
1377 			     struct bnx2x_queue_state_params *params);
1378 
1379 int bnx2x_get_q_logical_state(struct bnx2x *bp,
1380 			       struct bnx2x_queue_sp_obj *obj);
1381 
1382 /********************* VLAN-MAC ****************/
1383 void bnx2x_init_mac_obj(struct bnx2x *bp,
1384 			struct bnx2x_vlan_mac_obj *mac_obj,
1385 			u8 cl_id, u32 cid, u8 func_id, void *rdata,
1386 			dma_addr_t rdata_mapping, int state,
1387 			unsigned long *pstate, bnx2x_obj_type type,
1388 			struct bnx2x_credit_pool_obj *macs_pool);
1389 
1390 void bnx2x_init_vlan_obj(struct bnx2x *bp,
1391 			 struct bnx2x_vlan_mac_obj *vlan_obj,
1392 			 u8 cl_id, u32 cid, u8 func_id, void *rdata,
1393 			 dma_addr_t rdata_mapping, int state,
1394 			 unsigned long *pstate, bnx2x_obj_type type,
1395 			 struct bnx2x_credit_pool_obj *vlans_pool);
1396 
1397 int bnx2x_vlan_mac_h_read_lock(struct bnx2x *bp,
1398 					struct bnx2x_vlan_mac_obj *o);
1399 void bnx2x_vlan_mac_h_read_unlock(struct bnx2x *bp,
1400 				  struct bnx2x_vlan_mac_obj *o);
1401 int bnx2x_vlan_mac_h_write_lock(struct bnx2x *bp,
1402 				struct bnx2x_vlan_mac_obj *o);
1403 int bnx2x_config_vlan_mac(struct bnx2x *bp,
1404 			   struct bnx2x_vlan_mac_ramrod_params *p);
1405 
1406 int bnx2x_vlan_mac_move(struct bnx2x *bp,
1407 			struct bnx2x_vlan_mac_ramrod_params *p,
1408 			struct bnx2x_vlan_mac_obj *dest_o);
1409 
1410 /********************* RX MODE ****************/
1411 
1412 void bnx2x_init_rx_mode_obj(struct bnx2x *bp,
1413 			    struct bnx2x_rx_mode_obj *o);
1414 
1415 /**
1416  * bnx2x_config_rx_mode - Send and RX_MODE ramrod according to the provided parameters.
1417  *
1418  * @p: Command parameters
1419  *
1420  * Return: 0 - if operation was successful and there is no pending completions,
1421  *         positive number - if there are pending completions,
1422  *         negative - if there were errors
1423  */
1424 int bnx2x_config_rx_mode(struct bnx2x *bp,
1425 			 struct bnx2x_rx_mode_ramrod_params *p);
1426 
1427 /****************** MULTICASTS ****************/
1428 
1429 void bnx2x_init_mcast_obj(struct bnx2x *bp,
1430 			  struct bnx2x_mcast_obj *mcast_obj,
1431 			  u8 mcast_cl_id, u32 mcast_cid, u8 func_id,
1432 			  u8 engine_id, void *rdata, dma_addr_t rdata_mapping,
1433 			  int state, unsigned long *pstate,
1434 			  bnx2x_obj_type type);
1435 
1436 /**
1437  * bnx2x_config_mcast - Configure multicast MACs list.
1438  *
1439  * @cmd: command to execute: BNX2X_MCAST_CMD_X
1440  *
1441  * May configure a new list
1442  * provided in p->mcast_list (BNX2X_MCAST_CMD_ADD), clean up
1443  * (BNX2X_MCAST_CMD_DEL) or restore (BNX2X_MCAST_CMD_RESTORE) a current
1444  * configuration, continue to execute the pending commands
1445  * (BNX2X_MCAST_CMD_CONT).
1446  *
1447  * If previous command is still pending or if number of MACs to
1448  * configure is more that maximum number of MACs in one command,
1449  * the current command will be enqueued to the tail of the
1450  * pending commands list.
1451  *
1452  * Return: 0 is operation was successful and there are no pending completions,
1453  *         negative if there were errors, positive if there are pending
1454  *         completions.
1455  */
1456 int bnx2x_config_mcast(struct bnx2x *bp,
1457 		       struct bnx2x_mcast_ramrod_params *p,
1458 		       enum bnx2x_mcast_cmd cmd);
1459 
1460 /****************** CREDIT POOL ****************/
1461 void bnx2x_init_mac_credit_pool(struct bnx2x *bp,
1462 				struct bnx2x_credit_pool_obj *p, u8 func_id,
1463 				u8 func_num);
1464 void bnx2x_init_vlan_credit_pool(struct bnx2x *bp,
1465 				 struct bnx2x_credit_pool_obj *p, u8 func_id,
1466 				 u8 func_num);
1467 
1468 /****************** RSS CONFIGURATION ****************/
1469 void bnx2x_init_rss_config_obj(struct bnx2x *bp,
1470 			       struct bnx2x_rss_config_obj *rss_obj,
1471 			       u8 cl_id, u32 cid, u8 func_id, u8 engine_id,
1472 			       void *rdata, dma_addr_t rdata_mapping,
1473 			       int state, unsigned long *pstate,
1474 			       bnx2x_obj_type type);
1475 
1476 /**
1477  * bnx2x_config_rss - Updates RSS configuration according to provided parameters
1478  *
1479  * Return: 0 in case of success
1480  */
1481 int bnx2x_config_rss(struct bnx2x *bp,
1482 		     struct bnx2x_config_rss_params *p);
1483 
1484 /**
1485  * bnx2x_get_rss_ind_table - Return the current ind_table configuration.
1486  *
1487  * @ind_table: buffer to fill with the current indirection
1488  *                  table content. Should be at least
1489  *                  T_ETH_INDIRECTION_TABLE_SIZE bytes long.
1490  */
1491 void bnx2x_get_rss_ind_table(struct bnx2x_rss_config_obj *rss_obj,
1492 			     u8 *ind_table);
1493 
1494 #endif /* BNX2X_SP_VERBS */
1495