Merge branch 'pm-fixes' of git://git.kernel.org/pub/scm/linux/kernel/git/rafael/suspe...
[pandora-kernel.git] / drivers / scsi / bfa / bfa_ioc.h
1 /*
2  * Copyright (c) 2005-2010 Brocade Communications Systems, Inc.
3  * All rights reserved
4  * www.brocade.com
5  *
6  * Linux driver for Brocade Fibre Channel Host Bus Adapter.
7  *
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
11  *
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.
16  */
17
18 #ifndef __BFA_IOC_H__
19 #define __BFA_IOC_H__
20
21 #include "bfa_os_inc.h"
22 #include "bfa_cs.h"
23 #include "bfi.h"
24
25 /**
26  * BFA timer declarations
27  */
28 typedef void (*bfa_timer_cbfn_t)(void *);
29
30 /**
31  * BFA timer data structure
32  */
33 struct bfa_timer_s {
34         struct list_head        qe;
35         bfa_timer_cbfn_t timercb;
36         void            *arg;
37         int             timeout;        /**< in millisecs. */
38 };
39
40 /**
41  * Timer module structure
42  */
43 struct bfa_timer_mod_s {
44         struct list_head timer_q;
45 };
46
47 #define BFA_TIMER_FREQ 200 /**< specified in millisecs */
48
49 void bfa_timer_beat(struct bfa_timer_mod_s *mod);
50 void bfa_timer_init(struct bfa_timer_mod_s *mod);
51 void bfa_timer_begin(struct bfa_timer_mod_s *mod, struct bfa_timer_s *timer,
52                         bfa_timer_cbfn_t timercb, void *arg,
53                         unsigned int timeout);
54 void bfa_timer_stop(struct bfa_timer_s *timer);
55
56 /**
57  * Generic Scatter Gather Element used by driver
58  */
59 struct bfa_sge_s {
60         u32     sg_len;
61         void            *sg_addr;
62 };
63
64 #define bfa_sge_word_swap(__sge) do {                                        \
65         ((u32 *)(__sge))[0] = bfa_os_swap32(((u32 *)(__sge))[0]);      \
66         ((u32 *)(__sge))[1] = bfa_os_swap32(((u32 *)(__sge))[1]);      \
67         ((u32 *)(__sge))[2] = bfa_os_swap32(((u32 *)(__sge))[2]);      \
68 } while (0)
69
70 #define bfa_swap_words(_x)  (   \
71         ((_x) << 32) | ((_x) >> 32))
72
73 #ifdef __BIGENDIAN
74 #define bfa_sge_to_be(_x)
75 #define bfa_sge_to_le(_x)       bfa_sge_word_swap(_x)
76 #define bfa_sgaddr_le(_x)       bfa_swap_words(_x)
77 #else
78 #define bfa_sge_to_be(_x)       bfa_sge_word_swap(_x)
79 #define bfa_sge_to_le(_x)
80 #define bfa_sgaddr_le(_x)       (_x)
81 #endif
82
83 /**
84  * PCI device information required by IOC
85  */
86 struct bfa_pcidev_s {
87         int             pci_slot;
88         u8              pci_func;
89         u16     device_id;
90         bfa_os_addr_t   pci_bar_kva;
91 };
92
93 /**
94  * Structure used to remember the DMA-able memory block's KVA and Physical
95  * Address
96  */
97 struct bfa_dma_s {
98         void            *kva;   /* ! Kernel virtual address     */
99         u64     pa;     /* ! Physical address           */
100 };
101
102 #define BFA_DMA_ALIGN_SZ        256
103 #define BFA_ROUNDUP(_l, _s)     (((_l) + ((_s) - 1)) & ~((_s) - 1))
104
105 /**
106  * smem size for Crossbow and Catapult
107  */
108 #define BFI_SMEM_CB_SIZE        0x200000U       /* ! 2MB for crossbow   */
109 #define BFI_SMEM_CT_SIZE        0x280000U       /* ! 2.5MB for catapult */
110
111
112 #define bfa_dma_addr_set(dma_addr, pa)  \
113                 __bfa_dma_addr_set(&dma_addr, (u64)pa)
114
115 static inline void
116 __bfa_dma_addr_set(union bfi_addr_u *dma_addr, u64 pa)
117 {
118         dma_addr->a32.addr_lo = (u32) pa;
119         dma_addr->a32.addr_hi = (u32) (bfa_os_u32(pa));
120 }
121
122
123 #define bfa_dma_be_addr_set(dma_addr, pa)       \
124                 __bfa_dma_be_addr_set(&dma_addr, (u64)pa)
125 static inline void
126 __bfa_dma_be_addr_set(union bfi_addr_u *dma_addr, u64 pa)
127 {
128         dma_addr->a32.addr_lo = (u32) bfa_os_htonl(pa);
129         dma_addr->a32.addr_hi = (u32) bfa_os_htonl(bfa_os_u32(pa));
130 }
131
132 struct bfa_ioc_regs_s {
133         bfa_os_addr_t   hfn_mbox_cmd;
134         bfa_os_addr_t   hfn_mbox;
135         bfa_os_addr_t   lpu_mbox_cmd;
136         bfa_os_addr_t   lpu_mbox;
137         bfa_os_addr_t   pss_ctl_reg;
138         bfa_os_addr_t   pss_err_status_reg;
139         bfa_os_addr_t   app_pll_fast_ctl_reg;
140         bfa_os_addr_t   app_pll_slow_ctl_reg;
141         bfa_os_addr_t   ioc_sem_reg;
142         bfa_os_addr_t   ioc_usage_sem_reg;
143         bfa_os_addr_t   ioc_init_sem_reg;
144         bfa_os_addr_t   ioc_usage_reg;
145         bfa_os_addr_t   host_page_num_fn;
146         bfa_os_addr_t   heartbeat;
147         bfa_os_addr_t   ioc_fwstate;
148         bfa_os_addr_t   ll_halt;
149         bfa_os_addr_t   err_set;
150         bfa_os_addr_t   shirq_isr_next;
151         bfa_os_addr_t   shirq_msk_next;
152         bfa_os_addr_t   smem_page_start;
153         u32     smem_pg0;
154 };
155
156 #define bfa_reg_read(_raddr)    bfa_os_reg_read(_raddr)
157 #define bfa_reg_write(_raddr, _val)     bfa_os_reg_write(_raddr, _val)
158 #define bfa_mem_read(_raddr, _off)      bfa_os_mem_read(_raddr, _off)
159 #define bfa_mem_write(_raddr, _off, _val)       \
160                                         bfa_os_mem_write(_raddr, _off, _val)
161 /**
162  * IOC Mailbox structures
163  */
164 struct bfa_mbox_cmd_s {
165         struct list_head        qe;
166         u32     msg[BFI_IOC_MSGSZ];
167 };
168
169 /**
170  * IOC mailbox module
171  */
172 typedef void (*bfa_ioc_mbox_mcfunc_t)(void *cbarg, struct bfi_mbmsg_s *m);
173 struct bfa_ioc_mbox_mod_s {
174         struct list_head                cmd_q;  /*  pending mbox queue  */
175         int                     nmclass;        /*  number of handlers */
176         struct {
177                 bfa_ioc_mbox_mcfunc_t   cbfn;   /*  message handlers    */
178                 void                    *cbarg;
179         } mbhdlr[BFI_MC_MAX];
180 };
181
182 /**
183  * IOC callback function interfaces
184  */
185 typedef void (*bfa_ioc_enable_cbfn_t)(void *bfa, enum bfa_status status);
186 typedef void (*bfa_ioc_disable_cbfn_t)(void *bfa);
187 typedef void (*bfa_ioc_hbfail_cbfn_t)(void *bfa);
188 typedef void (*bfa_ioc_reset_cbfn_t)(void *bfa);
189 struct bfa_ioc_cbfn_s {
190         bfa_ioc_enable_cbfn_t   enable_cbfn;
191         bfa_ioc_disable_cbfn_t  disable_cbfn;
192         bfa_ioc_hbfail_cbfn_t   hbfail_cbfn;
193         bfa_ioc_reset_cbfn_t    reset_cbfn;
194 };
195
196 /**
197  * Heartbeat failure notification queue element.
198  */
199 struct bfa_ioc_hbfail_notify_s {
200         struct list_head                qe;
201         bfa_ioc_hbfail_cbfn_t   cbfn;
202         void                    *cbarg;
203 };
204
205 /**
206  * Initialize a heartbeat failure notification structure
207  */
208 #define bfa_ioc_hbfail_init(__notify, __cbfn, __cbarg) do {     \
209         (__notify)->cbfn = (__cbfn);      \
210         (__notify)->cbarg = (__cbarg);      \
211 } while (0)
212
213 struct bfa_iocpf_s {
214         bfa_fsm_t               fsm;
215         struct bfa_ioc_s        *ioc;
216         u32             retry_count;
217         bfa_boolean_t           auto_recover;
218 };
219
220 struct bfa_ioc_s {
221         bfa_fsm_t               fsm;
222         struct bfa_s            *bfa;
223         struct bfa_pcidev_s     pcidev;
224         struct bfa_timer_mod_s  *timer_mod;
225         struct bfa_timer_s      ioc_timer;
226         struct bfa_timer_s      sem_timer;
227         struct bfa_timer_s      hb_timer;
228         u32             hb_count;
229         struct list_head                hb_notify_q;
230         void                    *dbg_fwsave;
231         int                     dbg_fwsave_len;
232         bfa_boolean_t           dbg_fwsave_once;
233         enum bfi_mclass         ioc_mc;
234         struct bfa_ioc_regs_s   ioc_regs;
235         struct bfa_trc_mod_s    *trcmod;
236         struct bfa_ioc_drv_stats_s      stats;
237         bfa_boolean_t           fcmode;
238         bfa_boolean_t           ctdev;
239         bfa_boolean_t           cna;
240         bfa_boolean_t           pllinit;
241         bfa_boolean_t           stats_busy;     /*  outstanding stats */
242         u8                      port_id;
243         struct bfa_dma_s        attr_dma;
244         struct bfi_ioc_attr_s   *attr;
245         struct bfa_ioc_cbfn_s   *cbfn;
246         struct bfa_ioc_mbox_mod_s mbox_mod;
247         struct bfa_ioc_hwif_s   *ioc_hwif;
248         struct bfa_iocpf_s      iocpf;
249 };
250
251 struct bfa_ioc_hwif_s {
252         bfa_status_t (*ioc_pll_init) (bfa_os_addr_t rb, bfa_boolean_t fcmode);
253         bfa_boolean_t   (*ioc_firmware_lock)    (struct bfa_ioc_s *ioc);
254         void            (*ioc_firmware_unlock)  (struct bfa_ioc_s *ioc);
255         void            (*ioc_reg_init) (struct bfa_ioc_s *ioc);
256         void            (*ioc_map_port) (struct bfa_ioc_s *ioc);
257         void            (*ioc_isr_mode_set)     (struct bfa_ioc_s *ioc,
258                                         bfa_boolean_t msix);
259         void            (*ioc_notify_hbfail)    (struct bfa_ioc_s *ioc);
260         void            (*ioc_ownership_reset)  (struct bfa_ioc_s *ioc);
261 };
262
263 #define bfa_ioc_pcifn(__ioc)            ((__ioc)->pcidev.pci_func)
264 #define bfa_ioc_devid(__ioc)            ((__ioc)->pcidev.device_id)
265 #define bfa_ioc_bar0(__ioc)             ((__ioc)->pcidev.pci_bar_kva)
266 #define bfa_ioc_portid(__ioc)           ((__ioc)->port_id)
267 #define bfa_ioc_fetch_stats(__ioc, __stats) \
268                 (((__stats)->drv_stats) = (__ioc)->stats)
269 #define bfa_ioc_clr_stats(__ioc)        \
270                 bfa_os_memset(&(__ioc)->stats, 0, sizeof((__ioc)->stats))
271 #define bfa_ioc_maxfrsize(__ioc)        ((__ioc)->attr->maxfrsize)
272 #define bfa_ioc_rx_bbcredit(__ioc)      ((__ioc)->attr->rx_bbcredit)
273 #define bfa_ioc_speed_sup(__ioc)        \
274         BFI_ADAPTER_GETP(SPEED, (__ioc)->attr->adapter_prop)
275 #define bfa_ioc_get_nports(__ioc)       \
276         BFI_ADAPTER_GETP(NPORTS, (__ioc)->attr->adapter_prop)
277
278 #define bfa_ioc_stats(_ioc, _stats)     ((_ioc)->stats._stats++)
279 #define BFA_IOC_FWIMG_MINSZ     (16 * 1024)
280 #define BFA_IOC_FWIMG_TYPE(__ioc)                                       \
281         (((__ioc)->ctdev) ?                                             \
282          (((__ioc)->fcmode) ? BFI_IMAGE_CT_FC : BFI_IMAGE_CT_CNA) :     \
283          BFI_IMAGE_CB_FC)
284 #define BFA_IOC_FW_SMEM_SIZE(__ioc)                                     \
285         (((__ioc)->ctdev) ? BFI_SMEM_CT_SIZE : BFI_SMEM_CB_SIZE)
286 #define BFA_IOC_FLASH_CHUNK_NO(off)             (off / BFI_FLASH_CHUNK_SZ_WORDS)
287 #define BFA_IOC_FLASH_OFFSET_IN_CHUNK(off)      (off % BFI_FLASH_CHUNK_SZ_WORDS)
288 #define BFA_IOC_FLASH_CHUNK_ADDR(chunkno)  (chunkno * BFI_FLASH_CHUNK_SZ_WORDS)
289
290 /**
291  * IOC mailbox interface
292  */
293 void bfa_ioc_mbox_queue(struct bfa_ioc_s *ioc, struct bfa_mbox_cmd_s *cmd);
294 void bfa_ioc_mbox_register(struct bfa_ioc_s *ioc,
295                 bfa_ioc_mbox_mcfunc_t *mcfuncs);
296 void bfa_ioc_mbox_isr(struct bfa_ioc_s *ioc);
297 void bfa_ioc_mbox_send(struct bfa_ioc_s *ioc, void *ioc_msg, int len);
298 void bfa_ioc_msgget(struct bfa_ioc_s *ioc, void *mbmsg);
299 void bfa_ioc_mbox_regisr(struct bfa_ioc_s *ioc, enum bfi_mclass mc,
300                 bfa_ioc_mbox_mcfunc_t cbfn, void *cbarg);
301
302 /**
303  * IOC interfaces
304  */
305
306 #define bfa_ioc_pll_init_asic(__ioc) \
307         ((__ioc)->ioc_hwif->ioc_pll_init((__ioc)->pcidev.pci_bar_kva, \
308                            (__ioc)->fcmode))
309
310 bfa_status_t bfa_ioc_pll_init(struct bfa_ioc_s *ioc);
311 bfa_status_t bfa_ioc_cb_pll_init(bfa_os_addr_t rb, bfa_boolean_t fcmode);
312 bfa_boolean_t bfa_ioc_ct_pll_init_complete(bfa_os_addr_t rb);
313 bfa_status_t bfa_ioc_ct_pll_init(bfa_os_addr_t rb, bfa_boolean_t fcmode);
314
315 #define bfa_ioc_isr_mode_set(__ioc, __msix)                     \
316                         ((__ioc)->ioc_hwif->ioc_isr_mode_set(__ioc, __msix))
317 #define bfa_ioc_ownership_reset(__ioc)                          \
318                         ((__ioc)->ioc_hwif->ioc_ownership_reset(__ioc))
319
320
321 void bfa_ioc_set_ct_hwif(struct bfa_ioc_s *ioc);
322 void bfa_ioc_set_cb_hwif(struct bfa_ioc_s *ioc);
323
324 void bfa_ioc_attach(struct bfa_ioc_s *ioc, void *bfa,
325                 struct bfa_ioc_cbfn_s *cbfn, struct bfa_timer_mod_s *timer_mod);
326 void bfa_ioc_auto_recover(bfa_boolean_t auto_recover);
327 void bfa_ioc_detach(struct bfa_ioc_s *ioc);
328 void bfa_ioc_pci_init(struct bfa_ioc_s *ioc, struct bfa_pcidev_s *pcidev,
329                 enum bfi_mclass mc);
330 u32 bfa_ioc_meminfo(void);
331 void bfa_ioc_mem_claim(struct bfa_ioc_s *ioc,  u8 *dm_kva, u64 dm_pa);
332 void bfa_ioc_enable(struct bfa_ioc_s *ioc);
333 void bfa_ioc_disable(struct bfa_ioc_s *ioc);
334 bfa_boolean_t bfa_ioc_intx_claim(struct bfa_ioc_s *ioc);
335
336 void bfa_ioc_boot(struct bfa_ioc_s *ioc, u32 boot_type,
337                 u32 boot_param);
338 void bfa_ioc_isr(struct bfa_ioc_s *ioc, struct bfi_mbmsg_s *msg);
339 void bfa_ioc_error_isr(struct bfa_ioc_s *ioc);
340 bfa_boolean_t bfa_ioc_is_operational(struct bfa_ioc_s *ioc);
341 bfa_boolean_t bfa_ioc_is_initialized(struct bfa_ioc_s *ioc);
342 bfa_boolean_t bfa_ioc_is_disabled(struct bfa_ioc_s *ioc);
343 bfa_boolean_t bfa_ioc_fw_mismatch(struct bfa_ioc_s *ioc);
344 bfa_boolean_t bfa_ioc_adapter_is_disabled(struct bfa_ioc_s *ioc);
345 enum bfa_ioc_type_e bfa_ioc_get_type(struct bfa_ioc_s *ioc);
346 void bfa_ioc_get_adapter_serial_num(struct bfa_ioc_s *ioc, char *serial_num);
347 void bfa_ioc_get_adapter_fw_ver(struct bfa_ioc_s *ioc, char *fw_ver);
348 void bfa_ioc_get_adapter_optrom_ver(struct bfa_ioc_s *ioc, char *optrom_ver);
349 void bfa_ioc_get_adapter_model(struct bfa_ioc_s *ioc, char *model);
350 void bfa_ioc_get_adapter_manufacturer(struct bfa_ioc_s *ioc,
351                 char *manufacturer);
352 void bfa_ioc_get_pci_chip_rev(struct bfa_ioc_s *ioc, char *chip_rev);
353 enum bfa_ioc_state bfa_ioc_get_state(struct bfa_ioc_s *ioc);
354
355 void bfa_ioc_get_attr(struct bfa_ioc_s *ioc, struct bfa_ioc_attr_s *ioc_attr);
356 void bfa_ioc_get_adapter_attr(struct bfa_ioc_s *ioc,
357                 struct bfa_adapter_attr_s *ad_attr);
358 int bfa_ioc_debug_trcsz(bfa_boolean_t auto_recover);
359 void bfa_ioc_debug_memclaim(struct bfa_ioc_s *ioc, void *dbg_fwsave);
360 bfa_status_t bfa_ioc_debug_fwsave(struct bfa_ioc_s *ioc, void *trcdata,
361                 int *trclen);
362 void bfa_ioc_debug_fwsave_clear(struct bfa_ioc_s *ioc);
363 bfa_status_t bfa_ioc_debug_fwtrc(struct bfa_ioc_s *ioc, void *trcdata,
364                                  int *trclen);
365 bfa_status_t bfa_ioc_debug_fwcore(struct bfa_ioc_s *ioc, void *buf,
366         u32 *offset, int *buflen);
367 u32 bfa_ioc_smem_pgnum(struct bfa_ioc_s *ioc, u32 fmaddr);
368 u32 bfa_ioc_smem_pgoff(struct bfa_ioc_s *ioc, u32 fmaddr);
369 void bfa_ioc_set_fcmode(struct bfa_ioc_s *ioc);
370 bfa_boolean_t bfa_ioc_get_fcmode(struct bfa_ioc_s *ioc);
371 void bfa_ioc_hbfail_register(struct bfa_ioc_s *ioc,
372         struct bfa_ioc_hbfail_notify_s *notify);
373 bfa_boolean_t bfa_ioc_sem_get(bfa_os_addr_t sem_reg);
374 void bfa_ioc_sem_release(bfa_os_addr_t sem_reg);
375 void bfa_ioc_hw_sem_release(struct bfa_ioc_s *ioc);
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);
382
383 /*
384  * bfa mfg wwn API functions
385  */
386 wwn_t bfa_ioc_get_pwwn(struct bfa_ioc_s *ioc);
387 wwn_t bfa_ioc_get_nwwn(struct bfa_ioc_s *ioc);
388 mac_t bfa_ioc_get_mac(struct bfa_ioc_s *ioc);
389 wwn_t bfa_ioc_get_mfg_pwwn(struct bfa_ioc_s *ioc);
390 wwn_t bfa_ioc_get_mfg_nwwn(struct bfa_ioc_s *ioc);
391 mac_t bfa_ioc_get_mfg_mac(struct bfa_ioc_s *ioc);
392 u64 bfa_ioc_get_adid(struct bfa_ioc_s *ioc);
393
394 /*
395  * F/W Image Size & Chunk
396  */
397 extern u32 bfi_image_ct_fc_size;
398 extern u32 bfi_image_ct_cna_size;
399 extern u32 bfi_image_cb_fc_size;
400 extern u32 *bfi_image_ct_fc;
401 extern u32 *bfi_image_ct_cna;
402 extern u32 *bfi_image_cb_fc;
403
404 static inline u32 *
405 bfi_image_ct_fc_get_chunk(u32 off)
406 {       return (u32 *)(bfi_image_ct_fc + off); }
407
408 static inline u32 *
409 bfi_image_ct_cna_get_chunk(u32 off)
410 {       return (u32 *)(bfi_image_ct_cna + off); }
411
412 static inline u32 *
413 bfi_image_cb_fc_get_chunk(u32 off)
414 {       return (u32 *)(bfi_image_cb_fc + off); }
415
416 static inline u32*
417 bfa_cb_image_get_chunk(int type, u32 off)
418 {
419         switch (type) {
420         case BFI_IMAGE_CT_FC:
421                 return bfi_image_ct_fc_get_chunk(off);  break;
422         case BFI_IMAGE_CT_CNA:
423                 return bfi_image_ct_cna_get_chunk(off); break;
424         case BFI_IMAGE_CB_FC:
425                 return bfi_image_cb_fc_get_chunk(off);  break;
426         default: return 0;
427         }
428 }
429
430 static inline u32
431 bfa_cb_image_get_size(int type)
432 {
433         switch (type) {
434         case BFI_IMAGE_CT_FC:
435                 return bfi_image_ct_fc_size;    break;
436         case BFI_IMAGE_CT_CNA:
437                 return bfi_image_ct_cna_size;   break;
438         case BFI_IMAGE_CB_FC:
439                 return bfi_image_cb_fc_size;    break;
440         default: return 0;
441         }
442 }
443
444 /**
445  * CNA TRCMOD declaration
446  */
447 /*
448  * !!! Only append to the enums defined here to avoid any versioning
449  * !!! needed between trace utility and driver version
450  */
451 enum {
452         BFA_TRC_CNA_PORT        = 1,
453         BFA_TRC_CNA_IOC         = 2,
454         BFA_TRC_CNA_IOC_CB      = 3,
455         BFA_TRC_CNA_IOC_CT      = 4,
456 };
457
458 #endif /* __BFA_IOC_H__ */