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.
25 #define BFA_DBG_FWTRC_ENTS (BFI_IOC_TRC_ENTS)
26 #define BFA_DBG_FWTRC_LEN \
27 (BFA_DBG_FWTRC_ENTS * sizeof(struct bfa_trc_s) + \
28 (sizeof(struct bfa_trc_mod_s) - \
29 BFA_TRC_MAX * sizeof(struct bfa_trc_s)))
31 * BFA timer declarations
33 typedef void (*bfa_timer_cbfn_t)(void *);
36 * BFA timer data structure
40 bfa_timer_cbfn_t timercb;
42 int timeout; /* in millisecs */
46 * Timer module structure
48 struct bfa_timer_mod_s {
49 struct list_head timer_q;
52 #define BFA_TIMER_FREQ 200 /* specified in millisecs */
54 void bfa_timer_beat(struct bfa_timer_mod_s *mod);
55 void bfa_timer_begin(struct bfa_timer_mod_s *mod, struct bfa_timer_s *timer,
56 bfa_timer_cbfn_t timercb, void *arg,
57 unsigned int timeout);
58 void bfa_timer_stop(struct bfa_timer_s *timer);
61 * Generic Scatter Gather Element used by driver
68 #define bfa_sge_word_swap(__sge) do { \
69 ((u32 *)(__sge))[0] = swab32(((u32 *)(__sge))[0]); \
70 ((u32 *)(__sge))[1] = swab32(((u32 *)(__sge))[1]); \
71 ((u32 *)(__sge))[2] = swab32(((u32 *)(__sge))[2]); \
74 #define bfa_swap_words(_x) ( \
75 ((_x) << 32) | ((_x) >> 32))
78 #define bfa_sge_to_be(_x)
79 #define bfa_sge_to_le(_x) bfa_sge_word_swap(_x)
80 #define bfa_sgaddr_le(_x) bfa_swap_words(_x)
82 #define bfa_sge_to_be(_x) bfa_sge_word_swap(_x)
83 #define bfa_sge_to_le(_x)
84 #define bfa_sgaddr_le(_x) (_x)
88 * PCI device information required by IOC
94 void __iomem *pci_bar_kva;
98 * Structure used to remember the DMA-able memory block's KVA and Physical
102 void *kva; /* ! Kernel virtual address */
103 u64 pa; /* ! Physical address */
106 #define BFA_DMA_ALIGN_SZ 256
107 #define BFA_ROUNDUP(_l, _s) (((_l) + ((_s) - 1)) & ~((_s) - 1))
110 * smem size for Crossbow and Catapult
112 #define BFI_SMEM_CB_SIZE 0x200000U /* ! 2MB for crossbow */
113 #define BFI_SMEM_CT_SIZE 0x280000U /* ! 2.5MB for catapult */
115 #define bfa_dma_be_addr_set(dma_addr, pa) \
116 __bfa_dma_be_addr_set(&dma_addr, (u64)pa)
118 __bfa_dma_be_addr_set(union bfi_addr_u *dma_addr, u64 pa)
120 dma_addr->a32.addr_lo = cpu_to_be32(pa);
121 dma_addr->a32.addr_hi = cpu_to_be32(pa >> 32);
124 #define bfa_alen_set(__alen, __len, __pa) \
125 __bfa_alen_set(__alen, __len, (u64)__pa)
128 __bfa_alen_set(struct bfi_alen_s *alen, u32 len, u64 pa)
130 alen->al_len = cpu_to_be32(len);
131 bfa_dma_be_addr_set(alen->al_addr, pa);
134 struct bfa_ioc_regs_s {
135 void __iomem *hfn_mbox_cmd;
136 void __iomem *hfn_mbox;
137 void __iomem *lpu_mbox_cmd;
138 void __iomem *lpu_mbox;
139 void __iomem *pss_ctl_reg;
140 void __iomem *pss_err_status_reg;
141 void __iomem *app_pll_fast_ctl_reg;
142 void __iomem *app_pll_slow_ctl_reg;
143 void __iomem *ioc_sem_reg;
144 void __iomem *ioc_usage_sem_reg;
145 void __iomem *ioc_init_sem_reg;
146 void __iomem *ioc_usage_reg;
147 void __iomem *host_page_num_fn;
148 void __iomem *heartbeat;
149 void __iomem *ioc_fwstate;
150 void __iomem *alt_ioc_fwstate;
151 void __iomem *ll_halt;
152 void __iomem *alt_ll_halt;
153 void __iomem *err_set;
154 void __iomem *ioc_fail_sync;
155 void __iomem *shirq_isr_next;
156 void __iomem *shirq_msk_next;
157 void __iomem *smem_page_start;
161 #define bfa_mem_read(_raddr, _off) swab32(readl(((_raddr) + (_off))))
162 #define bfa_mem_write(_raddr, _off, _val) \
163 writel(swab32((_val)), ((_raddr) + (_off)))
165 * IOC Mailbox structures
167 struct bfa_mbox_cmd_s {
169 u32 msg[BFI_IOC_MSGSZ];
175 typedef void (*bfa_ioc_mbox_mcfunc_t)(void *cbarg, struct bfi_mbmsg_s *m);
176 struct bfa_ioc_mbox_mod_s {
177 struct list_head cmd_q; /* pending mbox queue */
178 int nmclass; /* number of handlers */
180 bfa_ioc_mbox_mcfunc_t cbfn; /* message handlers */
182 } mbhdlr[BFI_MC_MAX];
186 * IOC callback function interfaces
188 typedef void (*bfa_ioc_enable_cbfn_t)(void *bfa, enum bfa_status status);
189 typedef void (*bfa_ioc_disable_cbfn_t)(void *bfa);
190 typedef void (*bfa_ioc_hbfail_cbfn_t)(void *bfa);
191 typedef void (*bfa_ioc_reset_cbfn_t)(void *bfa);
192 struct bfa_ioc_cbfn_s {
193 bfa_ioc_enable_cbfn_t enable_cbfn;
194 bfa_ioc_disable_cbfn_t disable_cbfn;
195 bfa_ioc_hbfail_cbfn_t hbfail_cbfn;
196 bfa_ioc_reset_cbfn_t reset_cbfn;
200 * Heartbeat failure notification queue element.
202 struct bfa_ioc_hbfail_notify_s {
204 bfa_ioc_hbfail_cbfn_t cbfn;
209 * Initialize a heartbeat failure notification structure
211 #define bfa_ioc_hbfail_init(__notify, __cbfn, __cbarg) do { \
212 (__notify)->cbfn = (__cbfn); \
213 (__notify)->cbarg = (__cbarg); \
218 struct bfa_ioc_s *ioc;
220 bfa_boolean_t auto_recover;
226 struct bfa_pcidev_s pcidev;
227 struct bfa_timer_mod_s *timer_mod;
228 struct bfa_timer_s ioc_timer;
229 struct bfa_timer_s sem_timer;
230 struct bfa_timer_s hb_timer;
232 struct list_head hb_notify_q;
235 bfa_boolean_t dbg_fwsave_once;
236 enum bfi_mclass ioc_mc;
237 struct bfa_ioc_regs_s ioc_regs;
238 struct bfa_trc_mod_s *trcmod;
239 struct bfa_ioc_drv_stats_s stats;
240 bfa_boolean_t fcmode;
243 bfa_boolean_t pllinit;
244 bfa_boolean_t stats_busy; /* outstanding stats */
246 struct bfa_dma_s attr_dma;
247 struct bfi_ioc_attr_s *attr;
248 struct bfa_ioc_cbfn_s *cbfn;
249 struct bfa_ioc_mbox_mod_s mbox_mod;
250 struct bfa_ioc_hwif_s *ioc_hwif;
251 struct bfa_iocpf_s iocpf;
254 struct bfa_ioc_hwif_s {
255 bfa_status_t (*ioc_pll_init) (void __iomem *rb, bfa_boolean_t fcmode);
256 bfa_boolean_t (*ioc_firmware_lock) (struct bfa_ioc_s *ioc);
257 void (*ioc_firmware_unlock) (struct bfa_ioc_s *ioc);
258 void (*ioc_reg_init) (struct bfa_ioc_s *ioc);
259 void (*ioc_map_port) (struct bfa_ioc_s *ioc);
260 void (*ioc_isr_mode_set) (struct bfa_ioc_s *ioc,
262 void (*ioc_notify_fail) (struct bfa_ioc_s *ioc);
263 void (*ioc_ownership_reset) (struct bfa_ioc_s *ioc);
264 bfa_boolean_t (*ioc_sync_start) (struct bfa_ioc_s *ioc);
265 void (*ioc_sync_join) (struct bfa_ioc_s *ioc);
266 void (*ioc_sync_leave) (struct bfa_ioc_s *ioc);
267 void (*ioc_sync_ack) (struct bfa_ioc_s *ioc);
268 bfa_boolean_t (*ioc_sync_complete) (struct bfa_ioc_s *ioc);
271 #define bfa_ioc_pcifn(__ioc) ((__ioc)->pcidev.pci_func)
272 #define bfa_ioc_devid(__ioc) ((__ioc)->pcidev.device_id)
273 #define bfa_ioc_bar0(__ioc) ((__ioc)->pcidev.pci_bar_kva)
274 #define bfa_ioc_portid(__ioc) ((__ioc)->port_id)
275 #define bfa_ioc_fetch_stats(__ioc, __stats) \
276 (((__stats)->drv_stats) = (__ioc)->stats)
277 #define bfa_ioc_clr_stats(__ioc) \
278 memset(&(__ioc)->stats, 0, sizeof((__ioc)->stats))
279 #define bfa_ioc_maxfrsize(__ioc) ((__ioc)->attr->maxfrsize)
280 #define bfa_ioc_rx_bbcredit(__ioc) ((__ioc)->attr->rx_bbcredit)
281 #define bfa_ioc_speed_sup(__ioc) \
282 BFI_ADAPTER_GETP(SPEED, (__ioc)->attr->adapter_prop)
283 #define bfa_ioc_get_nports(__ioc) \
284 BFI_ADAPTER_GETP(NPORTS, (__ioc)->attr->adapter_prop)
286 #define bfa_ioc_stats(_ioc, _stats) ((_ioc)->stats._stats++)
287 #define BFA_IOC_FWIMG_MINSZ (16 * 1024)
288 #define BFA_IOC_FWIMG_TYPE(__ioc) \
289 (((__ioc)->ctdev) ? \
290 (((__ioc)->fcmode) ? BFI_IMAGE_CT_FC : BFI_IMAGE_CT_CNA) : \
292 #define BFA_IOC_FW_SMEM_SIZE(__ioc) \
293 (((__ioc)->ctdev) ? BFI_SMEM_CT_SIZE : BFI_SMEM_CB_SIZE)
294 #define BFA_IOC_FLASH_CHUNK_NO(off) (off / BFI_FLASH_CHUNK_SZ_WORDS)
295 #define BFA_IOC_FLASH_OFFSET_IN_CHUNK(off) (off % BFI_FLASH_CHUNK_SZ_WORDS)
296 #define BFA_IOC_FLASH_CHUNK_ADDR(chunkno) (chunkno * BFI_FLASH_CHUNK_SZ_WORDS)
299 * IOC mailbox interface
301 void bfa_ioc_mbox_queue(struct bfa_ioc_s *ioc, struct bfa_mbox_cmd_s *cmd);
302 void bfa_ioc_mbox_register(struct bfa_ioc_s *ioc,
303 bfa_ioc_mbox_mcfunc_t *mcfuncs);
304 void bfa_ioc_mbox_isr(struct bfa_ioc_s *ioc);
305 void bfa_ioc_mbox_send(struct bfa_ioc_s *ioc, void *ioc_msg, int len);
306 void bfa_ioc_msgget(struct bfa_ioc_s *ioc, void *mbmsg);
307 void bfa_ioc_mbox_regisr(struct bfa_ioc_s *ioc, enum bfi_mclass mc,
308 bfa_ioc_mbox_mcfunc_t cbfn, void *cbarg);
314 #define bfa_ioc_pll_init_asic(__ioc) \
315 ((__ioc)->ioc_hwif->ioc_pll_init((__ioc)->pcidev.pci_bar_kva, \
318 bfa_status_t bfa_ioc_pll_init(struct bfa_ioc_s *ioc);
319 bfa_status_t bfa_ioc_cb_pll_init(void __iomem *rb, bfa_boolean_t fcmode);
320 bfa_boolean_t bfa_ioc_ct_pll_init_complete(void __iomem *rb);
321 bfa_status_t bfa_ioc_ct_pll_init(void __iomem *rb, bfa_boolean_t fcmode);
323 #define bfa_ioc_isr_mode_set(__ioc, __msix) \
324 ((__ioc)->ioc_hwif->ioc_isr_mode_set(__ioc, __msix))
325 #define bfa_ioc_ownership_reset(__ioc) \
326 ((__ioc)->ioc_hwif->ioc_ownership_reset(__ioc))
329 void bfa_ioc_set_ct_hwif(struct bfa_ioc_s *ioc);
330 void bfa_ioc_set_cb_hwif(struct bfa_ioc_s *ioc);
332 void bfa_ioc_attach(struct bfa_ioc_s *ioc, void *bfa,
333 struct bfa_ioc_cbfn_s *cbfn, struct bfa_timer_mod_s *timer_mod);
334 void bfa_ioc_auto_recover(bfa_boolean_t auto_recover);
335 void bfa_ioc_detach(struct bfa_ioc_s *ioc);
336 void bfa_ioc_pci_init(struct bfa_ioc_s *ioc, struct bfa_pcidev_s *pcidev,
338 void bfa_ioc_mem_claim(struct bfa_ioc_s *ioc, u8 *dm_kva, u64 dm_pa);
339 void bfa_ioc_enable(struct bfa_ioc_s *ioc);
340 void bfa_ioc_disable(struct bfa_ioc_s *ioc);
341 bfa_boolean_t bfa_ioc_intx_claim(struct bfa_ioc_s *ioc);
343 void bfa_ioc_boot(struct bfa_ioc_s *ioc, u32 boot_type,
345 void bfa_ioc_isr(struct bfa_ioc_s *ioc, struct bfi_mbmsg_s *msg);
346 void bfa_ioc_error_isr(struct bfa_ioc_s *ioc);
347 bfa_boolean_t bfa_ioc_is_operational(struct bfa_ioc_s *ioc);
348 bfa_boolean_t bfa_ioc_is_initialized(struct bfa_ioc_s *ioc);
349 bfa_boolean_t bfa_ioc_is_disabled(struct bfa_ioc_s *ioc);
350 bfa_boolean_t bfa_ioc_fw_mismatch(struct bfa_ioc_s *ioc);
351 bfa_boolean_t bfa_ioc_adapter_is_disabled(struct bfa_ioc_s *ioc);
352 void bfa_ioc_reset_fwstate(struct bfa_ioc_s *ioc);
353 enum bfa_ioc_type_e bfa_ioc_get_type(struct bfa_ioc_s *ioc);
354 void bfa_ioc_get_adapter_serial_num(struct bfa_ioc_s *ioc, char *serial_num);
355 void bfa_ioc_get_adapter_fw_ver(struct bfa_ioc_s *ioc, char *fw_ver);
356 void bfa_ioc_get_adapter_optrom_ver(struct bfa_ioc_s *ioc, char *optrom_ver);
357 void bfa_ioc_get_adapter_model(struct bfa_ioc_s *ioc, char *model);
358 void bfa_ioc_get_adapter_manufacturer(struct bfa_ioc_s *ioc,
360 void bfa_ioc_get_pci_chip_rev(struct bfa_ioc_s *ioc, char *chip_rev);
361 enum bfa_ioc_state bfa_ioc_get_state(struct bfa_ioc_s *ioc);
363 void bfa_ioc_get_attr(struct bfa_ioc_s *ioc, struct bfa_ioc_attr_s *ioc_attr);
364 void bfa_ioc_get_adapter_attr(struct bfa_ioc_s *ioc,
365 struct bfa_adapter_attr_s *ad_attr);
366 void bfa_ioc_debug_memclaim(struct bfa_ioc_s *ioc, void *dbg_fwsave);
367 bfa_status_t bfa_ioc_debug_fwsave(struct bfa_ioc_s *ioc, void *trcdata,
369 bfa_status_t bfa_ioc_debug_fwtrc(struct bfa_ioc_s *ioc, void *trcdata,
371 bfa_status_t bfa_ioc_debug_fwcore(struct bfa_ioc_s *ioc, void *buf,
372 u32 *offset, int *buflen);
373 void bfa_ioc_set_fcmode(struct bfa_ioc_s *ioc);
374 bfa_boolean_t bfa_ioc_get_fcmode(struct bfa_ioc_s *ioc);
375 bfa_boolean_t bfa_ioc_sem_get(void __iomem *sem_reg);
376 void bfa_ioc_fwver_get(struct bfa_ioc_s *ioc,
377 struct bfi_ioc_image_hdr_s *fwhdr);
378 bfa_boolean_t bfa_ioc_fwver_cmp(struct bfa_ioc_s *ioc,
379 struct bfi_ioc_image_hdr_s *fwhdr);
380 bfa_status_t bfa_ioc_fw_stats_get(struct bfa_ioc_s *ioc, void *stats);
381 bfa_status_t bfa_ioc_fw_stats_clear(struct bfa_ioc_s *ioc);
384 * bfa mfg wwn API functions
386 mac_t bfa_ioc_get_mac(struct bfa_ioc_s *ioc);
387 mac_t bfa_ioc_get_mfg_mac(struct bfa_ioc_s *ioc);
390 * F/W Image Size & Chunk
392 extern u32 bfi_image_ct_fc_size;
393 extern u32 bfi_image_ct_cna_size;
394 extern u32 bfi_image_cb_fc_size;
395 extern u32 *bfi_image_ct_fc;
396 extern u32 *bfi_image_ct_cna;
397 extern u32 *bfi_image_cb_fc;
400 bfi_image_ct_fc_get_chunk(u32 off)
401 { return (u32 *)(bfi_image_ct_fc + off); }
404 bfi_image_ct_cna_get_chunk(u32 off)
405 { return (u32 *)(bfi_image_ct_cna + off); }
408 bfi_image_cb_fc_get_chunk(u32 off)
409 { return (u32 *)(bfi_image_cb_fc + off); }
412 bfa_cb_image_get_chunk(int type, u32 off)
415 case BFI_IMAGE_CT_FC:
416 return bfi_image_ct_fc_get_chunk(off); break;
417 case BFI_IMAGE_CT_CNA:
418 return bfi_image_ct_cna_get_chunk(off); break;
419 case BFI_IMAGE_CB_FC:
420 return bfi_image_cb_fc_get_chunk(off); break;
421 default: return NULL;
426 bfa_cb_image_get_size(int type)
429 case BFI_IMAGE_CT_FC:
430 return bfi_image_ct_fc_size; break;
431 case BFI_IMAGE_CT_CNA:
432 return bfi_image_ct_cna_size; break;
433 case BFI_IMAGE_CB_FC:
434 return bfi_image_cb_fc_size; break;
440 * CNA TRCMOD declaration
443 * !!! Only append to the enums defined here to avoid any versioning
444 * !!! needed between trace utility and driver version
447 BFA_TRC_CNA_PORT = 1,
449 BFA_TRC_CNA_IOC_CB = 3,
450 BFA_TRC_CNA_IOC_CT = 4,
453 #endif /* __BFA_IOC_H__ */