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_PRIO_CHANGED = 4,
139 BNA_TX_F_BW_UPDATED = 8,
142 enum bna_tx_mod_flags {
143 BNA_TX_MOD_F_ENET_STARTED = 1,
144 BNA_TX_MOD_F_ENET_LOOPBACK = 2,
148 BNA_RX_T_REGULAR = 0,
149 BNA_RX_T_LOOPBACK = 1,
159 BNA_RXMODE_PROMISC = 1,
160 BNA_RXMODE_DEFAULT = 2,
161 BNA_RXMODE_ALLMULTI = 4
170 RX_E_RXF_STARTED = 6,
171 RX_E_RXF_STOPPED = 7,
172 RX_E_CLEANUP_DONE = 8,
176 BNA_RX_F_ENET_STARTED = 1,
177 BNA_RX_F_ENABLED = 2,
180 enum bna_rx_mod_flags {
181 BNA_RX_MOD_F_ENET_STARTED = 1,
182 BNA_RX_MOD_F_ENET_LOOPBACK = 2,
186 BNA_RXF_F_PAUSED = 1,
198 BNA_ENET_T_REGULAR = 0,
199 BNA_ENET_T_LOOPBACK_INTERNAL = 1,
200 BNA_ENET_T_LOOPBACK_EXTERNAL = 2,
203 enum bna_link_status {
209 enum bna_ethport_flags {
210 BNA_ETHPORT_F_ADMIN_UP = 1,
211 BNA_ETHPORT_F_PORT_ENABLED = 2,
212 BNA_ETHPORT_F_RX_STARTED = 4,
215 enum bna_enet_flags {
216 BNA_ENET_F_IOCETH_READY = 1,
217 BNA_ENET_F_ENABLED = 2,
218 BNA_ENET_F_PAUSE_CHANGED = 4,
219 BNA_ENET_F_MTU_CHANGED = 8
223 BNA_RSS_F_RIT_PENDING = 1,
224 BNA_RSS_F_CFG_PENDING = 2,
225 BNA_RSS_F_STATUS_PENDING = 4,
229 BNA_MOD_F_INIT_DONE = 1,
233 BNA_PKT_RATE_10K = 10000,
234 BNA_PKT_RATE_20K = 20000,
235 BNA_PKT_RATE_30K = 30000,
236 BNA_PKT_RATE_40K = 40000,
237 BNA_PKT_RATE_50K = 50000,
238 BNA_PKT_RATE_60K = 60000,
239 BNA_PKT_RATE_70K = 70000,
240 BNA_PKT_RATE_80K = 80000,
243 enum bna_dim_load_types {
244 BNA_LOAD_T_HIGH_4 = 0, /* 80K <= r */
245 BNA_LOAD_T_HIGH_3 = 1, /* 60K <= r < 80K */
246 BNA_LOAD_T_HIGH_2 = 2, /* 50K <= r < 60K */
247 BNA_LOAD_T_HIGH_1 = 3, /* 40K <= r < 50K */
248 BNA_LOAD_T_LOW_1 = 4, /* 30K <= r < 40K */
249 BNA_LOAD_T_LOW_2 = 5, /* 20K <= r < 30K */
250 BNA_LOAD_T_LOW_3 = 6, /* 10K <= r < 20K */
251 BNA_LOAD_T_LOW_4 = 7, /* r < 10K */
255 enum bna_dim_bias_types {
256 BNA_BIAS_T_SMALL = 0, /* small pkts > (large pkts * 2) */
257 BNA_BIAS_T_LARGE = 1, /* Not BNA_BIAS_T_SMALL */
261 #define BNA_MAX_NAME_SIZE 64
264 char name[BNA_MAX_NAME_SIZE];
268 /* This should be the first one */
271 struct bna_mcam_handle *handle;
274 struct bna_mem_descr {
277 struct bna_dma_addr dma;
280 struct bna_mem_info {
281 enum bna_mem_type mem_type;
284 u32 align_sz; /* 0/1 = no alignment */
285 struct bna_mem_descr *mdl;
286 void *cookie; /* For bnad to unmap dma later */
289 struct bna_intr_descr {
293 struct bna_intr_info {
294 enum bna_intr_type intr_type;
296 struct bna_intr_descr *idl;
300 struct bna_mem_info mem_info;
301 struct bna_intr_info intr_info;
304 struct bna_res_info {
305 enum bna_res_type res_type;
306 union bna_res_u res_u;
311 struct bna_dma_addr hw_qpt_ptr;
318 bool fw_query_complete;
332 struct bna_attr attr;
333 struct bfa_msgq_cmd_entry msgq_cmd;
334 struct bfi_enet_attr_req attr_req;
336 void (*stop_cbfn)(struct bnad *bnad);
337 struct bnad *stop_cbarg;
344 /* Pause configuration */
345 struct bna_pause_config {
346 enum bna_status tx_pause;
347 enum bna_status rx_pause;
352 enum bna_enet_flags flags;
354 enum bna_enet_type type;
356 struct bna_pause_config pause_config;
359 /* Callback for bna_enet_disable(), enet_stop() */
360 void (*stop_cbfn)(void *);
363 /* Callback for bna_enet_mtu_set() */
364 void (*mtu_cbfn)(struct bnad *);
366 struct bfa_wc chld_stop_wc;
368 struct bfa_msgq_cmd_entry msgq_cmd;
369 struct bfi_enet_set_pause_req pause_req;
378 enum bna_ethport_flags flags;
380 enum bna_link_status link_status;
382 int rx_started_count;
384 void (*stop_cbfn)(struct bna_enet *);
386 void (*adminup_cbfn)(struct bnad *, enum bna_cb_status);
388 void (*link_cbfn)(struct bnad *, enum bna_link_status);
390 struct bfa_msgq_cmd_entry msgq_cmd;
392 struct bfi_enet_enable_req admin_req;
393 struct bfi_enet_diag_lb_req lpbk_req;
399 /* Interrupt Block */
401 /* Doorbell structure */
402 struct bna_ib_dbell {
403 void __iomem *doorbell_addr;
409 struct bna_dma_addr ib_seg_host_addr;
410 void *ib_seg_host_addr_kva;
412 struct bna_ib_dbell door_bell;
414 enum bna_intr_type intr_type;
417 u8 coalescing_timeo; /* Unit is 5usec. */
425 /* Tx datapath control structure */
426 #define BNA_Q_NAME_SIZE 16
434 volatile u32 *hw_consumer_index;
436 void __iomem *q_dbell;
437 struct bna_ib_dbell *i_dbell;
441 void *priv; /* BNAD's cookie */
442 enum bna_intr_type intr_type;
444 u8 priority; /* Current priority */
445 unsigned long flags; /* Used by bnad as required */
447 char name[BNA_Q_NAME_SIZE];
450 /* TxQ QPT and configuration */
452 /* This should be the first one */
471 /* This should be the first one */
477 enum bna_tx_flags flags;
479 enum bna_tx_type type;
482 struct list_head txq_q;
485 /* Tx event handlers */
486 void (*tcb_setup_cbfn)(struct bnad *, struct bna_tcb *);
487 void (*tcb_destroy_cbfn)(struct bnad *, struct bna_tcb *);
488 void (*tx_stall_cbfn)(struct bnad *, struct bna_tx *);
489 void (*tx_resume_cbfn)(struct bnad *, struct bna_tx *);
490 void (*tx_cleanup_cbfn)(struct bnad *, struct bna_tx *);
492 /* callback for bna_tx_disable(), bna_tx_stop() */
493 void (*stop_cbfn)(void *arg, struct bna_tx *tx);
496 struct bfa_msgq_cmd_entry msgq_cmd;
498 struct bfi_enet_tx_cfg_req cfg_req;
499 struct bfi_enet_req req;
500 struct bfi_enet_tx_cfg_rsp cfg_rsp;
504 void *priv; /* bnad's cookie */
507 /* Tx object configuration used during creation */
508 struct bna_tx_config {
511 int coalescing_timeo;
512 enum bna_tx_type tx_type;
515 struct bna_tx_event_cbfn {
517 void (*tcb_setup_cbfn)(struct bnad *, struct bna_tcb *);
518 void (*tcb_destroy_cbfn)(struct bnad *, struct bna_tcb *);
520 void (*tx_stall_cbfn)(struct bnad *, struct bna_tx *);
521 void (*tx_resume_cbfn)(struct bnad *, struct bna_tx *);
522 void (*tx_cleanup_cbfn)(struct bnad *, struct bna_tx *);
525 /* Tx module - keeps track of free, active tx objects */
527 struct bna_tx *tx; /* BFI_MAX_TXQ entries */
528 struct bna_txq *txq; /* BFI_MAX_TXQ entries */
530 struct list_head tx_free_q;
531 struct list_head tx_active_q;
533 struct list_head txq_free_q;
535 /* callback for bna_tx_mod_stop() */
536 void (*stop_cbfn)(struct bna_enet *enet);
538 struct bfa_wc tx_stop_wc;
540 enum bna_tx_mod_flags flags;
546 int prio_reconfigured;
555 /* Rx datapath control structure */
564 void __iomem *q_dbell;
569 void *priv; /* BNAD's cookie */
574 /* RxQ structure - QPT, configuration */
581 enum bna_status multi_buffer;
593 u64 rx_packets_with_error;
594 u64 rxbuf_alloc_failed;
601 struct bna_rxq *data;
604 struct bna_rxq *small;
605 struct bna_rxq *large;
608 struct bna_rxq *only;
609 struct bna_rxq *reserved;
613 /* Packet rate for Dynamic Interrupt Moderation */
614 struct bna_pkt_rate {
619 /* Completion control structure */
625 volatile u32 *hw_producer_index;
627 struct bna_ib_dbell *i_dbell;
628 struct bna_rcb *rcb[2];
629 void *ctrl; /* For bnad */
630 struct bna_pkt_rate pkt_rate;
637 void *priv; /* BNAD's cookie */
638 enum bna_intr_type intr_type;
640 u8 rx_coalescing_timeo; /* For NAPI */
642 char name[BNA_Q_NAME_SIZE];
645 /* CQ QPT, configuration */
655 struct bna_rss_config {
656 enum bfi_enet_rss_type hash_type;
658 u32 toeplitz_hash_key[BFI_ENET_RSS_KEY_LEN];
661 struct bna_hds_config {
662 enum bfi_enet_hds_type hdr_type;
666 /* Rx object configuration used during creation */
667 struct bna_rx_config {
668 enum bna_rx_type rx_type;
670 enum bna_rxp_type rxp_type;
672 int coalescing_timeo;
674 * Small/Large (or Header/Data) buffer size to be configured
675 * for SLR and HDS queue type.
679 /* header or small queue */
683 /* data or large queue */
687 enum bna_status q0_multi_buf;
689 enum bna_status rss_status;
690 struct bna_rss_config rss_config;
692 struct bna_hds_config hds_config;
694 enum bna_status vlan_strip_status;
697 /* Rx Path structure - one per MSIX vector/CPU */
699 /* This should be the first one */
702 enum bna_rxp_type type;
708 /* MSI-x vector number for configuring RSS */
713 /* RxF structure (hardware Rx Function) */
716 enum bna_rxf_flags flags;
718 struct bfa_msgq_cmd_entry msgq_cmd;
720 struct bfi_enet_enable_req req;
721 struct bfi_enet_rss_cfg_req rss_req;
722 struct bfi_enet_rit_req rit_req;
723 struct bfi_enet_rx_vlan_req vlan_req;
724 struct bfi_enet_mcast_add_req mcast_add_req;
725 struct bfi_enet_mcast_del_req mcast_del_req;
726 struct bfi_enet_ucast_req ucast_req;
729 /* callback for bna_rxf_start() */
730 void (*start_cbfn) (struct bna_rx *rx);
731 struct bna_rx *start_cbarg;
733 /* callback for bna_rxf_stop() */
734 void (*stop_cbfn) (struct bna_rx *rx);
735 struct bna_rx *stop_cbarg;
739 * bna_rxf_ucast_set()
740 * bna_rxf_{ucast/mcast}_add(),
741 * bna_rxf_{ucast/mcast}_del(),
744 void (*cam_fltr_cbfn)(struct bnad *bnad, struct bna_rx *rx);
745 struct bnad *cam_fltr_cbarg;
747 /* List of unicast addresses yet to be applied to h/w */
748 struct list_head ucast_pending_add_q;
749 struct list_head ucast_pending_del_q;
750 struct bna_mac *ucast_pending_mac;
751 int ucast_pending_set;
752 /* ucast addresses applied to the h/w */
753 struct list_head ucast_active_q;
754 struct bna_mac ucast_active_mac;
755 int ucast_active_set;
757 /* List of multicast addresses yet to be applied to h/w */
758 struct list_head mcast_pending_add_q;
759 struct list_head mcast_pending_del_q;
760 /* multicast addresses applied to the h/w */
761 struct list_head mcast_active_q;
762 struct list_head mcast_handle_q;
764 /* Rx modes yet to be applied to h/w */
765 enum bna_rxmode rxmode_pending;
766 enum bna_rxmode rxmode_pending_bitmask;
767 /* Rx modes applied to h/w */
768 enum bna_rxmode rxmode_active;
770 u8 vlan_pending_bitmask;
771 enum bna_status vlan_filter_status;
772 u32 vlan_filter_table[(BFI_ENET_VLAN_ID_MAX) / 32];
773 bool vlan_strip_pending;
774 enum bna_status vlan_strip_status;
776 enum bna_rss_flags rss_pending;
777 enum bna_status rss_status;
778 struct bna_rss_config rss_cfg;
787 /* This should be the first one */
794 enum bna_rx_type type;
797 struct list_head rxp_q;
799 struct bna_hds_config hds_cfg;
803 enum bna_rx_flags rx_flags;
805 struct bfa_msgq_cmd_entry msgq_cmd;
807 struct bfi_enet_rx_cfg_req cfg_req;
808 struct bfi_enet_req req;
809 struct bfi_enet_rx_cfg_rsp cfg_rsp;
812 /* Rx event handlers */
813 void (*rcb_setup_cbfn)(struct bnad *, struct bna_rcb *);
814 void (*rcb_destroy_cbfn)(struct bnad *, struct bna_rcb *);
815 void (*ccb_setup_cbfn)(struct bnad *, struct bna_ccb *);
816 void (*ccb_destroy_cbfn)(struct bnad *, struct bna_ccb *);
817 void (*rx_stall_cbfn)(struct bnad *, struct bna_rx *);
818 void (*rx_cleanup_cbfn)(struct bnad *, struct bna_rx *);
819 void (*rx_post_cbfn)(struct bnad *, struct bna_rx *);
821 /* callback for bna_rx_disable(), bna_rx_stop() */
822 void (*stop_cbfn)(void *arg, struct bna_rx *rx);
826 void *priv; /* bnad's cookie */
829 struct bna_rx_event_cbfn {
831 void (*rcb_setup_cbfn)(struct bnad *, struct bna_rcb *);
832 void (*rcb_destroy_cbfn)(struct bnad *, struct bna_rcb *);
833 void (*ccb_setup_cbfn)(struct bnad *, struct bna_ccb *);
834 void (*ccb_destroy_cbfn)(struct bnad *, struct bna_ccb *);
835 void (*rx_stall_cbfn)(struct bnad *, struct bna_rx *);
837 void (*rx_cleanup_cbfn)(struct bnad *, struct bna_rx *);
838 void (*rx_post_cbfn)(struct bnad *, struct bna_rx *);
841 /* Rx module - keeps track of free, active rx objects */
843 struct bna *bna; /* back pointer to parent */
844 struct bna_rx *rx; /* BFI_MAX_RXQ entries */
845 struct bna_rxp *rxp; /* BFI_MAX_RXQ entries */
846 struct bna_rxq *rxq; /* BFI_MAX_RXQ entries */
848 struct list_head rx_free_q;
849 struct list_head rx_active_q;
852 struct list_head rxp_free_q;
855 struct list_head rxq_free_q;
858 enum bna_rx_mod_flags flags;
860 /* callback for bna_rx_mod_stop() */
861 void (*stop_cbfn)(struct bna_enet *enet);
863 struct bfa_wc rx_stop_wc;
864 u32 dim_vector[BNA_LOAD_T_MAX][BNA_BIAS_T_MAX];
870 struct bna_ucam_mod {
871 struct bna_mac *ucmac; /* num_ucmac * 2 entries */
872 struct list_head free_q;
873 struct list_head del_q;
878 struct bna_mcam_handle {
879 /* This should be the first one */
885 struct bna_mcam_mod {
886 struct bna_mac *mcmac; /* num_mcmac * 2 entries */
887 struct bna_mcam_handle *mchandle; /* num_mcmac entries */
888 struct list_head free_q;
889 struct list_head del_q;
890 struct list_head free_handle_q;
898 struct bna_dma_addr hw_stats_dma;
899 struct bfi_enet_stats *hw_stats_kva;
900 struct bfi_enet_stats hw_stats;
903 struct bna_stats_mod {
907 struct bfa_msgq_cmd_entry stats_get_cmd;
908 struct bfa_msgq_cmd_entry stats_clr_cmd;
909 struct bfi_enet_stats_req stats_get;
910 struct bfi_enet_stats_req stats_clr;
916 struct bna_ident ident;
917 struct bfa_pcidev pcidev;
920 struct bna_bit_defn bits;
922 struct bna_stats stats;
924 struct bna_ioceth ioceth;
926 struct bfa_flash flash;
927 struct bfa_msgq msgq;
929 struct bna_ethport ethport;
930 struct bna_enet enet;
931 struct bna_stats_mod stats_mod;
933 struct bna_tx_mod tx_mod;
934 struct bna_rx_mod rx_mod;
935 struct bna_ucam_mod ucam_mod;
936 struct bna_mcam_mod mcam_mod;
938 enum bna_mod_flags mod_flags;
940 int default_mode_rid;
945 #endif /* __BNA_TYPES_H__ */