]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - drivers/scsi/bfa/bfa.h
projects / mirror_ubuntu-artful-kernel.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
[SCSI] bfa: IOC and PLL init changes for Brocade-1860 Fabric Adapter.
[mirror_ubuntu-artful-kernel.git] / drivers / scsi / bfa / bfa.h
CommitLineData
a36c61f9
KG		 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#ifndef __BFA_H__
18#define __BFA_H__
19
f16a1750 20#include "bfad_drv.h"
a36c61f9
KG		 21#include "bfa_cs.h"
22#include "bfa_plog.h"
23#include "bfa_defs_svc.h"
24#include "bfi.h"
25#include "bfa_ioc.h"
26
27struct bfa_s;
28
29typedef void (*bfa_isr_func_t) (struct bfa_s *bfa, struct bfi_msg_s *m);
30typedef void (*bfa_cb_cbfn_t) (void *cbarg, bfa_boolean_t complete);
31
acdc79a6 32/*
a36c61f9
KG		 33 * Interrupt message handlers
34 */
35void bfa_isr_unhandled(struct bfa_s *bfa, struct bfi_msg_s *m);
a36c61f9 36
acdc79a6 37/*
a36c61f9
KG		 38 * Request and response queue related defines
39 */
40#define BFA_REQQ_NELEMS_MIN (4)
41#define BFA_RSPQ_NELEMS_MIN (4)
42
43#define bfa_reqq_pi(__bfa, __reqq) ((__bfa)->iocfc.req_cq_pi[__reqq])
44#define bfa_reqq_ci(__bfa, __reqq) \
45 (*(u32 *)((__bfa)->iocfc.req_cq_shadow_ci[__reqq].kva))
46
47#define bfa_reqq_full(__bfa, __reqq) \
48 (((bfa_reqq_pi(__bfa, __reqq) + 1) & \
49 ((__bfa)->iocfc.cfg.drvcfg.num_reqq_elems - 1)) == \
50 bfa_reqq_ci(__bfa, __reqq))
51
52#define bfa_reqq_next(__bfa, __reqq) \
53 (bfa_reqq_full(__bfa, __reqq) ? NULL : \
54 ((void *)((struct bfi_msg_s *)((__bfa)->iocfc.req_cq_ba[__reqq].kva) \
55 + bfa_reqq_pi((__bfa), (__reqq)))))
56
57#define bfa_reqq_produce(__bfa, __reqq) do { \
58 (__bfa)->iocfc.req_cq_pi[__reqq]++; \
59 (__bfa)->iocfc.req_cq_pi[__reqq] &= \
acdc79a6
JH		 60 ((__bfa)->iocfc.cfg.drvcfg.num_reqq_elems - 1); \
61 writel((__bfa)->iocfc.req_cq_pi[__reqq], \
53440260 62 (__bfa)->iocfc.bfa_regs.cpe_q_pi[__reqq]); \
a36c61f9
KG		 63 mmiowb(); \
64 } while (0)
65
66#define bfa_rspq_pi(__bfa, __rspq) \
67 (*(u32 *)((__bfa)->iocfc.rsp_cq_shadow_pi[__rspq].kva))
68
69#define bfa_rspq_ci(__bfa, __rspq) ((__bfa)->iocfc.rsp_cq_ci[__rspq])
70#define bfa_rspq_elem(__bfa, __rspq, __ci) \
71 (&((struct bfi_msg_s *)((__bfa)->iocfc.rsp_cq_ba[__rspq].kva))[__ci])
72
73#define CQ_INCR(__index, __size) do { \
74 (__index)++; \
75 (__index) &= ((__size) - 1); \
76} while (0)
77
acdc79a6 78/*
a36c61f9
KG		 79 * Queue element to wait for room in request queue. FIFO order is
80 * maintained when fullfilling requests.
81 */
82struct bfa_reqq_wait_s {
83 struct list_head qe;
84 void (*qresume) (void *cbarg);
85 void *cbarg;
86};
87
acdc79a6 88/*
a36c61f9
KG		 89 * Circular queue usage assignments
90 */
91enum {
92 BFA_REQQ_IOC = 0, /* all low-priority IOC msgs */
93 BFA_REQQ_FCXP = 0, /* all FCXP messages */
94 BFA_REQQ_LPS = 0, /* all lport service msgs */
95 BFA_REQQ_PORT = 0, /* all port messages */
96 BFA_REQQ_FLASH = 0, /* for flash module */
97 BFA_REQQ_DIAG = 0, /* for diag module */
98 BFA_REQQ_RPORT = 0, /* all port messages */
99 BFA_REQQ_SBOOT = 0, /* all san boot messages */
100 BFA_REQQ_QOS_LO = 1, /* all low priority IO */
101 BFA_REQQ_QOS_MD = 2, /* all medium priority IO */
102 BFA_REQQ_QOS_HI = 3, /* all high priority IO */
103};
104
105static inline void
106bfa_reqq_winit(struct bfa_reqq_wait_s *wqe, void (*qresume) (void *cbarg),
107 void *cbarg)
108{
109 wqe->qresume = qresume;
110 wqe->cbarg = cbarg;
111}
112
113#define bfa_reqq(__bfa, __reqq) (&(__bfa)->reqq_waitq[__reqq])
114
acdc79a6 115/*
a36c61f9
KG		 116 * static inline void
117 * bfa_reqq_wait(struct bfa_s *bfa, int reqq, struct bfa_reqq_wait_s *wqe)
118 */
119#define bfa_reqq_wait(__bfa, __reqq, __wqe) do { \
120 \
121 struct list_head *waitq = bfa_reqq(__bfa, __reqq); \
122 \
d4b671c5
JH		 123 WARN_ON(((__reqq) >= BFI_IOC_MAX_CQS)); \
124 WARN_ON(!((__wqe)->qresume && (__wqe)->cbarg)); \
a36c61f9
KG		 125 \
126 list_add_tail(&(__wqe)->qe, waitq); \
127 } while (0)
128
129#define bfa_reqq_wcancel(__wqe) list_del(&(__wqe)->qe)
130
131
acdc79a6 132/*
a36c61f9
KG		 133 * Generic BFA callback element.
134 */
135struct bfa_cb_qe_s {
136 struct list_head qe;
137 bfa_cb_cbfn_t cbfn;
138 bfa_boolean_t once;
a36c61f9
KG		 139 void *cbarg;
140};
141
142#define bfa_cb_queue(__bfa, __hcb_qe, __cbfn, __cbarg) do { \
143 (__hcb_qe)->cbfn = (__cbfn); \
144 (__hcb_qe)->cbarg = (__cbarg); \
145 list_add_tail(&(__hcb_qe)->qe, &(__bfa)->comp_q); \
146 } while (0)
147
148#define bfa_cb_dequeue(__hcb_qe) list_del(&(__hcb_qe)->qe)
149
150#define bfa_cb_queue_once(__bfa, __hcb_qe, __cbfn, __cbarg) do { \
151 (__hcb_qe)->cbfn = (__cbfn); \
152 (__hcb_qe)->cbarg = (__cbarg); \
153 if (!(__hcb_qe)->once) { \
154 list_add_tail(&(__hcb_qe)->qe, &(__bfa)->comp_q); \
155 (__hcb_qe)->once = BFA_TRUE; \
156 } \
157 } while (0)
158
159#define bfa_cb_queue_done(__hcb_qe) do { \
160 (__hcb_qe)->once = BFA_FALSE; \
161 } while (0)
162
163
acdc79a6 164/*
a36c61f9
KG		 165 * PCI devices supported by the current BFA
166 */
167struct bfa_pciid_s {
168 u16 device_id;
169 u16 vendor_id;
170};
171
172extern char bfa_version[];
173
acdc79a6 174/*
a36c61f9
KG		 175 * BFA memory resources
176 */
177enum bfa_mem_type {
178 BFA_MEM_TYPE_KVA = 1, /* Kernel Virtual Memory *(non-dma-able) */
179 BFA_MEM_TYPE_DMA = 2, /* DMA-able memory */
180 BFA_MEM_TYPE_MAX = BFA_MEM_TYPE_DMA,
181};
182
183struct bfa_mem_elem_s {
184 enum bfa_mem_type mem_type; /* see enum bfa_mem_type */
185 u32 mem_len; /* Total Length in Bytes */
186 u8 *kva; /* kernel virtual address */
187 u64 dma; /* dma address if DMA memory */
188 u8 *kva_curp; /* kva allocation cursor */
189 u64 dma_curp; /* dma allocation cursor */
190};
191
192struct bfa_meminfo_s {
193 struct bfa_mem_elem_s meminfo[BFA_MEM_TYPE_MAX];
194};
195#define bfa_meminfo_kva(_m) \
196 ((_m)->meminfo[BFA_MEM_TYPE_KVA - 1].kva_curp)
197#define bfa_meminfo_dma_virt(_m) \
198 ((_m)->meminfo[BFA_MEM_TYPE_DMA - 1].kva_curp)
199#define bfa_meminfo_dma_phys(_m) \
200 ((_m)->meminfo[BFA_MEM_TYPE_DMA - 1].dma_curp)
201
202struct bfa_iocfc_regs_s {
53440260 203 void __iomem *intr_status;
acdc79a6 204 void __iomem *intr_mask;
53440260
JH		 205 void __iomem *cpe_q_pi[BFI_IOC_MAX_CQS];
206 void __iomem *cpe_q_ci[BFI_IOC_MAX_CQS];
53440260
JH		 207 void __iomem *cpe_q_ctrl[BFI_IOC_MAX_CQS];
208 void __iomem *rme_q_ci[BFI_IOC_MAX_CQS];
209 void __iomem *rme_q_pi[BFI_IOC_MAX_CQS];
53440260 210 void __iomem *rme_q_ctrl[BFI_IOC_MAX_CQS];
a36c61f9
KG		 211};
212
acdc79a6 213/*
a36c61f9
KG		 214 * MSIX vector handlers
215 */
216#define BFA_MSIX_MAX_VECTORS 22
217typedef void (*bfa_msix_handler_t)(struct bfa_s *bfa, int vec);
218struct bfa_msix_s {
219 int nvecs;
220 bfa_msix_handler_t handler[BFA_MSIX_MAX_VECTORS];
221};
222
acdc79a6 223/*
a36c61f9
KG		 224 * Chip specific interfaces
225 */
226struct bfa_hwif_s {
227 void (*hw_reginit)(struct bfa_s *bfa);
228 void (*hw_reqq_ack)(struct bfa_s *bfa, int reqq);
229 void (*hw_rspq_ack)(struct bfa_s *bfa, int rspq);
230 void (*hw_msix_init)(struct bfa_s *bfa, int nvecs);
775c7742
KG		 231 void (*hw_msix_ctrl_install)(struct bfa_s *bfa);
232 void (*hw_msix_queue_install)(struct bfa_s *bfa);
a36c61f9
KG		 233 void (*hw_msix_uninstall)(struct bfa_s *bfa);
234 void (*hw_isr_mode_set)(struct bfa_s *bfa, bfa_boolean_t msix);
235 void (*hw_msix_getvecs)(struct bfa_s *bfa, u32 *vecmap,
236 u32 *nvecs, u32 *maxvec);
237 void (*hw_msix_get_rme_range) (struct bfa_s *bfa, u32 *start,
238 u32 *end);
11189208
KG		 239 int cpe_vec_q0;
240 int rme_vec_q0;
a36c61f9
KG		 241};
242typedef void (*bfa_cb_iocfc_t) (void *cbarg, enum bfa_status status);
243
244struct bfa_iocfc_s {
245 struct bfa_s *bfa;
246 struct bfa_iocfc_cfg_s cfg;
247 int action;
248 u32 req_cq_pi[BFI_IOC_MAX_CQS];
249 u32 rsp_cq_ci[BFI_IOC_MAX_CQS];
250 struct bfa_cb_qe_s init_hcb_qe;
251 struct bfa_cb_qe_s stop_hcb_qe;
252 struct bfa_cb_qe_s dis_hcb_qe;
253 struct bfa_cb_qe_s stats_hcb_qe;
254 bfa_boolean_t cfgdone;
255
256 struct bfa_dma_s cfg_info;
257 struct bfi_iocfc_cfg_s *cfginfo;
258 struct bfa_dma_s cfgrsp_dma;
259 struct bfi_iocfc_cfgrsp_s *cfgrsp;
a36c61f9
KG		 260 struct bfa_dma_s req_cq_ba[BFI_IOC_MAX_CQS];
261 struct bfa_dma_s req_cq_shadow_ci[BFI_IOC_MAX_CQS];
262 struct bfa_dma_s rsp_cq_ba[BFI_IOC_MAX_CQS];
263 struct bfa_dma_s rsp_cq_shadow_pi[BFI_IOC_MAX_CQS];
264 struct bfa_iocfc_regs_s bfa_regs; /* BFA device registers */
265 struct bfa_hwif_s hwif;
266 bfa_cb_iocfc_t updateq_cbfn; /* bios callback function */
267 void *updateq_cbarg; /* bios callback arg */
268 u32 intr_mask;
269};
270
271#define bfa_lpuid(__bfa) \
272 bfa_ioc_portid(&(__bfa)->ioc)
273#define bfa_msix_init(__bfa, __nvecs) \
274 ((__bfa)->iocfc.hwif.hw_msix_init(__bfa, __nvecs))
775c7742
KG		 275#define bfa_msix_ctrl_install(__bfa) \
276 ((__bfa)->iocfc.hwif.hw_msix_ctrl_install(__bfa))
277#define bfa_msix_queue_install(__bfa) \
278 ((__bfa)->iocfc.hwif.hw_msix_queue_install(__bfa))
a36c61f9
KG		 279#define bfa_msix_uninstall(__bfa) \
280 ((__bfa)->iocfc.hwif.hw_msix_uninstall(__bfa))
11189208
KG		 281#define bfa_isr_mode_set(__bfa, __msix) do { \
282 if ((__bfa)->iocfc.hwif.hw_isr_mode_set) \
283 (__bfa)->iocfc.hwif.hw_isr_mode_set(__bfa, __msix); \
284} while (0)
285
a36c61f9
KG		 286#define bfa_msix_getvecs(__bfa, __vecmap, __nvecs, __maxvec) \
287 ((__bfa)->iocfc.hwif.hw_msix_getvecs(__bfa, __vecmap, \
288 __nvecs, __maxvec))
289#define bfa_msix_get_rme_range(__bfa, __start, __end) \
290 ((__bfa)->iocfc.hwif.hw_msix_get_rme_range(__bfa, __start, __end))
291#define bfa_msix(__bfa, __vec) \
292 ((__bfa)->msix.handler[__vec](__bfa, __vec))
293
294/*
295 * FC specific IOC functions.
296 */
297void bfa_iocfc_meminfo(struct bfa_iocfc_cfg_s *cfg, u32 *km_len,
298 u32 *dm_len);
299void bfa_iocfc_attach(struct bfa_s *bfa, void *bfad,
300 struct bfa_iocfc_cfg_s *cfg,
301 struct bfa_meminfo_s *meminfo,
302 struct bfa_pcidev_s *pcidev);
a36c61f9
KG		 303void bfa_iocfc_init(struct bfa_s *bfa);
304void bfa_iocfc_start(struct bfa_s *bfa);
305void bfa_iocfc_stop(struct bfa_s *bfa);
306void bfa_iocfc_isr(void *bfa, struct bfi_mbmsg_s *msg);
307void bfa_iocfc_set_snsbase(struct bfa_s *bfa, u64 snsbase_pa);
308bfa_boolean_t bfa_iocfc_is_operational(struct bfa_s *bfa);
309void bfa_iocfc_reset_queues(struct bfa_s *bfa);
310
311void bfa_msix_all(struct bfa_s *bfa, int vec);
312void bfa_msix_reqq(struct bfa_s *bfa, int vec);
313void bfa_msix_rspq(struct bfa_s *bfa, int vec);
314void bfa_msix_lpu_err(struct bfa_s *bfa, int vec);
315
316void bfa_hwcb_reginit(struct bfa_s *bfa);
317void bfa_hwcb_reqq_ack(struct bfa_s *bfa, int rspq);
318void bfa_hwcb_rspq_ack(struct bfa_s *bfa, int rspq);
319void bfa_hwcb_msix_init(struct bfa_s *bfa, int nvecs);
775c7742
KG		 320void bfa_hwcb_msix_ctrl_install(struct bfa_s *bfa);
321void bfa_hwcb_msix_queue_install(struct bfa_s *bfa);
a36c61f9
KG		 322void bfa_hwcb_msix_uninstall(struct bfa_s *bfa);
323void bfa_hwcb_isr_mode_set(struct bfa_s *bfa, bfa_boolean_t msix);
324void bfa_hwcb_msix_getvecs(struct bfa_s *bfa, u32 *vecmap, u32 *nvecs,
325 u32 *maxvec);
326void bfa_hwcb_msix_get_rme_range(struct bfa_s *bfa, u32 *start,
327 u32 *end);
328void bfa_hwct_reginit(struct bfa_s *bfa);
11189208 329void bfa_hwct2_reginit(struct bfa_s *bfa);
a36c61f9
KG		 330void bfa_hwct_reqq_ack(struct bfa_s *bfa, int rspq);
331void bfa_hwct_rspq_ack(struct bfa_s *bfa, int rspq);
332void bfa_hwct_msix_init(struct bfa_s *bfa, int nvecs);
775c7742
KG		 333void bfa_hwct_msix_ctrl_install(struct bfa_s *bfa);
334void bfa_hwct_msix_queue_install(struct bfa_s *bfa);
a36c61f9
KG		 335void bfa_hwct_msix_uninstall(struct bfa_s *bfa);
336void bfa_hwct_isr_mode_set(struct bfa_s *bfa, bfa_boolean_t msix);
337void bfa_hwct_msix_getvecs(struct bfa_s *bfa, u32 *vecmap, u32 *nvecs,
338 u32 *maxvec);
339void bfa_hwct_msix_get_rme_range(struct bfa_s *bfa, u32 *start,
340 u32 *end);
a36c61f9
KG		 341void bfa_iocfc_get_bootwwns(struct bfa_s *bfa, u8 *nwwns, wwn_t *wwns);
342wwn_t bfa_iocfc_get_pwwn(struct bfa_s *bfa);
343wwn_t bfa_iocfc_get_nwwn(struct bfa_s *bfa);
a36c61f9
KG		 344int bfa_iocfc_get_pbc_vports(struct bfa_s *bfa,
345 struct bfi_pbc_vport_s *pbc_vport);
346
347
acdc79a6 348/*
a36c61f9
KG		 349 *----------------------------------------------------------------------
350 * BFA public interfaces
351 *----------------------------------------------------------------------
352 */
353#define bfa_stats(_mod, _stats) ((_mod)->stats._stats++)
354#define bfa_ioc_get_stats(__bfa, __ioc_stats) \
355 bfa_ioc_fetch_stats(&(__bfa)->ioc, __ioc_stats)
356#define bfa_ioc_clear_stats(__bfa) \
357 bfa_ioc_clr_stats(&(__bfa)->ioc)
358#define bfa_get_nports(__bfa) \
359 bfa_ioc_get_nports(&(__bfa)->ioc)
360#define bfa_get_adapter_manufacturer(__bfa, __manufacturer) \
361 bfa_ioc_get_adapter_manufacturer(&(__bfa)->ioc, __manufacturer)
362#define bfa_get_adapter_model(__bfa, __model) \
363 bfa_ioc_get_adapter_model(&(__bfa)->ioc, __model)
364#define bfa_get_adapter_serial_num(__bfa, __serial_num) \
365 bfa_ioc_get_adapter_serial_num(&(__bfa)->ioc, __serial_num)
366#define bfa_get_adapter_fw_ver(__bfa, __fw_ver) \
367 bfa_ioc_get_adapter_fw_ver(&(__bfa)->ioc, __fw_ver)
368#define bfa_get_adapter_optrom_ver(__bfa, __optrom_ver) \
369 bfa_ioc_get_adapter_optrom_ver(&(__bfa)->ioc, __optrom_ver)
370#define bfa_get_pci_chip_rev(__bfa, __chip_rev) \
371 bfa_ioc_get_pci_chip_rev(&(__bfa)->ioc, __chip_rev)
372#define bfa_get_ioc_state(__bfa) \
373 bfa_ioc_get_state(&(__bfa)->ioc)
374#define bfa_get_type(__bfa) \
375 bfa_ioc_get_type(&(__bfa)->ioc)
376#define bfa_get_mac(__bfa) \
377 bfa_ioc_get_mac(&(__bfa)->ioc)
378#define bfa_get_mfg_mac(__bfa) \
379 bfa_ioc_get_mfg_mac(&(__bfa)->ioc)
380#define bfa_get_fw_clock_res(__bfa) \
381 ((__bfa)->iocfc.cfgrsp->fwcfg.fw_tick_res)
382
383void bfa_get_pciids(struct bfa_pciid_s **pciids, int *npciids);
384void bfa_cfg_get_default(struct bfa_iocfc_cfg_s *cfg);
385void bfa_cfg_get_min(struct bfa_iocfc_cfg_s *cfg);
386void bfa_cfg_get_meminfo(struct bfa_iocfc_cfg_s *cfg,
387 struct bfa_meminfo_s *meminfo);
388void bfa_attach(struct bfa_s *bfa, void *bfad, struct bfa_iocfc_cfg_s *cfg,
389 struct bfa_meminfo_s *meminfo,
390 struct bfa_pcidev_s *pcidev);
a36c61f9 391void bfa_detach(struct bfa_s *bfa);
a36c61f9
KG		 392void bfa_cb_init(void *bfad, bfa_status_t status);
393void bfa_cb_updateq(void *bfad, bfa_status_t status);
394
395bfa_boolean_t bfa_intx(struct bfa_s *bfa);
a36c61f9
KG		 396void bfa_isr_enable(struct bfa_s *bfa);
397void bfa_isr_disable(struct bfa_s *bfa);
398
399void bfa_comp_deq(struct bfa_s *bfa, struct list_head *comp_q);
400void bfa_comp_process(struct bfa_s *bfa, struct list_head *comp_q);
401void bfa_comp_free(struct bfa_s *bfa, struct list_head *comp_q);
402
403typedef void (*bfa_cb_ioc_t) (void *cbarg, enum bfa_status status);
404void bfa_iocfc_get_attr(struct bfa_s *bfa, struct bfa_iocfc_attr_s *attr);
a36c61f9 405
a36c61f9
KG		 406
407bfa_status_t bfa_iocfc_israttr_set(struct bfa_s *bfa,
408 struct bfa_iocfc_intr_attr_s *attr);
409
410void bfa_iocfc_enable(struct bfa_s *bfa);
411void bfa_iocfc_disable(struct bfa_s *bfa);
a36c61f9
KG		 412#define bfa_timer_start(_bfa, _timer, _timercb, _arg, _timeout) \
413 bfa_timer_begin(&(_bfa)->timer_mod, _timer, _timercb, _arg, _timeout)
414
a36c61f9 415#endif /* __BFA_H__ */
Ubuntu Artful kernel mirror