1 /* bnx2x_sp.h: Broadcom Everest network driver.
3 * Copyright (c) 2011-2013 Broadcom Corporation
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").
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
15 * Maintained by: Eilon Greenstein <eilong@broadcom.com>
16 * Written by: Vladislav Zolotarov
19 #ifndef BNX2X_SP_VERBS
20 #define BNX2X_SP_VERBS
25 /* Bits representing general command's configuration */
29 /* Wait until all pending commands complete */
31 /* Don't send a ramrod, only update a registry */
33 /* Configure HW according to the current object state */
35 /* Execute the next command now */
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.
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.
56 /* Public slow path states */
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
74 struct bnx2x_raw_obj {
81 /* Ramrod data buffer params */
83 dma_addr_t rdata_mapping;
85 /* Ramrod state params */
86 int state; /* "ramrod is pending" state bit */
87 unsigned long *pstate; /* pointer to state buffer */
89 bnx2x_obj_type obj_type;
91 int (*wait_comp)(struct bnx2x *bp,
92 struct bnx2x_raw_obj *o);
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);
99 /************************* VLAN-MAC commands related parameters ***************/
100 struct bnx2x_mac_ramrod_data {
105 struct bnx2x_vlan_ramrod_data {
109 struct bnx2x_vlan_mac_ramrod_data {
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;
121 /* VLAN_MAC commands */
122 enum bnx2x_vlan_mac_cmd {
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
134 unsigned long vlan_mac_flags;
136 /* Needed for MOVE command */
137 struct bnx2x_vlan_mac_obj *target_obj;
139 union bnx2x_classification_ramrod_data u;
142 /*************************** Exe Queue obj ************************************/
143 union bnx2x_exe_queue_cmd_data {
144 struct bnx2x_vlan_mac_data vlan_mac;
151 struct bnx2x_exeq_elem {
152 struct list_head link;
154 /* Length of this element in the exe_chunk. */
157 union bnx2x_exe_queue_cmd_data cmd_data;
160 union bnx2x_qable_obj;
162 union bnx2x_exeq_comp_elem {
163 union event_ring_elem *elem;
166 struct bnx2x_exe_queue_obj;
168 typedef int (*exe_q_validate)(struct bnx2x *bp,
169 union bnx2x_qable_obj *o,
170 struct bnx2x_exeq_elem *elem);
172 typedef int (*exe_q_remove)(struct bnx2x *bp,
173 union bnx2x_qable_obj *o,
174 struct bnx2x_exeq_elem *elem);
176 /* Return positive if entry was optimized, 0 - if not, negative
177 * in case of an error.
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);
190 struct bnx2x_exe_queue_obj {
191 /* Commands pending for an execution. */
192 struct list_head exe_queue;
194 /* Commands pending for an completion. */
195 struct list_head pending_comp;
199 /* Maximum length of commands' list for one execution */
202 union bnx2x_qable_obj *owner;
204 /****** Virtual functions ******/
206 * Called before commands execution for commands that are really
207 * going to be executed (after 'optimize').
209 * Must run under exe_queue->lock
211 exe_q_validate validate;
214 * Called before removing pending commands, cleaning allocated
215 * resources (e.g., credits from validate)
220 * This will try to cancel the current pending commands list
221 * considering the new command.
223 * Returns the number of optimized commands or a negative error code
225 * Must run under exe_queue->lock
227 exe_q_optimize optimize;
230 * Run the next commands chunk (owner specific).
232 exe_q_execute execute;
235 * Return the exe_queue element containing the specific command
236 * if any. Otherwise return NULL.
240 /***************** Classification verbs: Set/Del MAC/VLAN/VLAN-MAC ************/
242 * Element in the VLAN_MAC registry list having all currently configured
245 struct bnx2x_vlan_mac_registry_elem {
246 struct list_head link;
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.
254 /* Needed for DEL and RESTORE flows */
255 unsigned long vlan_mac_flags;
257 union bnx2x_classification_ramrod_data u;
260 /* Bits representing VLAN_MAC commands specific flags */
266 BNX2X_DONT_CONSUME_CAM_CREDIT,
267 BNX2X_DONT_CONSUME_CAM_CREDIT_DEST,
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)
277 struct bnx2x_vlan_mac_ramrod_params {
278 /* Object to run the command from */
279 struct bnx2x_vlan_mac_obj *vlan_mac_obj;
281 /* General command flags: COMP_WAIT, etc. */
282 unsigned long ramrod_flags;
284 /* Command specific configuration request */
285 struct bnx2x_vlan_mac_data user_req;
288 struct bnx2x_vlan_mac_obj {
289 struct bnx2x_raw_obj raw;
291 /* Bookkeeping list: will prevent the addition of already existing
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
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 */
302 /* TODO: Add it's initialization in the init functions */
303 struct bnx2x_exe_queue_obj exe_queue;
305 /* MACs credit pool */
306 struct bnx2x_credit_pool_obj *macs_pool;
308 /* VLANs credit pool */
309 struct bnx2x_credit_pool_obj *vlans_pool;
311 /* RAMROD command to be used */
314 /* copy first n elements onto preallocated buffer
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
322 * @return number of copied bytes
324 int (*get_n_elements)(struct bnx2x *bp,
325 struct bnx2x_vlan_mac_obj *o, int n, u8 *base,
329 * Checks if ADD-ramrod with the given params may be performed.
331 * @return zero if the element may be added
334 int (*check_add)(struct bnx2x *bp,
335 struct bnx2x_vlan_mac_obj *o,
336 union bnx2x_classification_ramrod_data *data);
339 * Checks if DEL-ramrod with the given params may be performed.
341 * @return true if the element may be deleted
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);
349 * Checks if DEL-ramrod with the given params may be performed.
351 * @return true if the element may be deleted
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);
359 * Update the relevant credit object(s) (consume/return
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);
368 * Configures one rule in the ramrod data buffer.
370 void (*set_one_rule)(struct bnx2x *bp,
371 struct bnx2x_vlan_mac_obj *o,
372 struct bnx2x_exeq_elem *elem, int rule_idx,
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.
385 * @param ramrod_flags RAMROD_XX flags
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.
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);
398 * Reconfigures the next MAC/VLAN/VLAN-MAC element from the previously
399 * configured elements list.
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.
412 int (*restore)(struct bnx2x *bp,
413 struct bnx2x_vlan_mac_ramrod_params *p,
414 struct bnx2x_vlan_mac_registry_elem **ppos);
417 * Should be called on a completion arrival.
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.
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
433 int (*complete)(struct bnx2x *bp, struct bnx2x_vlan_mac_obj *o,
434 union event_ring_elem *cqe,
435 unsigned long *ramrod_flags);
438 * Wait for completion of all commands. Don't schedule new ones,
439 * just wait. It assumes that the completion code will schedule
442 int (*wait)(struct bnx2x *bp, struct bnx2x_vlan_mac_obj *o);
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
451 /** RX_MODE verbs:DROP_ALL/ACCEPT_ALL/ACCEPT_ALL_MULTI/ACCEPT_ALL_VLAN/NORMAL */
453 /* RX_MODE ramrod special flags: set in rx_mode_flags field in
454 * a bnx2x_rx_mode_ramrod_params.
457 BNX2X_RX_MODE_FCOE_ETH,
458 BNX2X_RX_MODE_ISCSI_ETH,
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
471 struct bnx2x_rx_mode_ramrod_params {
472 struct bnx2x_rx_mode_obj *rx_mode_obj;
473 unsigned long *pstate;
478 unsigned long ramrod_flags;
479 unsigned long rx_mode_flags;
481 /* rdata is either a pointer to eth_filter_rules_ramrod_data(e2) or to
482 * a tstorm_eth_mac_filter_config (e1x).
485 dma_addr_t rdata_mapping;
487 /* Rx mode settings */
488 unsigned long rx_accept_flags;
490 /* internal switching settings */
491 unsigned long tx_accept_flags;
494 struct bnx2x_rx_mode_obj {
495 int (*config_rx_mode)(struct bnx2x *bp,
496 struct bnx2x_rx_mode_ramrod_params *p);
498 int (*wait_comp)(struct bnx2x *bp,
499 struct bnx2x_rx_mode_ramrod_params *p);
502 /********************** Set multicast group ***********************************/
504 struct bnx2x_mcast_list_elem {
505 struct list_head link;
509 union bnx2x_mcast_config_data {
511 u8 bin; /* used in a RESTORE flow */
514 struct bnx2x_mcast_ramrod_params {
515 struct bnx2x_mcast_obj *mcast_obj;
517 /* Relevant options are RAMROD_COMP_WAIT and RAMROD_DRV_CLR_ONLY */
518 unsigned long ramrod_flags;
520 struct list_head mcast_list; /* list of struct bnx2x_mcast_list_elem */
522 * - rename it to macs_num.
523 * - Add a new command type for handling pending commands
524 * (remove "zero semantics").
526 * Length of mcast_list. If zero and ADD_CONT command - post
532 enum bnx2x_mcast_cmd {
534 BNX2X_MCAST_CMD_CONT,
536 BNX2X_MCAST_CMD_RESTORE,
539 struct bnx2x_mcast_obj {
540 struct bnx2x_raw_obj raw;
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];
548 /** Number of BINs to clear. Should be updated
549 * immediately when a command arrives in order to
550 * properly create DEL commands.
556 struct list_head macs;
561 /* Pending commands */
562 struct list_head pending_cmds_head;
564 /* A state that is set in raw.pstate, when there are pending commands */
567 /* Maximal number of mcast MACs configured in one command */
570 /* Total number of currently pending MACs to configure: both
571 * in the pending commands list and in the current command.
573 int total_pending_num;
578 * @param cmd command to execute (BNX2X_MCAST_CMD_X, see above)
580 int (*config_mcast)(struct bnx2x *bp,
581 struct bnx2x_mcast_ramrod_params *p,
582 enum bnx2x_mcast_cmd cmd);
585 * Fills the ramrod data during the RESTORE flow.
589 * @param start_idx Registry index to start from
590 * @param rdata_idx Index in the ramrod data to start from
592 * @return -1 if we handled the whole registry or index of the last
593 * handled registry element.
595 int (*hdl_restore)(struct bnx2x *bp, struct bnx2x_mcast_obj *o,
596 int start_bin, int *rdata_idx);
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);
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);
607 /** Checks if there are more mcast MACs to be set or a previous
608 * command is still pending.
610 bool (*check_pending)(struct bnx2x_mcast_obj *o);
613 * Set/Clear/Check SCHEDULED state of the object
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);
619 /* Wait until all pending commands complete */
620 int (*wait_comp)(struct bnx2x *bp, struct bnx2x_mcast_obj *o);
623 * Handle the internal object counters needed for proper
624 * commands handling. Checks that the provided parameters are
627 int (*validate)(struct bnx2x *bp,
628 struct bnx2x_mcast_ramrod_params *p,
629 enum bnx2x_mcast_cmd cmd);
632 * Restore the values of internal counters in case of a failure.
634 void (*revert)(struct bnx2x *bp,
635 struct bnx2x_mcast_ramrod_params *p,
638 int (*get_registry_size)(struct bnx2x_mcast_obj *o);
639 void (*set_registry_size)(struct bnx2x_mcast_obj *o, int n);
642 /*************************** Credit handling **********************************/
643 struct bnx2x_credit_pool_obj {
645 /* Current amount of credit in the pool */
648 /* Maximum allowed credit. put() will check against it. */
651 /* Allocate a pool table statically.
653 * Currently the maximum allowed size is MAX_MAC_CREDIT_E2(272)
655 * The set bit in the table will mean that the entry is available.
657 #define BNX2X_POOL_VEC_SIZE (MAX_MAC_CREDIT_E2 / 64)
658 u64 pool_mirror[BNX2X_POOL_VEC_SIZE];
660 /* Base pool offset (initialized differently */
661 int base_pool_offset;
664 * Get the next free pool entry.
666 * @return true if there was a free entry in the pool
668 bool (*get_entry)(struct bnx2x_credit_pool_obj *o, int *entry);
671 * Return the entry back to the pool.
673 * @return true if entry is legal and has been successfully
674 * returned to the pool.
676 bool (*put_entry)(struct bnx2x_credit_pool_obj *o, int entry);
679 * Get the requested amount of credit from the pool.
681 * @param cnt Amount of requested credit
682 * @return true if the operation is successful
684 bool (*get)(struct bnx2x_credit_pool_obj *o, int cnt);
687 * Returns the credit to the pool.
689 * @param cnt Amount of credit to return
690 * @return true if the operation is successful
692 bool (*put)(struct bnx2x_credit_pool_obj *o, int cnt);
695 * Reads the current amount of credit.
697 int (*check)(struct bnx2x_credit_pool_obj *o);
700 /*************************** RSS configuration ********************************/
702 /* RSS_MODE bits are mutually exclusive */
703 BNX2X_RSS_MODE_DISABLED,
704 BNX2X_RSS_MODE_REGULAR,
706 BNX2X_RSS_SET_SRCH, /* Setup searcher, E1x specific flag */
716 struct bnx2x_config_rss_params {
717 struct bnx2x_rss_config_obj *rss_obj;
719 /* may have RAMROD_COMP_WAIT set only */
720 unsigned long ramrod_flags;
722 /* BNX2X_RSS_X bits */
723 unsigned long rss_flags;
725 /* Number hash bits to take into an account */
728 /* Indirection table */
729 u8 ind_table[T_ETH_INDIRECTION_TABLE_SIZE];
731 /* RSS hash values */
734 /* valid only iff BNX2X_RSS_UPDATE_TOE is set */
738 struct bnx2x_rss_config_obj {
739 struct bnx2x_raw_obj raw;
741 /* RSS engine to use */
744 /* Last configured indirection table */
745 u8 ind_table[T_ETH_INDIRECTION_TABLE_SIZE];
747 /* flags for enabling 4-tupple hash on UDP */
751 int (*config_rss)(struct bnx2x *bp,
752 struct bnx2x_config_rss_params *p);
755 /*********************** Queue state update ***********************************/
757 /* UPDATE command options */
759 BNX2X_Q_UPDATE_IN_VLAN_REM,
760 BNX2X_Q_UPDATE_IN_VLAN_REM_CHNG,
761 BNX2X_Q_UPDATE_OUT_VLAN_REM,
762 BNX2X_Q_UPDATE_OUT_VLAN_REM_CHNG,
763 BNX2X_Q_UPDATE_ANTI_SPOOF,
764 BNX2X_Q_UPDATE_ANTI_SPOOF_CHNG,
765 BNX2X_Q_UPDATE_ACTIVATE,
766 BNX2X_Q_UPDATE_ACTIVATE_CHNG,
767 BNX2X_Q_UPDATE_DEF_VLAN_EN,
768 BNX2X_Q_UPDATE_DEF_VLAN_EN_CHNG,
769 BNX2X_Q_UPDATE_SILENT_VLAN_REM_CHNG,
770 BNX2X_Q_UPDATE_SILENT_VLAN_REM,
771 BNX2X_Q_UPDATE_TX_SWITCHING_CHNG,
772 BNX2X_Q_UPDATE_TX_SWITCHING
775 /* Allowed Queue states */
778 BNX2X_Q_STATE_INITIALIZED,
779 BNX2X_Q_STATE_ACTIVE,
780 BNX2X_Q_STATE_MULTI_COS,
781 BNX2X_Q_STATE_MCOS_TERMINATED,
782 BNX2X_Q_STATE_INACTIVE,
783 BNX2X_Q_STATE_STOPPED,
784 BNX2X_Q_STATE_TERMINATED,
789 /* Allowed Queue states */
790 enum bnx2x_q_logical_state {
791 BNX2X_Q_LOGICAL_STATE_ACTIVE,
792 BNX2X_Q_LOGICAL_STATE_STOPPED,
795 /* Allowed commands */
796 enum bnx2x_queue_cmd {
799 BNX2X_Q_CMD_SETUP_TX_ONLY,
800 BNX2X_Q_CMD_DEACTIVATE,
801 BNX2X_Q_CMD_ACTIVATE,
803 BNX2X_Q_CMD_UPDATE_TPA,
806 BNX2X_Q_CMD_TERMINATE,
811 /* queue SETUP + INIT flags */
814 BNX2X_Q_FLG_TPA_IPV6,
817 BNX2X_Q_FLG_ZERO_STATS,
826 BNX2X_Q_FLG_LEADING_RSS,
828 BNX2X_Q_FLG_DEF_VLAN,
829 BNX2X_Q_FLG_TX_SWITCH,
831 BNX2X_Q_FLG_ANTI_SPOOF,
832 BNX2X_Q_FLG_SILENT_VLAN_REM,
833 BNX2X_Q_FLG_FORCE_DEFAULT_PRI,
834 BNX2X_Q_FLG_PCSUM_ON_PKT,
835 BNX2X_Q_FLG_TUN_INC_INNER_IP_ID
838 /* Queue type options: queue type may be a combination of below. */
840 /** TODO: Consider moving both these flags into the init()
847 #define BNX2X_PRIMARY_CID_INDEX 0
848 #define BNX2X_MULTI_TX_COS_E1X 3 /* QM only */
849 #define BNX2X_MULTI_TX_COS_E2_E3A0 2
850 #define BNX2X_MULTI_TX_COS_E3B0 3
851 #define BNX2X_MULTI_TX_COS 3 /* Maximum possible */
853 #define MAC_PAD (ALIGN(ETH_ALEN, sizeof(u32)) - ETH_ALEN)
855 struct bnx2x_queue_init_params {
870 /* CID context in the host memory */
871 struct eth_context *cxts[BNX2X_MULTI_TX_COS];
873 /* maximum number of cos supported by hardware */
877 struct bnx2x_queue_terminate_params {
878 /* index within the tx_only cids of this queue object */
882 struct bnx2x_queue_cfc_del_params {
883 /* index within the tx_only cids of this queue object */
887 struct bnx2x_queue_update_params {
888 unsigned long update_flags; /* BNX2X_Q_UPDATE_XX bits */
890 u16 silent_removal_value;
891 u16 silent_removal_mask;
892 /* index within the tx_only cids of this queue object */
896 struct rxq_pause_params {
901 u16 sge_th_lo; /* valid iff BNX2X_Q_FLG_TPA */
902 u16 sge_th_hi; /* valid iff BNX2X_Q_FLG_TPA */
907 struct bnx2x_general_setup_params {
908 /* valid iff BNX2X_Q_FLG_STATS */
916 struct bnx2x_rxq_setup_params {
921 dma_addr_t rcq_np_map;
928 /* valid iff BNX2X_Q_FLG_TPA */
935 /* valid iff BNX2X_Q_FLG_MCAST */
942 /* valid iff BXN2X_Q_FLG_SILENT_VLAN_REM */
943 u16 silent_removal_value;
944 u16 silent_removal_mask;
947 struct bnx2x_txq_setup_params {
953 u8 cos; /* valid iff BNX2X_Q_FLG_COS */
955 /* equals to the leading rss client id, used for TX classification*/
956 u8 tss_leading_cl_id;
958 /* valid iff BNX2X_Q_FLG_DEF_VLAN */
962 struct bnx2x_queue_setup_params {
963 struct bnx2x_general_setup_params gen_params;
964 struct bnx2x_txq_setup_params txq_params;
965 struct bnx2x_rxq_setup_params rxq_params;
966 struct rxq_pause_params pause_params;
970 struct bnx2x_queue_setup_tx_only_params {
971 struct bnx2x_general_setup_params gen_params;
972 struct bnx2x_txq_setup_params txq_params;
974 /* index within the tx_only cids of this queue object */
978 struct bnx2x_queue_state_params {
979 struct bnx2x_queue_sp_obj *q_obj;
981 /* Current command */
982 enum bnx2x_queue_cmd cmd;
984 /* may have RAMROD_COMP_WAIT set only */
985 unsigned long ramrod_flags;
987 /* Params according to the current command */
989 struct bnx2x_queue_update_params update;
990 struct bnx2x_queue_setup_params setup;
991 struct bnx2x_queue_init_params init;
992 struct bnx2x_queue_setup_tx_only_params tx_only;
993 struct bnx2x_queue_terminate_params terminate;
994 struct bnx2x_queue_cfc_del_params cfc_del;
998 struct bnx2x_viflist_params {
1000 u8 func_bit_map_res;
1003 struct bnx2x_queue_sp_obj {
1004 u32 cids[BNX2X_MULTI_TX_COS];
1008 /* number of traffic classes supported by queue.
1009 * The primary connection of the queue supports the first traffic
1010 * class. Any further traffic class is supported by a tx-only
1013 * Therefore max_cos is also a number of valid entries in the cids
1017 u8 num_tx_only, next_tx_only;
1019 enum bnx2x_q_state state, next_state;
1021 /* bits from enum bnx2x_q_type */
1024 /* BNX2X_Q_CMD_XX bits. This object implements "one
1025 * pending" paradigm but for debug and tracing purposes it's
1026 * more convenient to have different bits for different
1029 unsigned long pending;
1031 /* Buffer to use as a ramrod data and its mapping */
1033 dma_addr_t rdata_mapping;
1036 * Performs one state change according to the given parameters.
1038 * @return 0 in case of success and negative value otherwise.
1040 int (*send_cmd)(struct bnx2x *bp,
1041 struct bnx2x_queue_state_params *params);
1044 * Sets the pending bit according to the requested transition.
1046 int (*set_pending)(struct bnx2x_queue_sp_obj *o,
1047 struct bnx2x_queue_state_params *params);
1050 * Checks that the requested state transition is legal.
1052 int (*check_transition)(struct bnx2x *bp,
1053 struct bnx2x_queue_sp_obj *o,
1054 struct bnx2x_queue_state_params *params);
1057 * Completes the pending command.
1059 int (*complete_cmd)(struct bnx2x *bp,
1060 struct bnx2x_queue_sp_obj *o,
1061 enum bnx2x_queue_cmd);
1063 int (*wait_comp)(struct bnx2x *bp,
1064 struct bnx2x_queue_sp_obj *o,
1065 enum bnx2x_queue_cmd cmd);
1068 /********************** Function state update *********************************/
1069 /* Allowed Function states */
1070 enum bnx2x_func_state {
1071 BNX2X_F_STATE_RESET,
1072 BNX2X_F_STATE_INITIALIZED,
1073 BNX2X_F_STATE_STARTED,
1074 BNX2X_F_STATE_TX_STOPPED,
1078 /* Allowed Function commands */
1079 enum bnx2x_func_cmd {
1080 BNX2X_F_CMD_HW_INIT,
1083 BNX2X_F_CMD_HW_RESET,
1084 BNX2X_F_CMD_AFEX_UPDATE,
1085 BNX2X_F_CMD_AFEX_VIFLISTS,
1086 BNX2X_F_CMD_TX_STOP,
1087 BNX2X_F_CMD_TX_START,
1088 BNX2X_F_CMD_SWITCH_UPDATE,
1092 struct bnx2x_func_hw_init_params {
1093 /* A load phase returned by MCP.
1096 * FW_MSG_CODE_DRV_LOAD_COMMON_CHIP
1097 * FW_MSG_CODE_DRV_LOAD_COMMON
1098 * FW_MSG_CODE_DRV_LOAD_PORT
1099 * FW_MSG_CODE_DRV_LOAD_FUNCTION
1104 struct bnx2x_func_hw_reset_params {
1105 /* A load phase returned by MCP.
1108 * FW_MSG_CODE_DRV_LOAD_COMMON_CHIP
1109 * FW_MSG_CODE_DRV_LOAD_COMMON
1110 * FW_MSG_CODE_DRV_LOAD_PORT
1111 * FW_MSG_CODE_DRV_LOAD_FUNCTION
1116 struct bnx2x_func_start_params {
1117 /* Multi Function mode:
1119 * - Switch Dependent
1120 * - Switch Independent
1124 /* Switch Dependent mode outer VLAN tag */
1127 /* Function cos mode */
1128 u8 network_cos_mode;
1130 /* NVGRE classification enablement */
1133 /* NO_GRE_TUNNEL/NVGRE_TUNNEL/L2GRE_TUNNEL/IPGRE_TUNNEL */
1136 /* GRE_OUTER_HEADERS_RSS/GRE_INNER_HEADERS_RSS/NVGRE_KEY_ENTROPY_RSS */
1140 struct bnx2x_func_switch_update_params {
1144 struct bnx2x_func_afex_update_params {
1146 u16 afex_default_vlan;
1147 u8 allowed_priorities;
1150 struct bnx2x_func_afex_viflists_params {
1153 u8 afex_vif_list_command;
1156 struct bnx2x_func_tx_start_params {
1157 struct priority_cos traffic_type_to_priority_cos[MAX_TRAFFIC_TYPES];
1160 u8 dont_add_pri_0_en;
1163 struct bnx2x_func_state_params {
1164 struct bnx2x_func_sp_obj *f_obj;
1166 /* Current command */
1167 enum bnx2x_func_cmd cmd;
1169 /* may have RAMROD_COMP_WAIT set only */
1170 unsigned long ramrod_flags;
1172 /* Params according to the current command */
1174 struct bnx2x_func_hw_init_params hw_init;
1175 struct bnx2x_func_hw_reset_params hw_reset;
1176 struct bnx2x_func_start_params start;
1177 struct bnx2x_func_switch_update_params switch_update;
1178 struct bnx2x_func_afex_update_params afex_update;
1179 struct bnx2x_func_afex_viflists_params afex_viflists;
1180 struct bnx2x_func_tx_start_params tx_start;
1184 struct bnx2x_func_sp_drv_ops {
1185 /* Init tool + runtime initialization:
1187 * - Common (per Path)
1191 int (*init_hw_cmn_chip)(struct bnx2x *bp);
1192 int (*init_hw_cmn)(struct bnx2x *bp);
1193 int (*init_hw_port)(struct bnx2x *bp);
1194 int (*init_hw_func)(struct bnx2x *bp);
1196 /* Reset Function HW: Common, Port, Function phases. */
1197 void (*reset_hw_cmn)(struct bnx2x *bp);
1198 void (*reset_hw_port)(struct bnx2x *bp);
1199 void (*reset_hw_func)(struct bnx2x *bp);
1201 /* Init/Free GUNZIP resources */
1202 int (*gunzip_init)(struct bnx2x *bp);
1203 void (*gunzip_end)(struct bnx2x *bp);
1205 /* Prepare/Release FW resources */
1206 int (*init_fw)(struct bnx2x *bp);
1207 void (*release_fw)(struct bnx2x *bp);
1210 struct bnx2x_func_sp_obj {
1211 enum bnx2x_func_state state, next_state;
1213 /* BNX2X_FUNC_CMD_XX bits. This object implements "one
1214 * pending" paradigm but for debug and tracing purposes it's
1215 * more convenient to have different bits for different
1218 unsigned long pending;
1220 /* Buffer to use as a ramrod data and its mapping */
1222 dma_addr_t rdata_mapping;
1224 /* Buffer to use as a afex ramrod data and its mapping.
1225 * This can't be same rdata as above because afex ramrod requests
1226 * can arrive to the object in parallel to other ramrod requests.
1229 dma_addr_t afex_rdata_mapping;
1231 /* this mutex validates that when pending flag is taken, the next
1232 * ramrod to be sent will be the one set the pending bit
1234 struct mutex one_pending_mutex;
1236 /* Driver interface */
1237 struct bnx2x_func_sp_drv_ops *drv;
1240 * Performs one state change according to the given parameters.
1242 * @return 0 in case of success and negative value otherwise.
1244 int (*send_cmd)(struct bnx2x *bp,
1245 struct bnx2x_func_state_params *params);
1248 * Checks that the requested state transition is legal.
1250 int (*check_transition)(struct bnx2x *bp,
1251 struct bnx2x_func_sp_obj *o,
1252 struct bnx2x_func_state_params *params);
1255 * Completes the pending command.
1257 int (*complete_cmd)(struct bnx2x *bp,
1258 struct bnx2x_func_sp_obj *o,
1259 enum bnx2x_func_cmd cmd);
1261 int (*wait_comp)(struct bnx2x *bp, struct bnx2x_func_sp_obj *o,
1262 enum bnx2x_func_cmd cmd);
1265 /********************** Interfaces ********************************************/
1266 /* Queueable objects set */
1267 union bnx2x_qable_obj {
1268 struct bnx2x_vlan_mac_obj vlan_mac;
1270 /************** Function state update *********/
1271 void bnx2x_init_func_obj(struct bnx2x *bp,
1272 struct bnx2x_func_sp_obj *obj,
1273 void *rdata, dma_addr_t rdata_mapping,
1274 void *afex_rdata, dma_addr_t afex_rdata_mapping,
1275 struct bnx2x_func_sp_drv_ops *drv_iface);
1277 int bnx2x_func_state_change(struct bnx2x *bp,
1278 struct bnx2x_func_state_params *params);
1280 enum bnx2x_func_state bnx2x_func_get_state(struct bnx2x *bp,
1281 struct bnx2x_func_sp_obj *o);
1282 /******************* Queue State **************/
1283 void bnx2x_init_queue_obj(struct bnx2x *bp,
1284 struct bnx2x_queue_sp_obj *obj, u8 cl_id, u32 *cids,
1285 u8 cid_cnt, u8 func_id, void *rdata,
1286 dma_addr_t rdata_mapping, unsigned long type);
1288 int bnx2x_queue_state_change(struct bnx2x *bp,
1289 struct bnx2x_queue_state_params *params);
1291 int bnx2x_get_q_logical_state(struct bnx2x *bp,
1292 struct bnx2x_queue_sp_obj *obj);
1294 /********************* VLAN-MAC ****************/
1295 void bnx2x_init_mac_obj(struct bnx2x *bp,
1296 struct bnx2x_vlan_mac_obj *mac_obj,
1297 u8 cl_id, u32 cid, u8 func_id, void *rdata,
1298 dma_addr_t rdata_mapping, int state,
1299 unsigned long *pstate, bnx2x_obj_type type,
1300 struct bnx2x_credit_pool_obj *macs_pool);
1302 void bnx2x_init_vlan_obj(struct bnx2x *bp,
1303 struct bnx2x_vlan_mac_obj *vlan_obj,
1304 u8 cl_id, u32 cid, u8 func_id, void *rdata,
1305 dma_addr_t rdata_mapping, int state,
1306 unsigned long *pstate, bnx2x_obj_type type,
1307 struct bnx2x_credit_pool_obj *vlans_pool);
1309 int bnx2x_vlan_mac_h_read_lock(struct bnx2x *bp,
1310 struct bnx2x_vlan_mac_obj *o);
1311 void bnx2x_vlan_mac_h_read_unlock(struct bnx2x *bp,
1312 struct bnx2x_vlan_mac_obj *o);
1313 int bnx2x_vlan_mac_h_write_lock(struct bnx2x *bp,
1314 struct bnx2x_vlan_mac_obj *o);
1315 int bnx2x_config_vlan_mac(struct bnx2x *bp,
1316 struct bnx2x_vlan_mac_ramrod_params *p);
1318 int bnx2x_vlan_mac_move(struct bnx2x *bp,
1319 struct bnx2x_vlan_mac_ramrod_params *p,
1320 struct bnx2x_vlan_mac_obj *dest_o);
1322 /********************* RX MODE ****************/
1324 void bnx2x_init_rx_mode_obj(struct bnx2x *bp,
1325 struct bnx2x_rx_mode_obj *o);
1328 * bnx2x_config_rx_mode - Send and RX_MODE ramrod according to the provided parameters.
1330 * @p: Command parameters
1332 * Return: 0 - if operation was successful and there is no pending completions,
1333 * positive number - if there are pending completions,
1334 * negative - if there were errors
1336 int bnx2x_config_rx_mode(struct bnx2x *bp,
1337 struct bnx2x_rx_mode_ramrod_params *p);
1339 /****************** MULTICASTS ****************/
1341 void bnx2x_init_mcast_obj(struct bnx2x *bp,
1342 struct bnx2x_mcast_obj *mcast_obj,
1343 u8 mcast_cl_id, u32 mcast_cid, u8 func_id,
1344 u8 engine_id, void *rdata, dma_addr_t rdata_mapping,
1345 int state, unsigned long *pstate,
1346 bnx2x_obj_type type);
1349 * bnx2x_config_mcast - Configure multicast MACs list.
1351 * @cmd: command to execute: BNX2X_MCAST_CMD_X
1353 * May configure a new list
1354 * provided in p->mcast_list (BNX2X_MCAST_CMD_ADD), clean up
1355 * (BNX2X_MCAST_CMD_DEL) or restore (BNX2X_MCAST_CMD_RESTORE) a current
1356 * configuration, continue to execute the pending commands
1357 * (BNX2X_MCAST_CMD_CONT).
1359 * If previous command is still pending or if number of MACs to
1360 * configure is more that maximum number of MACs in one command,
1361 * the current command will be enqueued to the tail of the
1362 * pending commands list.
1364 * Return: 0 is operation was successful and there are no pending completions,
1365 * negative if there were errors, positive if there are pending
1368 int bnx2x_config_mcast(struct bnx2x *bp,
1369 struct bnx2x_mcast_ramrod_params *p,
1370 enum bnx2x_mcast_cmd cmd);
1372 /****************** CREDIT POOL ****************/
1373 void bnx2x_init_mac_credit_pool(struct bnx2x *bp,
1374 struct bnx2x_credit_pool_obj *p, u8 func_id,
1376 void bnx2x_init_vlan_credit_pool(struct bnx2x *bp,
1377 struct bnx2x_credit_pool_obj *p, u8 func_id,
1380 /****************** RSS CONFIGURATION ****************/
1381 void bnx2x_init_rss_config_obj(struct bnx2x *bp,
1382 struct bnx2x_rss_config_obj *rss_obj,
1383 u8 cl_id, u32 cid, u8 func_id, u8 engine_id,
1384 void *rdata, dma_addr_t rdata_mapping,
1385 int state, unsigned long *pstate,
1386 bnx2x_obj_type type);
1389 * bnx2x_config_rss - Updates RSS configuration according to provided parameters
1391 * Return: 0 in case of success
1393 int bnx2x_config_rss(struct bnx2x *bp,
1394 struct bnx2x_config_rss_params *p);
1397 * bnx2x_get_rss_ind_table - Return the current ind_table configuration.
1399 * @ind_table: buffer to fill with the current indirection
1400 * table content. Should be at least
1401 * T_ETH_INDIRECTION_TABLE_SIZE bytes long.
1403 void bnx2x_get_rss_ind_table(struct bnx2x_rss_config_obj *rss_obj,
1406 int validate_vlan_mac(struct bnx2x *bp,
1407 struct bnx2x_vlan_mac_obj *vlan_mac);
1408 #endif /* BNX2X_SP_VERBS */