2 * Copyright (c) 2005-2010 Brocade Communications Systems, Inc.
6 * Linux driver for Brocade Fibre Channel Host Bus Adapter.
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License (GPL) Version 2 as
10 * published by the Free Software Foundation
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
19 * bfa_modules.h BFA modules
22 #ifndef __BFA_MODULES_H__
23 #define __BFA_MODULES_H__
28 #include "bfa_fcpim.h"
31 struct bfa_modules_s
{
32 struct bfa_fcdiag_s fcdiag
; /* fcdiag module */
33 struct bfa_fcport_s fcport
; /* fc port module */
34 struct bfa_fcxp_mod_s fcxp_mod
; /* fcxp module */
35 struct bfa_lps_mod_s lps_mod
; /* fcxp module */
36 struct bfa_uf_mod_s uf_mod
; /* unsolicited frame module */
37 struct bfa_rport_mod_s rport_mod
; /* remote port module */
38 struct bfa_fcp_mod_s fcp_mod
; /* FCP initiator module */
39 struct bfa_sgpg_mod_s sgpg_mod
; /* SG page module */
40 struct bfa_port_s port
; /* Physical port module */
41 struct bfa_ablk_s ablk
; /* ASIC block config module */
42 struct bfa_cee_s cee
; /* CEE Module */
43 struct bfa_sfp_s sfp
; /* SFP module */
44 struct bfa_flash_s flash
; /* flash module */
45 struct bfa_diag_s diag_mod
; /* diagnostics module */
46 struct bfa_phy_s phy
; /* phy module */
47 struct bfa_dconf_mod_s dconf_mod
; /* DCONF common module */
51 * !!! Only append to the enums defined here to avoid any versioning
52 * !!! needed between trace utility and driver version
57 BFA_TRC_HAL_FCPIM
= 3,
58 BFA_TRC_HAL_IOCFC_CT
= 4,
59 BFA_TRC_HAL_IOCFC_CB
= 5,
63 * Macro to define a new BFA module
65 #define BFA_MODULE(__mod) \
66 static void bfa_ ## __mod ## _meminfo( \
67 struct bfa_iocfc_cfg_s *cfg, \
68 struct bfa_meminfo_s *meminfo, \
70 static void bfa_ ## __mod ## _attach(struct bfa_s *bfa, \
71 void *bfad, struct bfa_iocfc_cfg_s *cfg, \
72 struct bfa_pcidev_s *pcidev); \
73 static void bfa_ ## __mod ## _detach(struct bfa_s *bfa); \
74 static void bfa_ ## __mod ## _start(struct bfa_s *bfa); \
75 static void bfa_ ## __mod ## _stop(struct bfa_s *bfa); \
76 static void bfa_ ## __mod ## _iocdisable(struct bfa_s *bfa); \
78 extern struct bfa_module_s hal_mod_ ## __mod; \
79 struct bfa_module_s hal_mod_ ## __mod = { \
80 bfa_ ## __mod ## _meminfo, \
81 bfa_ ## __mod ## _attach, \
82 bfa_ ## __mod ## _detach, \
83 bfa_ ## __mod ## _start, \
84 bfa_ ## __mod ## _stop, \
85 bfa_ ## __mod ## _iocdisable, \
88 #define BFA_CACHELINE_SZ (256)
91 * Structure used to interact between different BFA sub modules
93 * Each sub module needs to implement only the entry points relevant to it (and
94 * can leave entry points as NULL)
97 void (*meminfo
) (struct bfa_iocfc_cfg_s
*cfg
,
98 struct bfa_meminfo_s
*meminfo
,
100 void (*attach
) (struct bfa_s
*bfa
, void *bfad
,
101 struct bfa_iocfc_cfg_s
*cfg
,
102 struct bfa_pcidev_s
*pcidev
);
103 void (*detach
) (struct bfa_s
*bfa
);
104 void (*start
) (struct bfa_s
*bfa
);
105 void (*stop
) (struct bfa_s
*bfa
);
106 void (*iocdisable
) (struct bfa_s
*bfa
);
111 void *bfad
; /* BFA driver instance */
112 struct bfa_plog_s
*plog
; /* portlog buffer */
113 struct bfa_trc_mod_s
*trcmod
; /* driver tracing */
114 struct bfa_ioc_s ioc
; /* IOC module */
115 struct bfa_iocfc_s iocfc
; /* IOCFC module */
116 struct bfa_timer_mod_s timer_mod
; /* timer module */
117 struct bfa_modules_s modules
; /* BFA modules */
118 struct list_head comp_q
; /* pending completions */
119 bfa_boolean_t queue_process
; /* queue processing enabled */
120 struct list_head reqq_waitq
[BFI_IOC_MAX_CQS
];
121 bfa_boolean_t fcs
; /* FCS is attached to BFA */
122 struct bfa_msix_s msix
;
124 bfa_boolean_t intr_enabled
; /* Status of interrupts */
127 extern bfa_boolean_t bfa_auto_recover
;
128 extern struct bfa_module_s hal_mod_fcdiag
;
129 extern struct bfa_module_s hal_mod_sgpg
;
130 extern struct bfa_module_s hal_mod_fcport
;
131 extern struct bfa_module_s hal_mod_fcxp
;
132 extern struct bfa_module_s hal_mod_lps
;
133 extern struct bfa_module_s hal_mod_uf
;
134 extern struct bfa_module_s hal_mod_rport
;
135 extern struct bfa_module_s hal_mod_fcp
;
136 extern struct bfa_module_s hal_mod_dconf
;
138 #endif /* __BFA_MODULES_H__ */