2 * Linux network driver for QLogic BR-series Converged Network Adapter.
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License (GPL) Version 2 as
6 * published by the Free Software Foundation
8 * This program is distributed in the hope that it will be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * General Public License for more details.
14 * Copyright (c) 2005-2014 Brocade Communications Systems, Inc.
15 * Copyright (c) 2014-2015 QLogic Corporation
19 #ifndef __BNA_TYPES_H__
20 #define __BNA_TYPES_H__
23 #include "bna_hw_defs.h"
27 /* Forward declarations */
29 struct bna_mcam_handle;
40 /* Enums, primitive data types */
43 BNA_STATUS_T_DISABLED = 0,
44 BNA_STATUS_T_ENABLED = 1
47 enum bna_cleanup_type {
57 BNA_CB_INVALID_MAC = 4,
58 BNA_CB_MCAST_LIST_FULL = 5,
59 BNA_CB_UCAST_CAM_FULL = 6,
79 enum bna_res_req_type {
80 BNA_RES_MEM_T_COM = 0,
81 BNA_RES_MEM_T_ATTR = 1,
82 BNA_RES_MEM_T_FWTRC = 2,
83 BNA_RES_MEM_T_STATS = 3,
87 enum bna_mod_res_req_type {
88 BNA_MOD_RES_MEM_T_TX_ARRAY = 0,
89 BNA_MOD_RES_MEM_T_TXQ_ARRAY = 1,
90 BNA_MOD_RES_MEM_T_RX_ARRAY = 2,
91 BNA_MOD_RES_MEM_T_RXP_ARRAY = 3,
92 BNA_MOD_RES_MEM_T_RXQ_ARRAY = 4,
93 BNA_MOD_RES_MEM_T_UCMAC_ARRAY = 5,
94 BNA_MOD_RES_MEM_T_MCMAC_ARRAY = 6,
95 BNA_MOD_RES_MEM_T_MCHANDLE_ARRAY = 7,
99 enum bna_tx_res_req_type {
100 BNA_TX_RES_MEM_T_TCB = 0,
101 BNA_TX_RES_MEM_T_UNMAPQ = 1,
102 BNA_TX_RES_MEM_T_QPT = 2,
103 BNA_TX_RES_MEM_T_SWQPT = 3,
104 BNA_TX_RES_MEM_T_PAGE = 4,
105 BNA_TX_RES_MEM_T_IBIDX = 5,
106 BNA_TX_RES_INTR_T_TXCMPL = 6,
110 enum bna_rx_mem_type {
111 BNA_RX_RES_MEM_T_CCB = 0, /* CQ context */
112 BNA_RX_RES_MEM_T_RCB = 1, /* CQ context */
113 BNA_RX_RES_MEM_T_UNMAPHQ = 2,
114 BNA_RX_RES_MEM_T_UNMAPDQ = 3,
115 BNA_RX_RES_MEM_T_CQPT = 4,
116 BNA_RX_RES_MEM_T_CSWQPT = 5,
117 BNA_RX_RES_MEM_T_CQPT_PAGE = 6,
118 BNA_RX_RES_MEM_T_HQPT = 7,
119 BNA_RX_RES_MEM_T_DQPT = 8,
120 BNA_RX_RES_MEM_T_HSWQPT = 9,
121 BNA_RX_RES_MEM_T_DSWQPT = 10,
122 BNA_RX_RES_MEM_T_DPAGE = 11,
123 BNA_RX_RES_MEM_T_HPAGE = 12,
124 BNA_RX_RES_MEM_T_IBIDX = 13,
125 BNA_RX_RES_MEM_T_RIT = 14,
126 BNA_RX_RES_T_INTR = 15,
127 BNA_RX_RES_T_MAX = 16
131 BNA_TX_T_REGULAR = 0,
132 BNA_TX_T_LOOPBACK = 1,
136 BNA_TX_F_ENET_STARTED = 1,
137 BNA_TX_F_ENABLED = 2,
138 BNA_TX_F_BW_UPDATED = 8,
141 enum bna_tx_mod_flags {
142 BNA_TX_MOD_F_ENET_STARTED = 1,
143 BNA_TX_MOD_F_ENET_LOOPBACK = 2,
147 BNA_RX_T_REGULAR = 0,
148 BNA_RX_T_LOOPBACK = 1,
158 BNA_RXMODE_PROMISC = 1,
159 BNA_RXMODE_DEFAULT = 2,
160 BNA_RXMODE_ALLMULTI = 4
169 RX_E_RXF_STARTED = 6,
170 RX_E_RXF_STOPPED = 7,
171 RX_E_CLEANUP_DONE = 8,
175 BNA_RX_F_ENET_STARTED = 1,
176 BNA_RX_F_ENABLED = 2,
179 enum bna_rx_mod_flags {
180 BNA_RX_MOD_F_ENET_STARTED = 1,
181 BNA_RX_MOD_F_ENET_LOOPBACK = 2,
193 BNA_ENET_T_REGULAR = 0,
194 BNA_ENET_T_LOOPBACK_INTERNAL = 1,
195 BNA_ENET_T_LOOPBACK_EXTERNAL = 2,
198 enum bna_link_status {
204 enum bna_ethport_flags {
205 BNA_ETHPORT_F_ADMIN_UP = 1,
206 BNA_ETHPORT_F_PORT_ENABLED = 2,
207 BNA_ETHPORT_F_RX_STARTED = 4,
210 enum bna_enet_flags {
211 BNA_ENET_F_IOCETH_READY = 1,
212 BNA_ENET_F_ENABLED = 2,
213 BNA_ENET_F_PAUSE_CHANGED = 4,
214 BNA_ENET_F_MTU_CHANGED = 8
218 BNA_RSS_F_RIT_PENDING = 1,
219 BNA_RSS_F_CFG_PENDING = 2,
220 BNA_RSS_F_STATUS_PENDING = 4,
224 BNA_MOD_F_INIT_DONE = 1,
228 BNA_PKT_RATE_10K = 10000,
229 BNA_PKT_RATE_20K = 20000,
230 BNA_PKT_RATE_30K = 30000,
231 BNA_PKT_RATE_40K = 40000,
232 BNA_PKT_RATE_50K = 50000,
233 BNA_PKT_RATE_60K = 60000,
234 BNA_PKT_RATE_70K = 70000,
235 BNA_PKT_RATE_80K = 80000,
238 enum bna_dim_load_types {
239 BNA_LOAD_T_HIGH_4 = 0, /* 80K <= r */
240 BNA_LOAD_T_HIGH_3 = 1, /* 60K <= r < 80K */
241 BNA_LOAD_T_HIGH_2 = 2, /* 50K <= r < 60K */
242 BNA_LOAD_T_HIGH_1 = 3, /* 40K <= r < 50K */
243 BNA_LOAD_T_LOW_1 = 4, /* 30K <= r < 40K */
244 BNA_LOAD_T_LOW_2 = 5, /* 20K <= r < 30K */
245 BNA_LOAD_T_LOW_3 = 6, /* 10K <= r < 20K */
246 BNA_LOAD_T_LOW_4 = 7, /* r < 10K */
250 enum bna_dim_bias_types {
251 BNA_BIAS_T_SMALL = 0, /* small pkts > (large pkts * 2) */
252 BNA_BIAS_T_LARGE = 1, /* Not BNA_BIAS_T_SMALL */
256 #define BNA_MAX_NAME_SIZE 64
259 char name[BNA_MAX_NAME_SIZE];
263 /* This should be the first one */
266 struct bna_mcam_handle *handle;
269 struct bna_mem_descr {
272 struct bna_dma_addr dma;
275 struct bna_mem_info {
276 enum bna_mem_type mem_type;
279 u32 align_sz; /* 0/1 = no alignment */
280 struct bna_mem_descr *mdl;
281 void *cookie; /* For bnad to unmap dma later */
284 struct bna_intr_descr {
288 struct bna_intr_info {
289 enum bna_intr_type intr_type;
291 struct bna_intr_descr *idl;
295 struct bna_mem_info mem_info;
296 struct bna_intr_info intr_info;
299 struct bna_res_info {
300 enum bna_res_type res_type;
301 union bna_res_u res_u;
306 struct bna_dma_addr hw_qpt_ptr;
313 bool fw_query_complete;
327 struct bna_attr attr;
328 struct bfa_msgq_cmd_entry msgq_cmd;
329 struct bfi_enet_attr_req attr_req;
331 void (*stop_cbfn)(struct bnad *bnad);
332 struct bnad *stop_cbarg;
339 /* Pause configuration */
340 struct bna_pause_config {
341 enum bna_status tx_pause;
342 enum bna_status rx_pause;
347 enum bna_enet_flags flags;
349 enum bna_enet_type type;
351 struct bna_pause_config pause_config;
354 /* Callback for bna_enet_disable(), enet_stop() */
355 void (*stop_cbfn)(void *);
358 /* Callback for bna_enet_mtu_set() */
359 void (*mtu_cbfn)(struct bnad *);
361 struct bfa_wc chld_stop_wc;
363 struct bfa_msgq_cmd_entry msgq_cmd;
364 struct bfi_enet_set_pause_req pause_req;
373 enum bna_ethport_flags flags;
375 enum bna_link_status link_status;
377 int rx_started_count;
379 void (*stop_cbfn)(struct bna_enet *);
381 void (*adminup_cbfn)(struct bnad *, enum bna_cb_status);
383 void (*link_cbfn)(struct bnad *, enum bna_link_status);
385 struct bfa_msgq_cmd_entry msgq_cmd;
387 struct bfi_enet_enable_req admin_req;
388 struct bfi_enet_diag_lb_req lpbk_req;
394 /* Interrupt Block */
396 /* Doorbell structure */
397 struct bna_ib_dbell {
398 void __iomem *doorbell_addr;
404 struct bna_dma_addr ib_seg_host_addr;
405 void *ib_seg_host_addr_kva;
407 struct bna_ib_dbell door_bell;
409 enum bna_intr_type intr_type;
412 u8 coalescing_timeo; /* Unit is 5usec. */
420 /* Tx datapath control structure */
421 #define BNA_Q_NAME_SIZE 16
429 volatile u32 *hw_consumer_index;
431 void __iomem *q_dbell;
432 struct bna_ib_dbell *i_dbell;
436 void *priv; /* BNAD's cookie */
437 enum bna_intr_type intr_type;
439 u8 priority; /* Current priority */
440 unsigned long flags; /* Used by bnad as required */
442 char name[BNA_Q_NAME_SIZE];
445 /* TxQ QPT and configuration */
447 /* This should be the first one */
466 /* This should be the first one */
472 enum bna_tx_flags flags;
474 enum bna_tx_type type;
477 struct list_head txq_q;
480 /* Tx event handlers */
481 void (*tcb_setup_cbfn)(struct bnad *, struct bna_tcb *);
482 void (*tcb_destroy_cbfn)(struct bnad *, struct bna_tcb *);
483 void (*tx_stall_cbfn)(struct bnad *, struct bna_tx *);
484 void (*tx_resume_cbfn)(struct bnad *, struct bna_tx *);
485 void (*tx_cleanup_cbfn)(struct bnad *, struct bna_tx *);
487 /* callback for bna_tx_disable(), bna_tx_stop() */
488 void (*stop_cbfn)(void *arg, struct bna_tx *tx);
491 struct bfa_msgq_cmd_entry msgq_cmd;
493 struct bfi_enet_tx_cfg_req cfg_req;
494 struct bfi_enet_req req;
495 struct bfi_enet_tx_cfg_rsp cfg_rsp;
499 void *priv; /* bnad's cookie */
502 /* Tx object configuration used during creation */
503 struct bna_tx_config {
506 int coalescing_timeo;
507 enum bna_tx_type tx_type;
510 struct bna_tx_event_cbfn {
512 void (*tcb_setup_cbfn)(struct bnad *, struct bna_tcb *);
513 void (*tcb_destroy_cbfn)(struct bnad *, struct bna_tcb *);
515 void (*tx_stall_cbfn)(struct bnad *, struct bna_tx *);
516 void (*tx_resume_cbfn)(struct bnad *, struct bna_tx *);
517 void (*tx_cleanup_cbfn)(struct bnad *, struct bna_tx *);
520 /* Tx module - keeps track of free, active tx objects */
522 struct bna_tx *tx; /* BFI_MAX_TXQ entries */
523 struct bna_txq *txq; /* BFI_MAX_TXQ entries */
525 struct list_head tx_free_q;
526 struct list_head tx_active_q;
528 struct list_head txq_free_q;
530 /* callback for bna_tx_mod_stop() */
531 void (*stop_cbfn)(struct bna_enet *enet);
533 struct bfa_wc tx_stop_wc;
535 enum bna_tx_mod_flags flags;
541 int prio_reconfigured;
550 /* Rx datapath control structure */
559 void __iomem *q_dbell;
564 void *priv; /* BNAD's cookie */
569 /* RxQ structure - QPT, configuration */
576 enum bna_status multi_buffer;
588 u64 rx_packets_with_error;
589 u64 rxbuf_alloc_failed;
590 u64 rxbuf_map_failed;
597 struct bna_rxq *data;
600 struct bna_rxq *small;
601 struct bna_rxq *large;
604 struct bna_rxq *only;
605 struct bna_rxq *reserved;
609 /* Packet rate for Dynamic Interrupt Moderation */
610 struct bna_pkt_rate {
615 /* Completion control structure */
621 volatile u32 *hw_producer_index;
623 struct bna_ib_dbell *i_dbell;
624 struct bna_rcb *rcb[2];
625 void *ctrl; /* For bnad */
626 struct bna_pkt_rate pkt_rate;
633 void *priv; /* BNAD's cookie */
634 enum bna_intr_type intr_type;
636 u8 rx_coalescing_timeo; /* For NAPI */
638 char name[BNA_Q_NAME_SIZE];
641 /* CQ QPT, configuration */
651 struct bna_rss_config {
652 enum bfi_enet_rss_type hash_type;
654 u32 toeplitz_hash_key[BFI_ENET_RSS_KEY_LEN];
657 struct bna_hds_config {
658 enum bfi_enet_hds_type hdr_type;
662 /* Rx object configuration used during creation */
663 struct bna_rx_config {
664 enum bna_rx_type rx_type;
666 enum bna_rxp_type rxp_type;
667 int coalescing_timeo;
669 * Small/Large (or Header/Data) buffer size to be configured
670 * for SLR and HDS queue type.
674 /* header or small queue */
678 /* data or large queue */
682 enum bna_status q0_multi_buf;
684 enum bna_status rss_status;
685 struct bna_rss_config rss_config;
687 struct bna_hds_config hds_config;
689 enum bna_status vlan_strip_status;
692 /* Rx Path structure - one per MSIX vector/CPU */
694 /* This should be the first one */
697 enum bna_rxp_type type;
703 /* MSI-x vector number for configuring RSS */
708 /* RxF structure (hardware Rx Function) */
712 struct bfa_msgq_cmd_entry msgq_cmd;
714 struct bfi_enet_enable_req req;
715 struct bfi_enet_rss_cfg_req rss_req;
716 struct bfi_enet_rit_req rit_req;
717 struct bfi_enet_rx_vlan_req vlan_req;
718 struct bfi_enet_mcast_add_req mcast_add_req;
719 struct bfi_enet_mcast_del_req mcast_del_req;
720 struct bfi_enet_ucast_req ucast_req;
723 /* callback for bna_rxf_start() */
724 void (*start_cbfn) (struct bna_rx *rx);
725 struct bna_rx *start_cbarg;
727 /* callback for bna_rxf_stop() */
728 void (*stop_cbfn) (struct bna_rx *rx);
729 struct bna_rx *stop_cbarg;
733 * bna_rxf_ucast_set()
734 * bna_rxf_{ucast/mcast}_add(),
735 * bna_rxf_{ucast/mcast}_del(),
738 void (*cam_fltr_cbfn)(struct bnad *bnad, struct bna_rx *rx);
739 struct bnad *cam_fltr_cbarg;
741 /* List of unicast addresses yet to be applied to h/w */
742 struct list_head ucast_pending_add_q;
743 struct list_head ucast_pending_del_q;
744 struct bna_mac *ucast_pending_mac;
745 int ucast_pending_set;
746 /* ucast addresses applied to the h/w */
747 struct list_head ucast_active_q;
748 struct bna_mac ucast_active_mac;
749 int ucast_active_set;
751 /* List of multicast addresses yet to be applied to h/w */
752 struct list_head mcast_pending_add_q;
753 struct list_head mcast_pending_del_q;
754 /* multicast addresses applied to the h/w */
755 struct list_head mcast_active_q;
756 struct list_head mcast_handle_q;
758 /* Rx modes yet to be applied to h/w */
759 enum bna_rxmode rxmode_pending;
760 enum bna_rxmode rxmode_pending_bitmask;
761 /* Rx modes applied to h/w */
762 enum bna_rxmode rxmode_active;
764 u8 vlan_pending_bitmask;
765 enum bna_status vlan_filter_status;
766 u32 vlan_filter_table[(BFI_ENET_VLAN_ID_MAX) / 32];
767 bool vlan_strip_pending;
768 enum bna_status vlan_strip_status;
770 enum bna_rss_flags rss_pending;
771 enum bna_status rss_status;
772 struct bna_rss_config rss_cfg;
781 /* This should be the first one */
788 enum bna_rx_type type;
791 struct list_head rxp_q;
793 struct bna_hds_config hds_cfg;
797 enum bna_rx_flags rx_flags;
799 struct bfa_msgq_cmd_entry msgq_cmd;
801 struct bfi_enet_rx_cfg_req cfg_req;
802 struct bfi_enet_req req;
803 struct bfi_enet_rx_cfg_rsp cfg_rsp;
806 /* Rx event handlers */
807 void (*rcb_setup_cbfn)(struct bnad *, struct bna_rcb *);
808 void (*rcb_destroy_cbfn)(struct bnad *, struct bna_rcb *);
809 void (*ccb_setup_cbfn)(struct bnad *, struct bna_ccb *);
810 void (*ccb_destroy_cbfn)(struct bnad *, struct bna_ccb *);
811 void (*rx_stall_cbfn)(struct bnad *, struct bna_rx *);
812 void (*rx_cleanup_cbfn)(struct bnad *, struct bna_rx *);
813 void (*rx_post_cbfn)(struct bnad *, struct bna_rx *);
815 /* callback for bna_rx_disable(), bna_rx_stop() */
816 void (*stop_cbfn)(void *arg, struct bna_rx *rx);
820 void *priv; /* bnad's cookie */
823 struct bna_rx_event_cbfn {
825 void (*rcb_setup_cbfn)(struct bnad *, struct bna_rcb *);
826 void (*rcb_destroy_cbfn)(struct bnad *, struct bna_rcb *);
827 void (*ccb_setup_cbfn)(struct bnad *, struct bna_ccb *);
828 void (*ccb_destroy_cbfn)(struct bnad *, struct bna_ccb *);
829 void (*rx_stall_cbfn)(struct bnad *, struct bna_rx *);
831 void (*rx_cleanup_cbfn)(struct bnad *, struct bna_rx *);
832 void (*rx_post_cbfn)(struct bnad *, struct bna_rx *);
835 /* Rx module - keeps track of free, active rx objects */
837 struct bna *bna; /* back pointer to parent */
838 struct bna_rx *rx; /* BFI_MAX_RXQ entries */
839 struct bna_rxp *rxp; /* BFI_MAX_RXQ entries */
840 struct bna_rxq *rxq; /* BFI_MAX_RXQ entries */
842 struct list_head rx_free_q;
843 struct list_head rx_active_q;
846 struct list_head rxp_free_q;
849 struct list_head rxq_free_q;
852 enum bna_rx_mod_flags flags;
854 /* callback for bna_rx_mod_stop() */
855 void (*stop_cbfn)(struct bna_enet *enet);
857 struct bfa_wc rx_stop_wc;
858 u32 dim_vector[BNA_LOAD_T_MAX][BNA_BIAS_T_MAX];
864 struct bna_ucam_mod {
865 struct bna_mac *ucmac; /* num_ucmac * 2 entries */
866 struct list_head free_q;
867 struct list_head del_q;
872 struct bna_mcam_handle {
873 /* This should be the first one */
879 struct bna_mcam_mod {
880 struct bna_mac *mcmac; /* num_mcmac * 2 entries */
881 struct bna_mcam_handle *mchandle; /* num_mcmac entries */
882 struct list_head free_q;
883 struct list_head del_q;
884 struct list_head free_handle_q;
892 struct bna_dma_addr hw_stats_dma;
893 struct bfi_enet_stats *hw_stats_kva;
894 struct bfi_enet_stats hw_stats;
897 struct bna_stats_mod {
901 struct bfa_msgq_cmd_entry stats_get_cmd;
902 struct bfa_msgq_cmd_entry stats_clr_cmd;
903 struct bfi_enet_stats_req stats_get;
904 struct bfi_enet_stats_req stats_clr;
910 struct bna_ident ident;
911 struct bfa_pcidev pcidev;
914 struct bna_bit_defn bits;
916 struct bna_stats stats;
918 struct bna_ioceth ioceth;
920 struct bfa_flash flash;
921 struct bfa_msgq msgq;
923 struct bna_ethport ethport;
924 struct bna_enet enet;
925 struct bna_stats_mod stats_mod;
927 struct bna_tx_mod tx_mod;
928 struct bna_rx_mod rx_mod;
929 struct bna_ucam_mod ucam_mod;
930 struct bna_mcam_mod mcam_mod;
932 enum bna_mod_flags mod_flags;
934 int default_mode_rid;
939 #endif /* __BNA_TYPES_H__ */