[SCSI] bfa: IOC and PLL init changes for Brocade-1860 Fabric Adapter.
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / scsi / bfa / bfa_ioc.h
blob8c9bbdf26482d1b6b6e8a06623951b4ebd48826e
1 /*
2 * Copyright (c) 2005-2010 Brocade Communications Systems, Inc.
3 * All rights reserved
4 * www.brocade.com
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.
18 #ifndef __BFA_IOC_H__
19 #define __BFA_IOC_H__
21 #include "bfad_drv.h"
22 #include "bfa_cs.h"
23 #include "bfi.h"
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
38 struct bfa_timer_s {
39 struct list_head qe;
40 bfa_timer_cbfn_t timercb;
41 void *arg;
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
63 struct bfa_sge_s {
64 u32 sg_len;
65 void *sg_addr;
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]); \
72 } while (0)
74 #define bfa_swap_words(_x) ( \
75 ((_x) << 32) | ((_x) >> 32))
77 #ifdef __BIG_ENDIAN
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)
81 #else
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)
85 #endif
88 * PCI device information required by IOC
90 struct bfa_pcidev_s {
91 int pci_slot;
92 u8 pci_func;
93 u16 device_id;
94 void __iomem *pci_bar_kva;
98 * Structure used to remember the DMA-able memory block's KVA and Physical
99 * Address
101 struct bfa_dma_s {
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)
117 static inline void
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)
127 static inline void
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;
158 u32 smem_pg0;
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 {
168 struct list_head qe;
169 u32 msg[BFI_IOC_MSGSZ];
173 * IOC mailbox module
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 */
179 struct {
180 bfa_ioc_mbox_mcfunc_t cbfn; /* message handlers */
181 void *cbarg;
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 * IOC event notification mechanism.
202 enum bfa_ioc_event_e {
203 BFA_IOC_E_ENABLED = 1,
204 BFA_IOC_E_DISABLED = 2,
205 BFA_IOC_E_FAILED = 3,
208 typedef void (*bfa_ioc_notify_cbfn_t)(void *, enum bfa_ioc_event_e);
210 struct bfa_ioc_notify_s {
211 struct list_head qe;
212 bfa_ioc_notify_cbfn_t cbfn;
213 void *cbarg;
217 * Initialize a IOC event notification structure
219 #define bfa_ioc_notify_init(__notify, __cbfn, __cbarg) do { \
220 (__notify)->cbfn = (__cbfn); \
221 (__notify)->cbarg = (__cbarg); \
222 } while (0)
224 struct bfa_iocpf_s {
225 bfa_fsm_t fsm;
226 struct bfa_ioc_s *ioc;
227 bfa_boolean_t fw_mismatch_notified;
228 bfa_boolean_t auto_recover;
229 u32 poll_time;
232 struct bfa_ioc_s {
233 bfa_fsm_t fsm;
234 struct bfa_s *bfa;
235 struct bfa_pcidev_s pcidev;
236 struct bfa_timer_mod_s *timer_mod;
237 struct bfa_timer_s ioc_timer;
238 struct bfa_timer_s sem_timer;
239 struct bfa_timer_s hb_timer;
240 u32 hb_count;
241 struct list_head notify_q;
242 void *dbg_fwsave;
243 int dbg_fwsave_len;
244 bfa_boolean_t dbg_fwsave_once;
245 enum bfi_pcifn_class clscode;
246 struct bfa_ioc_regs_s ioc_regs;
247 struct bfa_trc_mod_s *trcmod;
248 struct bfa_ioc_drv_stats_s stats;
249 bfa_boolean_t fcmode;
250 bfa_boolean_t pllinit;
251 bfa_boolean_t stats_busy; /* outstanding stats */
252 u8 port_id;
253 struct bfa_dma_s attr_dma;
254 struct bfi_ioc_attr_s *attr;
255 struct bfa_ioc_cbfn_s *cbfn;
256 struct bfa_ioc_mbox_mod_s mbox_mod;
257 struct bfa_ioc_hwif_s *ioc_hwif;
258 struct bfa_iocpf_s iocpf;
259 enum bfi_asic_gen asic_gen;
260 enum bfi_asic_mode asic_mode;
261 enum bfi_port_mode port0_mode;
262 enum bfi_port_mode port1_mode;
265 struct bfa_ioc_hwif_s {
266 bfa_status_t (*ioc_pll_init) (void __iomem *rb, enum bfi_asic_mode m);
267 bfa_boolean_t (*ioc_firmware_lock) (struct bfa_ioc_s *ioc);
268 void (*ioc_firmware_unlock) (struct bfa_ioc_s *ioc);
269 void (*ioc_reg_init) (struct bfa_ioc_s *ioc);
270 void (*ioc_map_port) (struct bfa_ioc_s *ioc);
271 void (*ioc_isr_mode_set) (struct bfa_ioc_s *ioc,
272 bfa_boolean_t msix);
273 void (*ioc_notify_fail) (struct bfa_ioc_s *ioc);
274 void (*ioc_ownership_reset) (struct bfa_ioc_s *ioc);
275 bfa_boolean_t (*ioc_sync_start) (struct bfa_ioc_s *ioc);
276 void (*ioc_sync_join) (struct bfa_ioc_s *ioc);
277 void (*ioc_sync_leave) (struct bfa_ioc_s *ioc);
278 void (*ioc_sync_ack) (struct bfa_ioc_s *ioc);
279 bfa_boolean_t (*ioc_sync_complete) (struct bfa_ioc_s *ioc);
282 #define bfa_ioc_pcifn(__ioc) ((__ioc)->pcidev.pci_func)
283 #define bfa_ioc_devid(__ioc) ((__ioc)->pcidev.device_id)
284 #define bfa_ioc_bar0(__ioc) ((__ioc)->pcidev.pci_bar_kva)
285 #define bfa_ioc_portid(__ioc) ((__ioc)->port_id)
286 #define bfa_ioc_asic_gen(__ioc) ((__ioc)->asic_gen)
287 #define bfa_ioc_is_cna(__ioc) \
288 ((bfa_ioc_get_type(ioc) == BFA_IOC_TYPE_FCoE) || \
289 (bfa_ioc_get_type(ioc) == BFA_IOC_TYPE_LL))
290 #define bfa_ioc_fetch_stats(__ioc, __stats) \
291 (((__stats)->drv_stats) = (__ioc)->stats)
292 #define bfa_ioc_clr_stats(__ioc) \
293 memset(&(__ioc)->stats, 0, sizeof((__ioc)->stats))
294 #define bfa_ioc_maxfrsize(__ioc) ((__ioc)->attr->maxfrsize)
295 #define bfa_ioc_rx_bbcredit(__ioc) ((__ioc)->attr->rx_bbcredit)
296 #define bfa_ioc_speed_sup(__ioc) \
297 BFI_ADAPTER_GETP(SPEED, (__ioc)->attr->adapter_prop)
298 #define bfa_ioc_get_nports(__ioc) \
299 BFI_ADAPTER_GETP(NPORTS, (__ioc)->attr->adapter_prop)
301 #define bfa_ioc_stats(_ioc, _stats) ((_ioc)->stats._stats++)
302 #define BFA_IOC_FWIMG_MINSZ (16 * 1024)
303 #define BFA_IOC_FW_SMEM_SIZE(__ioc) \
304 ((bfa_ioc_asic_gen(__ioc) == BFI_ASIC_GEN_CB) \
305 ? BFI_SMEM_CB_SIZE : BFI_SMEM_CT_SIZE)
306 #define BFA_IOC_FLASH_CHUNK_NO(off) (off / BFI_FLASH_CHUNK_SZ_WORDS)
307 #define BFA_IOC_FLASH_OFFSET_IN_CHUNK(off) (off % BFI_FLASH_CHUNK_SZ_WORDS)
308 #define BFA_IOC_FLASH_CHUNK_ADDR(chunkno) (chunkno * BFI_FLASH_CHUNK_SZ_WORDS)
311 * IOC mailbox interface
313 void bfa_ioc_mbox_queue(struct bfa_ioc_s *ioc, struct bfa_mbox_cmd_s *cmd);
314 void bfa_ioc_mbox_register(struct bfa_ioc_s *ioc,
315 bfa_ioc_mbox_mcfunc_t *mcfuncs);
316 void bfa_ioc_mbox_isr(struct bfa_ioc_s *ioc);
317 void bfa_ioc_mbox_send(struct bfa_ioc_s *ioc, void *ioc_msg, int len);
318 bfa_boolean_t bfa_ioc_msgget(struct bfa_ioc_s *ioc, void *mbmsg);
319 void bfa_ioc_mbox_regisr(struct bfa_ioc_s *ioc, enum bfi_mclass mc,
320 bfa_ioc_mbox_mcfunc_t cbfn, void *cbarg);
323 * IOC interfaces
326 #define bfa_ioc_pll_init_asic(__ioc) \
327 ((__ioc)->ioc_hwif->ioc_pll_init((__ioc)->pcidev.pci_bar_kva, \
328 (__ioc)->asic_mode))
330 bfa_status_t bfa_ioc_pll_init(struct bfa_ioc_s *ioc);
331 bfa_status_t bfa_ioc_cb_pll_init(void __iomem *rb, enum bfi_asic_mode mode);
332 bfa_status_t bfa_ioc_ct_pll_init(void __iomem *rb, enum bfi_asic_mode mode);
333 bfa_status_t bfa_ioc_ct2_pll_init(void __iomem *rb, enum bfi_asic_mode mode);
335 #define bfa_ioc_isr_mode_set(__ioc, __msix) do { \
336 if ((__ioc)->ioc_hwif->ioc_isr_mode_set) \
337 ((__ioc)->ioc_hwif->ioc_isr_mode_set(__ioc, __msix)); \
338 } while (0)
339 #define bfa_ioc_ownership_reset(__ioc) \
340 ((__ioc)->ioc_hwif->ioc_ownership_reset(__ioc))
343 void bfa_ioc_set_cb_hwif(struct bfa_ioc_s *ioc);
344 void bfa_ioc_set_ct_hwif(struct bfa_ioc_s *ioc);
345 void bfa_ioc_set_ct2_hwif(struct bfa_ioc_s *ioc);
346 void bfa_ioc_ct2_poweron(struct bfa_ioc_s *ioc);
348 void bfa_ioc_attach(struct bfa_ioc_s *ioc, void *bfa,
349 struct bfa_ioc_cbfn_s *cbfn, struct bfa_timer_mod_s *timer_mod);
350 void bfa_ioc_auto_recover(bfa_boolean_t auto_recover);
351 void bfa_ioc_detach(struct bfa_ioc_s *ioc);
352 void bfa_ioc_pci_init(struct bfa_ioc_s *ioc, struct bfa_pcidev_s *pcidev,
353 enum bfi_pcifn_class clscode);
354 void bfa_ioc_mem_claim(struct bfa_ioc_s *ioc, u8 *dm_kva, u64 dm_pa);
355 void bfa_ioc_enable(struct bfa_ioc_s *ioc);
356 void bfa_ioc_disable(struct bfa_ioc_s *ioc);
357 bfa_boolean_t bfa_ioc_intx_claim(struct bfa_ioc_s *ioc);
359 void bfa_ioc_boot(struct bfa_ioc_s *ioc, u32 boot_type,
360 u32 boot_env);
361 void bfa_ioc_isr(struct bfa_ioc_s *ioc, struct bfi_mbmsg_s *msg);
362 void bfa_ioc_error_isr(struct bfa_ioc_s *ioc);
363 bfa_boolean_t bfa_ioc_is_operational(struct bfa_ioc_s *ioc);
364 bfa_boolean_t bfa_ioc_is_initialized(struct bfa_ioc_s *ioc);
365 bfa_boolean_t bfa_ioc_is_disabled(struct bfa_ioc_s *ioc);
366 bfa_boolean_t bfa_ioc_fw_mismatch(struct bfa_ioc_s *ioc);
367 bfa_boolean_t bfa_ioc_adapter_is_disabled(struct bfa_ioc_s *ioc);
368 void bfa_ioc_reset_fwstate(struct bfa_ioc_s *ioc);
369 enum bfa_ioc_type_e bfa_ioc_get_type(struct bfa_ioc_s *ioc);
370 void bfa_ioc_get_adapter_serial_num(struct bfa_ioc_s *ioc, char *serial_num);
371 void bfa_ioc_get_adapter_fw_ver(struct bfa_ioc_s *ioc, char *fw_ver);
372 void bfa_ioc_get_adapter_optrom_ver(struct bfa_ioc_s *ioc, char *optrom_ver);
373 void bfa_ioc_get_adapter_model(struct bfa_ioc_s *ioc, char *model);
374 void bfa_ioc_get_adapter_manufacturer(struct bfa_ioc_s *ioc,
375 char *manufacturer);
376 void bfa_ioc_get_pci_chip_rev(struct bfa_ioc_s *ioc, char *chip_rev);
377 enum bfa_ioc_state bfa_ioc_get_state(struct bfa_ioc_s *ioc);
379 void bfa_ioc_get_attr(struct bfa_ioc_s *ioc, struct bfa_ioc_attr_s *ioc_attr);
380 void bfa_ioc_get_adapter_attr(struct bfa_ioc_s *ioc,
381 struct bfa_adapter_attr_s *ad_attr);
382 void bfa_ioc_debug_memclaim(struct bfa_ioc_s *ioc, void *dbg_fwsave);
383 bfa_status_t bfa_ioc_debug_fwsave(struct bfa_ioc_s *ioc, void *trcdata,
384 int *trclen);
385 bfa_status_t bfa_ioc_debug_fwtrc(struct bfa_ioc_s *ioc, void *trcdata,
386 int *trclen);
387 bfa_status_t bfa_ioc_debug_fwcore(struct bfa_ioc_s *ioc, void *buf,
388 u32 *offset, int *buflen);
389 void bfa_ioc_set_fcmode(struct bfa_ioc_s *ioc);
390 bfa_boolean_t bfa_ioc_get_fcmode(struct bfa_ioc_s *ioc);
391 bfa_boolean_t bfa_ioc_sem_get(void __iomem *sem_reg);
392 void bfa_ioc_fwver_get(struct bfa_ioc_s *ioc,
393 struct bfi_ioc_image_hdr_s *fwhdr);
394 bfa_boolean_t bfa_ioc_fwver_cmp(struct bfa_ioc_s *ioc,
395 struct bfi_ioc_image_hdr_s *fwhdr);
396 bfa_status_t bfa_ioc_fw_stats_get(struct bfa_ioc_s *ioc, void *stats);
397 bfa_status_t bfa_ioc_fw_stats_clear(struct bfa_ioc_s *ioc);
400 * bfa mfg wwn API functions
402 mac_t bfa_ioc_get_mac(struct bfa_ioc_s *ioc);
403 mac_t bfa_ioc_get_mfg_mac(struct bfa_ioc_s *ioc);
406 * F/W Image Size & Chunk
408 extern u32 bfi_image_cb_size;
409 extern u32 bfi_image_ct_size;
410 extern u32 bfi_image_ct2_size;
411 extern u32 *bfi_image_cb;
412 extern u32 *bfi_image_ct;
413 extern u32 *bfi_image_ct2;
415 static inline u32 *
416 bfi_image_cb_get_chunk(u32 off)
418 return (u32 *)(bfi_image_cb + off);
421 static inline u32 *
422 bfi_image_ct_get_chunk(u32 off)
424 return (u32 *)(bfi_image_ct + off);
427 static inline u32 *
428 bfi_image_ct2_get_chunk(u32 off)
430 return (u32 *)(bfi_image_ct2 + off);
433 static inline u32*
434 bfa_cb_image_get_chunk(enum bfi_asic_gen asic_gen, u32 off)
436 switch (asic_gen) {
437 case BFI_ASIC_GEN_CB:
438 return bfi_image_cb_get_chunk(off);
439 break;
440 case BFI_ASIC_GEN_CT:
441 return bfi_image_ct_get_chunk(off);
442 break;
443 case BFI_ASIC_GEN_CT2:
444 return bfi_image_ct2_get_chunk(off);
445 break;
446 default:
447 return NULL;
451 static inline u32
452 bfa_cb_image_get_size(enum bfi_asic_gen asic_gen)
454 switch (asic_gen) {
455 case BFI_ASIC_GEN_CB:
456 return bfi_image_cb_size;
457 break;
458 case BFI_ASIC_GEN_CT:
459 return bfi_image_ct_size;
460 break;
461 case BFI_ASIC_GEN_CT2:
462 return bfi_image_ct2_size;
463 break;
464 default:
465 return 0;
470 * CNA TRCMOD declaration
473 * !!! Only append to the enums defined here to avoid any versioning
474 * !!! needed between trace utility and driver version
476 enum {
477 BFA_TRC_CNA_PORT = 1,
478 BFA_TRC_CNA_IOC = 2,
479 BFA_TRC_CNA_IOC_CB = 3,
480 BFA_TRC_CNA_IOC_CT = 4,
483 #endif /* __BFA_IOC_H__ */