xref: /linux/drivers/scsi/bfa/bfa_ioc.h (revision 26fbb4c8c7c3ee9a4c3b4de555a8587b5a19154e)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * Copyright (c) 2005-2014 Brocade Communications Systems, Inc.
4  * Copyright (c) 2014- QLogic Corporation.
5  * All rights reserved
6  * www.qlogic.com
7  *
8  * Linux driver for QLogic BR-series Fibre Channel Host Bus Adapter.
9  */
10 
11 #ifndef __BFA_IOC_H__
12 #define __BFA_IOC_H__
13 
14 #include "bfad_drv.h"
15 #include "bfa_cs.h"
16 #include "bfi.h"
17 
18 #define BFA_DBG_FWTRC_ENTS	(BFI_IOC_TRC_ENTS)
19 #define BFA_DBG_FWTRC_LEN					\
20 	(BFA_DBG_FWTRC_ENTS * sizeof(struct bfa_trc_s) +	\
21 	(sizeof(struct bfa_trc_mod_s) -				\
22 	BFA_TRC_MAX * sizeof(struct bfa_trc_s)))
23 /*
24  * BFA timer declarations
25  */
26 typedef void (*bfa_timer_cbfn_t)(void *);
27 
28 /*
29  * BFA timer data structure
30  */
31 struct bfa_timer_s {
32 	struct list_head	qe;
33 	bfa_timer_cbfn_t timercb;
34 	void		*arg;
35 	int		timeout;	/* in millisecs */
36 };
37 
38 /*
39  * Timer module structure
40  */
41 struct bfa_timer_mod_s {
42 	struct list_head timer_q;
43 };
44 
45 #define BFA_TIMER_FREQ 200 /* specified in millisecs */
46 
47 void bfa_timer_beat(struct bfa_timer_mod_s *mod);
48 void bfa_timer_begin(struct bfa_timer_mod_s *mod, struct bfa_timer_s *timer,
49 			bfa_timer_cbfn_t timercb, void *arg,
50 			unsigned int timeout);
51 void bfa_timer_stop(struct bfa_timer_s *timer);
52 
53 /*
54  * Generic Scatter Gather Element used by driver
55  */
56 struct bfa_sge_s {
57 	u32	sg_len;
58 	void		*sg_addr;
59 };
60 
61 #define bfa_sge_word_swap(__sge) do {					     \
62 	((u32 *)(__sge))[0] = swab32(((u32 *)(__sge))[0]);      \
63 	((u32 *)(__sge))[1] = swab32(((u32 *)(__sge))[1]);      \
64 	((u32 *)(__sge))[2] = swab32(((u32 *)(__sge))[2]);      \
65 } while (0)
66 
67 #define bfa_swap_words(_x)  (	\
68 	((u64)(_x) << 32) | ((u64)(_x) >> 32))
69 
70 #ifdef __BIG_ENDIAN
71 #define bfa_sge_to_be(_x)
72 #define bfa_sge_to_le(_x)	bfa_sge_word_swap(_x)
73 #define bfa_sgaddr_le(_x)	bfa_swap_words(_x)
74 #else
75 #define	bfa_sge_to_be(_x)	bfa_sge_word_swap(_x)
76 #define bfa_sge_to_le(_x)
77 #define bfa_sgaddr_le(_x)	(_x)
78 #endif
79 
80 /*
81  * BFA memory resources
82  */
83 struct bfa_mem_dma_s {
84 	struct list_head qe;		/* Queue of DMA elements */
85 	u32		mem_len;	/* Total Length in Bytes */
86 	u8		*kva;		/* kernel virtual address */
87 	u64		dma;		/* dma address if DMA memory */
88 	u8		*kva_curp;	/* kva allocation cursor */
89 	u64		dma_curp;	/* dma allocation cursor */
90 };
91 #define bfa_mem_dma_t struct bfa_mem_dma_s
92 
93 struct bfa_mem_kva_s {
94 	struct list_head qe;		/* Queue of KVA elements */
95 	u32		mem_len;	/* Total Length in Bytes */
96 	u8		*kva;		/* kernel virtual address */
97 	u8		*kva_curp;	/* kva allocation cursor */
98 };
99 #define bfa_mem_kva_t struct bfa_mem_kva_s
100 
101 struct bfa_meminfo_s {
102 	struct bfa_mem_dma_s dma_info;
103 	struct bfa_mem_kva_s kva_info;
104 };
105 
106 /* BFA memory segment setup helpers */
107 static inline void bfa_mem_dma_setup(struct bfa_meminfo_s *meminfo,
108 				     struct bfa_mem_dma_s *dm_ptr,
109 				     size_t seg_sz)
110 {
111 	dm_ptr->mem_len = seg_sz;
112 	if (seg_sz)
113 		list_add_tail(&dm_ptr->qe, &meminfo->dma_info.qe);
114 }
115 
116 static inline void bfa_mem_kva_setup(struct bfa_meminfo_s *meminfo,
117 				     struct bfa_mem_kva_s *kva_ptr,
118 				     size_t seg_sz)
119 {
120 	kva_ptr->mem_len = seg_sz;
121 	if (seg_sz)
122 		list_add_tail(&kva_ptr->qe, &meminfo->kva_info.qe);
123 }
124 
125 /* BFA dma memory segments iterator */
126 #define bfa_mem_dma_sptr(_mod, _i)	(&(_mod)->dma_seg[(_i)])
127 #define bfa_mem_dma_seg_iter(_mod, _sptr, _nr, _i)			\
128 	for (_i = 0, _sptr = bfa_mem_dma_sptr(_mod, _i); _i < (_nr);	\
129 	     _i++, _sptr = bfa_mem_dma_sptr(_mod, _i))
130 
131 #define bfa_mem_kva_curp(_mod)	((_mod)->kva_seg.kva_curp)
132 #define bfa_mem_dma_virt(_sptr)	((_sptr)->kva_curp)
133 #define bfa_mem_dma_phys(_sptr)	((_sptr)->dma_curp)
134 #define bfa_mem_dma_len(_sptr)	((_sptr)->mem_len)
135 
136 /* Get the corresponding dma buf kva for a req - from the tag */
137 #define bfa_mem_get_dmabuf_kva(_mod, _tag, _rqsz)			      \
138 	(((u8 *)(_mod)->dma_seg[BFI_MEM_SEG_FROM_TAG(_tag, _rqsz)].kva_curp) +\
139 	 BFI_MEM_SEG_REQ_OFFSET(_tag, _rqsz) * (_rqsz))
140 
141 /* Get the corresponding dma buf pa for a req - from the tag */
142 #define bfa_mem_get_dmabuf_pa(_mod, _tag, _rqsz)			\
143 	((_mod)->dma_seg[BFI_MEM_SEG_FROM_TAG(_tag, _rqsz)].dma_curp +	\
144 	 BFI_MEM_SEG_REQ_OFFSET(_tag, _rqsz) * (_rqsz))
145 
146 /*
147  * PCI device information required by IOC
148  */
149 struct bfa_pcidev_s {
150 	int		pci_slot;
151 	u8		pci_func;
152 	u16		device_id;
153 	u16		ssid;
154 	void __iomem	*pci_bar_kva;
155 };
156 
157 /*
158  * Structure used to remember the DMA-able memory block's KVA and Physical
159  * Address
160  */
161 struct bfa_dma_s {
162 	void		*kva;	/* ! Kernel virtual address	*/
163 	u64	pa;	/* ! Physical address		*/
164 };
165 
166 #define BFA_DMA_ALIGN_SZ	256
167 #define BFA_ROUNDUP(_l, _s)	(((_l) + ((_s) - 1)) & ~((_s) - 1))
168 
169 /*
170  * smem size for Crossbow and Catapult
171  */
172 #define BFI_SMEM_CB_SIZE	0x200000U	/* ! 2MB for crossbow	*/
173 #define BFI_SMEM_CT_SIZE	0x280000U	/* ! 2.5MB for catapult	*/
174 
175 #define bfa_dma_be_addr_set(dma_addr, pa)	\
176 		__bfa_dma_be_addr_set(&dma_addr, (u64)pa)
177 static inline void
178 __bfa_dma_be_addr_set(union bfi_addr_u *dma_addr, u64 pa)
179 {
180 	dma_addr->a32.addr_lo = cpu_to_be32(pa);
181 	dma_addr->a32.addr_hi = cpu_to_be32(pa >> 32);
182 }
183 
184 #define bfa_alen_set(__alen, __len, __pa)	\
185 	__bfa_alen_set(__alen, __len, (u64)__pa)
186 
187 static inline void
188 __bfa_alen_set(struct bfi_alen_s *alen, u32 len, u64 pa)
189 {
190 	alen->al_len = cpu_to_be32(len);
191 	bfa_dma_be_addr_set(alen->al_addr, pa);
192 }
193 
194 struct bfa_ioc_regs_s {
195 	void __iomem *hfn_mbox_cmd;
196 	void __iomem *hfn_mbox;
197 	void __iomem *lpu_mbox_cmd;
198 	void __iomem *lpu_mbox;
199 	void __iomem *lpu_read_stat;
200 	void __iomem *pss_ctl_reg;
201 	void __iomem *pss_err_status_reg;
202 	void __iomem *app_pll_fast_ctl_reg;
203 	void __iomem *app_pll_slow_ctl_reg;
204 	void __iomem *ioc_sem_reg;
205 	void __iomem *ioc_usage_sem_reg;
206 	void __iomem *ioc_init_sem_reg;
207 	void __iomem *ioc_usage_reg;
208 	void __iomem *host_page_num_fn;
209 	void __iomem *heartbeat;
210 	void __iomem *ioc_fwstate;
211 	void __iomem *alt_ioc_fwstate;
212 	void __iomem *ll_halt;
213 	void __iomem *alt_ll_halt;
214 	void __iomem *err_set;
215 	void __iomem *ioc_fail_sync;
216 	void __iomem *shirq_isr_next;
217 	void __iomem *shirq_msk_next;
218 	void __iomem *smem_page_start;
219 	u32	smem_pg0;
220 };
221 
222 #define bfa_mem_read(_raddr, _off)	swab32(readl(((_raddr) + (_off))))
223 #define bfa_mem_write(_raddr, _off, _val)	\
224 			writel(swab32((_val)), ((_raddr) + (_off)))
225 /*
226  * IOC Mailbox structures
227  */
228 struct bfa_mbox_cmd_s {
229 	struct list_head	qe;
230 	u32	msg[BFI_IOC_MSGSZ];
231 };
232 
233 /*
234  * IOC mailbox module
235  */
236 typedef void (*bfa_ioc_mbox_mcfunc_t)(void *cbarg, struct bfi_mbmsg_s *m);
237 struct bfa_ioc_mbox_mod_s {
238 	struct list_head		cmd_q;	/*  pending mbox queue	*/
239 	int			nmclass;	/*  number of handlers */
240 	struct {
241 		bfa_ioc_mbox_mcfunc_t	cbfn;	/*  message handlers	*/
242 		void			*cbarg;
243 	} mbhdlr[BFI_MC_MAX];
244 };
245 
246 /*
247  * IOC callback function interfaces
248  */
249 typedef void (*bfa_ioc_enable_cbfn_t)(void *bfa, enum bfa_status status);
250 typedef void (*bfa_ioc_disable_cbfn_t)(void *bfa);
251 typedef void (*bfa_ioc_hbfail_cbfn_t)(void *bfa);
252 typedef void (*bfa_ioc_reset_cbfn_t)(void *bfa);
253 struct bfa_ioc_cbfn_s {
254 	bfa_ioc_enable_cbfn_t	enable_cbfn;
255 	bfa_ioc_disable_cbfn_t	disable_cbfn;
256 	bfa_ioc_hbfail_cbfn_t	hbfail_cbfn;
257 	bfa_ioc_reset_cbfn_t	reset_cbfn;
258 };
259 
260 /*
261  * IOC event notification mechanism.
262  */
263 enum bfa_ioc_event_e {
264 	BFA_IOC_E_ENABLED	= 1,
265 	BFA_IOC_E_DISABLED	= 2,
266 	BFA_IOC_E_FAILED	= 3,
267 };
268 
269 typedef void (*bfa_ioc_notify_cbfn_t)(void *, enum bfa_ioc_event_e);
270 
271 struct bfa_ioc_notify_s {
272 	struct list_head		qe;
273 	bfa_ioc_notify_cbfn_t	cbfn;
274 	void			*cbarg;
275 };
276 
277 /*
278  * Initialize a IOC event notification structure
279  */
280 #define bfa_ioc_notify_init(__notify, __cbfn, __cbarg) do {	\
281 	(__notify)->cbfn = (__cbfn);      \
282 	(__notify)->cbarg = (__cbarg);      \
283 } while (0)
284 
285 struct bfa_iocpf_s {
286 	bfa_fsm_t		fsm;
287 	struct bfa_ioc_s	*ioc;
288 	bfa_boolean_t		fw_mismatch_notified;
289 	bfa_boolean_t		auto_recover;
290 	u32			poll_time;
291 };
292 
293 struct bfa_ioc_s {
294 	bfa_fsm_t		fsm;
295 	struct bfa_s		*bfa;
296 	struct bfa_pcidev_s	pcidev;
297 	struct bfa_timer_mod_s	*timer_mod;
298 	struct bfa_timer_s	ioc_timer;
299 	struct bfa_timer_s	sem_timer;
300 	struct bfa_timer_s	hb_timer;
301 	u32		hb_count;
302 	struct list_head	notify_q;
303 	void			*dbg_fwsave;
304 	int			dbg_fwsave_len;
305 	bfa_boolean_t		dbg_fwsave_once;
306 	enum bfi_pcifn_class	clscode;
307 	struct bfa_ioc_regs_s	ioc_regs;
308 	struct bfa_trc_mod_s	*trcmod;
309 	struct bfa_ioc_drv_stats_s	stats;
310 	bfa_boolean_t		fcmode;
311 	bfa_boolean_t		pllinit;
312 	bfa_boolean_t		stats_busy;	/*  outstanding stats */
313 	u8			port_id;
314 	struct bfa_dma_s	attr_dma;
315 	struct bfi_ioc_attr_s	*attr;
316 	struct bfa_ioc_cbfn_s	*cbfn;
317 	struct bfa_ioc_mbox_mod_s mbox_mod;
318 	struct bfa_ioc_hwif_s	*ioc_hwif;
319 	struct bfa_iocpf_s	iocpf;
320 	enum bfi_asic_gen	asic_gen;
321 	enum bfi_asic_mode	asic_mode;
322 	enum bfi_port_mode	port0_mode;
323 	enum bfi_port_mode	port1_mode;
324 	enum bfa_mode_s		port_mode;
325 	u8			ad_cap_bm;	/* adapter cap bit mask */
326 	u8			port_mode_cfg;	/* config port mode */
327 	int			ioc_aen_seq;
328 };
329 
330 struct bfa_ioc_hwif_s {
331 	bfa_status_t (*ioc_pll_init) (void __iomem *rb, enum bfi_asic_mode m);
332 	bfa_boolean_t	(*ioc_firmware_lock)	(struct bfa_ioc_s *ioc);
333 	void		(*ioc_firmware_unlock)	(struct bfa_ioc_s *ioc);
334 	void		(*ioc_reg_init)	(struct bfa_ioc_s *ioc);
335 	void		(*ioc_map_port)	(struct bfa_ioc_s *ioc);
336 	void		(*ioc_isr_mode_set)	(struct bfa_ioc_s *ioc,
337 					bfa_boolean_t msix);
338 	void		(*ioc_notify_fail)	(struct bfa_ioc_s *ioc);
339 	void		(*ioc_ownership_reset)	(struct bfa_ioc_s *ioc);
340 	bfa_boolean_t   (*ioc_sync_start)       (struct bfa_ioc_s *ioc);
341 	void		(*ioc_sync_join)	(struct bfa_ioc_s *ioc);
342 	void		(*ioc_sync_leave)	(struct bfa_ioc_s *ioc);
343 	void		(*ioc_sync_ack)		(struct bfa_ioc_s *ioc);
344 	bfa_boolean_t	(*ioc_sync_complete)	(struct bfa_ioc_s *ioc);
345 	bfa_boolean_t	(*ioc_lpu_read_stat)	(struct bfa_ioc_s *ioc);
346 	void		(*ioc_set_fwstate)	(struct bfa_ioc_s *ioc,
347 					enum bfi_ioc_state fwstate);
348 	enum bfi_ioc_state	(*ioc_get_fwstate)	(struct bfa_ioc_s *ioc);
349 	void		(*ioc_set_alt_fwstate)	(struct bfa_ioc_s *ioc,
350 					enum bfi_ioc_state fwstate);
351 	enum bfi_ioc_state	(*ioc_get_alt_fwstate)	(struct bfa_ioc_s *ioc);
352 };
353 
354 /*
355  * Queue element to wait for room in request queue. FIFO order is
356  * maintained when fullfilling requests.
357  */
358 struct bfa_reqq_wait_s {
359 	struct list_head	qe;
360 	void	(*qresume) (void *cbarg);
361 	void	*cbarg;
362 };
363 
364 typedef void	(*bfa_cb_cbfn_t) (void *cbarg, bfa_boolean_t complete);
365 
366 /*
367  * Generic BFA callback element.
368  */
369 struct bfa_cb_qe_s {
370 	struct list_head	qe;
371 	bfa_cb_cbfn_t	cbfn;
372 	bfa_boolean_t	once;
373 	bfa_boolean_t	pre_rmv;	/* set for stack based qe(s) */
374 	bfa_status_t	fw_status;	/* to access fw status in comp proc */
375 	void		*cbarg;
376 };
377 
378 /*
379  * IOCFC state machine definitions/declarations
380  */
381 enum iocfc_event {
382 	IOCFC_E_INIT		= 1,	/* IOCFC init request		*/
383 	IOCFC_E_START		= 2,	/* IOCFC mod start request	*/
384 	IOCFC_E_STOP		= 3,	/* IOCFC stop request		*/
385 	IOCFC_E_ENABLE		= 4,	/* IOCFC enable request		*/
386 	IOCFC_E_DISABLE		= 5,	/* IOCFC disable request	*/
387 	IOCFC_E_IOC_ENABLED	= 6,	/* IOC enabled message		*/
388 	IOCFC_E_IOC_DISABLED	= 7,	/* IOC disabled message		*/
389 	IOCFC_E_IOC_FAILED	= 8,	/* failure notice by IOC sm	*/
390 	IOCFC_E_DCONF_DONE	= 9,	/* dconf read/write done	*/
391 	IOCFC_E_CFG_DONE	= 10,	/* IOCFC config complete	*/
392 };
393 
394 /*
395  * ASIC block configurtion related
396  */
397 
398 typedef void (*bfa_ablk_cbfn_t)(void *, enum bfa_status);
399 
400 struct bfa_ablk_s {
401 	struct bfa_ioc_s	*ioc;
402 	struct bfa_ablk_cfg_s	*cfg;
403 	u16			*pcifn;
404 	struct bfa_dma_s	dma_addr;
405 	bfa_boolean_t		busy;
406 	struct bfa_mbox_cmd_s	mb;
407 	bfa_ablk_cbfn_t		cbfn;
408 	void			*cbarg;
409 	struct bfa_ioc_notify_s	ioc_notify;
410 	struct bfa_mem_dma_s	ablk_dma;
411 };
412 #define BFA_MEM_ABLK_DMA(__bfa)		(&((__bfa)->modules.ablk.ablk_dma))
413 
414 /*
415  *	SFP module specific
416  */
417 typedef void	(*bfa_cb_sfp_t) (void *cbarg, bfa_status_t status);
418 
419 struct bfa_sfp_s {
420 	void	*dev;
421 	struct bfa_ioc_s	*ioc;
422 	struct bfa_trc_mod_s	*trcmod;
423 	struct sfp_mem_s	*sfpmem;
424 	bfa_cb_sfp_t		cbfn;
425 	void			*cbarg;
426 	enum bfi_sfp_mem_e	memtype; /* mem access type   */
427 	u32			status;
428 	struct bfa_mbox_cmd_s	mbcmd;
429 	u8			*dbuf_kva; /* dma buf virtual address */
430 	u64			dbuf_pa;   /* dma buf physical address */
431 	struct bfa_ioc_notify_s	ioc_notify;
432 	enum bfa_defs_sfp_media_e *media;
433 	enum bfa_port_speed	portspeed;
434 	bfa_cb_sfp_t		state_query_cbfn;
435 	void			*state_query_cbarg;
436 	u8			lock;
437 	u8			data_valid; /* data in dbuf is valid */
438 	u8			state;	    /* sfp state  */
439 	u8			state_query_lock;
440 	struct bfa_mem_dma_s	sfp_dma;
441 	u8			is_elb;	    /* eloopback  */
442 };
443 
444 #define BFA_SFP_MOD(__bfa)	(&(__bfa)->modules.sfp)
445 #define BFA_MEM_SFP_DMA(__bfa)	(&(BFA_SFP_MOD(__bfa)->sfp_dma))
446 
447 u32	bfa_sfp_meminfo(void);
448 
449 void	bfa_sfp_attach(struct bfa_sfp_s *sfp, struct bfa_ioc_s *ioc,
450 			void *dev, struct bfa_trc_mod_s *trcmod);
451 
452 void	bfa_sfp_memclaim(struct bfa_sfp_s *diag, u8 *dm_kva, u64 dm_pa);
453 void	bfa_sfp_intr(void *bfaarg, struct bfi_mbmsg_s *msg);
454 
455 bfa_status_t	bfa_sfp_show(struct bfa_sfp_s *sfp, struct sfp_mem_s *sfpmem,
456 			     bfa_cb_sfp_t cbfn, void *cbarg);
457 
458 bfa_status_t	bfa_sfp_media(struct bfa_sfp_s *sfp,
459 			enum bfa_defs_sfp_media_e *media,
460 			bfa_cb_sfp_t cbfn, void *cbarg);
461 
462 bfa_status_t	bfa_sfp_speed(struct bfa_sfp_s *sfp,
463 			enum bfa_port_speed portspeed,
464 			bfa_cb_sfp_t cbfn, void *cbarg);
465 
466 /*
467  *	Flash module specific
468  */
469 typedef void	(*bfa_cb_flash_t) (void *cbarg, bfa_status_t status);
470 
471 struct bfa_flash_s {
472 	struct bfa_ioc_s *ioc;		/* back pointer to ioc */
473 	struct bfa_trc_mod_s *trcmod;
474 	u32		type;           /* partition type */
475 	u8		instance;       /* partition instance */
476 	u8		rsv[3];
477 	u32		op_busy;        /*  operation busy flag */
478 	u32		residue;        /*  residual length */
479 	u32		offset;         /*  offset */
480 	bfa_status_t	status;         /*  status */
481 	u8		*dbuf_kva;      /*  dma buf virtual address */
482 	u64		dbuf_pa;        /*  dma buf physical address */
483 	struct bfa_reqq_wait_s	reqq_wait; /*  to wait for room in reqq */
484 	bfa_cb_flash_t	cbfn;           /*  user callback function */
485 	void		*cbarg;         /*  user callback arg */
486 	u8		*ubuf;          /*  user supplied buffer */
487 	struct bfa_cb_qe_s	hcb_qe; /*  comp: BFA callback qelem */
488 	u32		addr_off;       /*  partition address offset */
489 	struct bfa_mbox_cmd_s	mb;       /*  mailbox */
490 	struct bfa_ioc_notify_s	ioc_notify; /*  ioc event notify */
491 	struct bfa_mem_dma_s	flash_dma;
492 };
493 
494 #define BFA_FLASH(__bfa)		(&(__bfa)->modules.flash)
495 #define BFA_MEM_FLASH_DMA(__bfa)	(&(BFA_FLASH(__bfa)->flash_dma))
496 
497 bfa_status_t bfa_flash_get_attr(struct bfa_flash_s *flash,
498 			struct bfa_flash_attr_s *attr,
499 			bfa_cb_flash_t cbfn, void *cbarg);
500 bfa_status_t bfa_flash_erase_part(struct bfa_flash_s *flash,
501 			enum bfa_flash_part_type type, u8 instance,
502 			bfa_cb_flash_t cbfn, void *cbarg);
503 bfa_status_t bfa_flash_update_part(struct bfa_flash_s *flash,
504 			enum bfa_flash_part_type type, u8 instance,
505 			void *buf, u32 len, u32 offset,
506 			bfa_cb_flash_t cbfn, void *cbarg);
507 bfa_status_t bfa_flash_read_part(struct bfa_flash_s *flash,
508 			enum bfa_flash_part_type type, u8 instance, void *buf,
509 			u32 len, u32 offset, bfa_cb_flash_t cbfn, void *cbarg);
510 u32	bfa_flash_meminfo(bfa_boolean_t mincfg);
511 void bfa_flash_attach(struct bfa_flash_s *flash, struct bfa_ioc_s *ioc,
512 		void *dev, struct bfa_trc_mod_s *trcmod, bfa_boolean_t mincfg);
513 void bfa_flash_memclaim(struct bfa_flash_s *flash,
514 		u8 *dm_kva, u64 dm_pa, bfa_boolean_t mincfg);
515 bfa_status_t    bfa_flash_raw_read(void __iomem *pci_bar_kva,
516 				u32 offset, char *buf, u32 len);
517 
518 /*
519  *	DIAG module specific
520  */
521 
522 typedef void (*bfa_cb_diag_t) (void *cbarg, bfa_status_t status);
523 typedef void (*bfa_cb_diag_beacon_t) (void *dev, bfa_boolean_t beacon,
524 			bfa_boolean_t link_e2e_beacon);
525 
526 /*
527  *      Firmware ping test results
528  */
529 struct bfa_diag_results_fwping {
530 	u32     data;   /* store the corrupted data */
531 	u32     status;
532 	u32     dmastatus;
533 	u8      rsvd[4];
534 };
535 
536 struct bfa_diag_qtest_result_s {
537 	u32	status;
538 	u16	count;	/* successful queue test count */
539 	u8	queue;
540 	u8	rsvd;	/* 64-bit align */
541 };
542 
543 /*
544  * Firmware ping test results
545  */
546 struct bfa_diag_fwping_s {
547 	struct bfa_diag_results_fwping *result;
548 	bfa_cb_diag_t  cbfn;
549 	void            *cbarg;
550 	u32             data;
551 	u8              lock;
552 	u8              rsv[3];
553 	u32             status;
554 	u32             count;
555 	struct bfa_mbox_cmd_s   mbcmd;
556 	u8              *dbuf_kva;      /* dma buf virtual address */
557 	u64             dbuf_pa;        /* dma buf physical address */
558 };
559 
560 /*
561  *      Temperature sensor query results
562  */
563 struct bfa_diag_results_tempsensor_s {
564 	u32     status;
565 	u16     temp;           /* 10-bit A/D value */
566 	u16     brd_temp;       /* 9-bit board temp */
567 	u8      ts_junc;        /* show junction tempsensor   */
568 	u8      ts_brd;         /* show board tempsensor      */
569 	u8      rsvd[6];        /* keep 8 bytes alignment     */
570 };
571 
572 struct bfa_diag_tsensor_s {
573 	bfa_cb_diag_t   cbfn;
574 	void            *cbarg;
575 	struct bfa_diag_results_tempsensor_s *temp;
576 	u8              lock;
577 	u8              rsv[3];
578 	u32             status;
579 	struct bfa_mbox_cmd_s   mbcmd;
580 };
581 
582 struct bfa_diag_sfpshow_s {
583 	struct sfp_mem_s        *sfpmem;
584 	bfa_cb_diag_t           cbfn;
585 	void                    *cbarg;
586 	u8      lock;
587 	u8      static_data;
588 	u8      rsv[2];
589 	u32     status;
590 	struct bfa_mbox_cmd_s    mbcmd;
591 	u8      *dbuf_kva;      /* dma buf virtual address */
592 	u64     dbuf_pa;        /* dma buf physical address */
593 };
594 
595 struct bfa_diag_led_s {
596 	struct bfa_mbox_cmd_s   mbcmd;
597 	bfa_boolean_t   lock;   /* 1: ledtest is operating */
598 };
599 
600 struct bfa_diag_beacon_s {
601 	struct bfa_mbox_cmd_s   mbcmd;
602 	bfa_boolean_t   state;          /* port beacon state */
603 	bfa_boolean_t   link_e2e;       /* link beacon state */
604 };
605 
606 struct bfa_diag_s {
607 	void	*dev;
608 	struct bfa_ioc_s		*ioc;
609 	struct bfa_trc_mod_s		*trcmod;
610 	struct bfa_diag_fwping_s	fwping;
611 	struct bfa_diag_tsensor_s	tsensor;
612 	struct bfa_diag_sfpshow_s	sfpshow;
613 	struct bfa_diag_led_s		ledtest;
614 	struct bfa_diag_beacon_s	beacon;
615 	void	*result;
616 	struct bfa_timer_s timer;
617 	bfa_cb_diag_beacon_t  cbfn_beacon;
618 	bfa_cb_diag_t  cbfn;
619 	void		*cbarg;
620 	u8		block;
621 	u8		timer_active;
622 	u8		rsvd[2];
623 	u32		status;
624 	struct bfa_ioc_notify_s	ioc_notify;
625 	struct bfa_mem_dma_s	diag_dma;
626 };
627 
628 #define BFA_DIAG_MOD(__bfa)     (&(__bfa)->modules.diag_mod)
629 #define BFA_MEM_DIAG_DMA(__bfa) (&(BFA_DIAG_MOD(__bfa)->diag_dma))
630 
631 u32	bfa_diag_meminfo(void);
632 void bfa_diag_memclaim(struct bfa_diag_s *diag, u8 *dm_kva, u64 dm_pa);
633 void bfa_diag_attach(struct bfa_diag_s *diag, struct bfa_ioc_s *ioc, void *dev,
634 		     bfa_cb_diag_beacon_t cbfn_beacon,
635 		     struct bfa_trc_mod_s *trcmod);
636 bfa_status_t	bfa_diag_reg_read(struct bfa_diag_s *diag, u32 offset,
637 			u32 len, u32 *buf, u32 force);
638 bfa_status_t	bfa_diag_reg_write(struct bfa_diag_s *diag, u32 offset,
639 			u32 len, u32 value, u32 force);
640 bfa_status_t	bfa_diag_tsensor_query(struct bfa_diag_s *diag,
641 			struct bfa_diag_results_tempsensor_s *result,
642 			bfa_cb_diag_t cbfn, void *cbarg);
643 bfa_status_t	bfa_diag_fwping(struct bfa_diag_s *diag, u32 cnt,
644 			u32 pattern, struct bfa_diag_results_fwping *result,
645 			bfa_cb_diag_t cbfn, void *cbarg);
646 bfa_status_t	bfa_diag_sfpshow(struct bfa_diag_s *diag,
647 			struct sfp_mem_s *sfpmem, u8 static_data,
648 			bfa_cb_diag_t cbfn, void *cbarg);
649 bfa_status_t	bfa_diag_memtest(struct bfa_diag_s *diag,
650 			struct bfa_diag_memtest_s *memtest, u32 pattern,
651 			struct bfa_diag_memtest_result *result,
652 			bfa_cb_diag_t cbfn, void *cbarg);
653 bfa_status_t	bfa_diag_ledtest(struct bfa_diag_s *diag,
654 			struct bfa_diag_ledtest_s *ledtest);
655 bfa_status_t	bfa_diag_beacon_port(struct bfa_diag_s *diag,
656 			bfa_boolean_t beacon, bfa_boolean_t link_e2e_beacon,
657 			u32 sec);
658 
659 /*
660  *	PHY module specific
661  */
662 typedef void (*bfa_cb_phy_t) (void *cbarg, bfa_status_t status);
663 
664 struct bfa_phy_s {
665 	struct bfa_ioc_s *ioc;          /* back pointer to ioc */
666 	struct bfa_trc_mod_s *trcmod;   /* trace module */
667 	u8	instance;       /* port instance */
668 	u8	op_busy;        /* operation busy flag */
669 	u8	rsv[2];
670 	u32	residue;        /* residual length */
671 	u32	offset;         /* offset */
672 	bfa_status_t	status;         /* status */
673 	u8	*dbuf_kva;      /* dma buf virtual address */
674 	u64	dbuf_pa;        /* dma buf physical address */
675 	struct bfa_reqq_wait_s reqq_wait; /* to wait for room in reqq */
676 	bfa_cb_phy_t	cbfn;           /* user callback function */
677 	void		*cbarg;         /* user callback arg */
678 	u8		*ubuf;          /* user supplied buffer */
679 	struct bfa_cb_qe_s	hcb_qe; /* comp: BFA callback qelem */
680 	u32	addr_off;       /* phy address offset */
681 	struct bfa_mbox_cmd_s	mb;       /* mailbox */
682 	struct bfa_ioc_notify_s	ioc_notify; /* ioc event notify */
683 	struct bfa_mem_dma_s	phy_dma;
684 };
685 #define BFA_PHY(__bfa)	(&(__bfa)->modules.phy)
686 #define BFA_MEM_PHY_DMA(__bfa)	(&(BFA_PHY(__bfa)->phy_dma))
687 
688 bfa_boolean_t bfa_phy_busy(struct bfa_ioc_s *ioc);
689 bfa_status_t bfa_phy_get_attr(struct bfa_phy_s *phy, u8 instance,
690 			struct bfa_phy_attr_s *attr,
691 			bfa_cb_phy_t cbfn, void *cbarg);
692 bfa_status_t bfa_phy_get_stats(struct bfa_phy_s *phy, u8 instance,
693 			struct bfa_phy_stats_s *stats,
694 			bfa_cb_phy_t cbfn, void *cbarg);
695 bfa_status_t bfa_phy_update(struct bfa_phy_s *phy, u8 instance,
696 			void *buf, u32 len, u32 offset,
697 			bfa_cb_phy_t cbfn, void *cbarg);
698 bfa_status_t bfa_phy_read(struct bfa_phy_s *phy, u8 instance,
699 			void *buf, u32 len, u32 offset,
700 			bfa_cb_phy_t cbfn, void *cbarg);
701 
702 u32	bfa_phy_meminfo(bfa_boolean_t mincfg);
703 void bfa_phy_attach(struct bfa_phy_s *phy, struct bfa_ioc_s *ioc,
704 		void *dev, struct bfa_trc_mod_s *trcmod, bfa_boolean_t mincfg);
705 void bfa_phy_memclaim(struct bfa_phy_s *phy,
706 		u8 *dm_kva, u64 dm_pa, bfa_boolean_t mincfg);
707 void bfa_phy_intr(void *phyarg, struct bfi_mbmsg_s *msg);
708 
709 /*
710  * FRU module specific
711  */
712 typedef void (*bfa_cb_fru_t) (void *cbarg, bfa_status_t status);
713 
714 struct bfa_fru_s {
715 	struct bfa_ioc_s *ioc;		/* back pointer to ioc */
716 	struct bfa_trc_mod_s *trcmod;	/* trace module */
717 	u8		op_busy;	/* operation busy flag */
718 	u8		rsv[3];
719 	u32		residue;	/* residual length */
720 	u32		offset;		/* offset */
721 	bfa_status_t	status;		/* status */
722 	u8		*dbuf_kva;	/* dma buf virtual address */
723 	u64		dbuf_pa;	/* dma buf physical address */
724 	struct bfa_reqq_wait_s reqq_wait; /* to wait for room in reqq */
725 	bfa_cb_fru_t	cbfn;		/* user callback function */
726 	void		*cbarg;		/* user callback arg */
727 	u8		*ubuf;		/* user supplied buffer */
728 	struct bfa_cb_qe_s	hcb_qe;	/* comp: BFA callback qelem */
729 	u32		addr_off;	/* fru address offset */
730 	struct bfa_mbox_cmd_s mb;	/* mailbox */
731 	struct bfa_ioc_notify_s ioc_notify; /* ioc event notify */
732 	struct bfa_mem_dma_s	fru_dma;
733 	u8		trfr_cmpl;
734 };
735 
736 #define BFA_FRU(__bfa)	(&(__bfa)->modules.fru)
737 #define BFA_MEM_FRU_DMA(__bfa)	(&(BFA_FRU(__bfa)->fru_dma))
738 
739 bfa_status_t bfa_fruvpd_update(struct bfa_fru_s *fru,
740 			void *buf, u32 len, u32 offset,
741 			bfa_cb_fru_t cbfn, void *cbarg, u8 trfr_cmpl);
742 bfa_status_t bfa_fruvpd_read(struct bfa_fru_s *fru,
743 			void *buf, u32 len, u32 offset,
744 			bfa_cb_fru_t cbfn, void *cbarg);
745 bfa_status_t bfa_fruvpd_get_max_size(struct bfa_fru_s *fru, u32 *max_size);
746 bfa_status_t bfa_tfru_write(struct bfa_fru_s *fru,
747 			void *buf, u32 len, u32 offset,
748 			bfa_cb_fru_t cbfn, void *cbarg);
749 bfa_status_t bfa_tfru_read(struct bfa_fru_s *fru,
750 			void *buf, u32 len, u32 offset,
751 			bfa_cb_fru_t cbfn, void *cbarg);
752 u32	bfa_fru_meminfo(bfa_boolean_t mincfg);
753 void bfa_fru_attach(struct bfa_fru_s *fru, struct bfa_ioc_s *ioc,
754 		void *dev, struct bfa_trc_mod_s *trcmod, bfa_boolean_t mincfg);
755 void bfa_fru_memclaim(struct bfa_fru_s *fru,
756 		u8 *dm_kva, u64 dm_pa, bfa_boolean_t mincfg);
757 void bfa_fru_intr(void *fruarg, struct bfi_mbmsg_s *msg);
758 
759 /*
760  * Driver Config( dconf) specific
761  */
762 #define BFI_DCONF_SIGNATURE	0xabcdabcd
763 #define BFI_DCONF_VERSION	1
764 
765 #pragma pack(1)
766 struct bfa_dconf_hdr_s {
767 	u32	signature;
768 	u32	version;
769 };
770 
771 struct bfa_dconf_s {
772 	struct bfa_dconf_hdr_s		hdr;
773 	struct bfa_lunmask_cfg_s	lun_mask;
774 	struct bfa_throttle_cfg_s	throttle_cfg;
775 };
776 #pragma pack()
777 
778 struct bfa_dconf_mod_s {
779 	bfa_sm_t		sm;
780 	u8			instance;
781 	bfa_boolean_t		read_data_valid;
782 	bfa_boolean_t		min_cfg;
783 	struct bfa_timer_s	timer;
784 	struct bfa_s		*bfa;
785 	void			*bfad;
786 	void			*trcmod;
787 	struct bfa_dconf_s	*dconf;
788 	struct bfa_mem_kva_s	kva_seg;
789 };
790 
791 #define BFA_DCONF_MOD(__bfa)	\
792 	(&(__bfa)->modules.dconf_mod)
793 #define BFA_MEM_DCONF_KVA(__bfa)	(&(BFA_DCONF_MOD(__bfa)->kva_seg))
794 #define bfa_dconf_read_data_valid(__bfa)	\
795 	(BFA_DCONF_MOD(__bfa)->read_data_valid)
796 #define BFA_DCONF_UPDATE_TOV	5000	/* memtest timeout in msec */
797 #define bfa_dconf_get_min_cfg(__bfa)	\
798 	(BFA_DCONF_MOD(__bfa)->min_cfg)
799 
800 void	bfa_dconf_modinit(struct bfa_s *bfa);
801 void	bfa_dconf_modexit(struct bfa_s *bfa);
802 bfa_status_t	bfa_dconf_update(struct bfa_s *bfa);
803 
804 /*
805  *	IOC specfic macros
806  */
807 #define bfa_ioc_pcifn(__ioc)		((__ioc)->pcidev.pci_func)
808 #define bfa_ioc_devid(__ioc)		((__ioc)->pcidev.device_id)
809 #define bfa_ioc_bar0(__ioc)		((__ioc)->pcidev.pci_bar_kva)
810 #define bfa_ioc_portid(__ioc)		((__ioc)->port_id)
811 #define bfa_ioc_asic_gen(__ioc)		((__ioc)->asic_gen)
812 #define bfa_ioc_is_cna(__ioc)	\
813 	((bfa_ioc_get_type(__ioc) == BFA_IOC_TYPE_FCoE) ||	\
814 	 (bfa_ioc_get_type(__ioc) == BFA_IOC_TYPE_LL))
815 #define bfa_ioc_fetch_stats(__ioc, __stats) \
816 		(((__stats)->drv_stats) = (__ioc)->stats)
817 #define bfa_ioc_clr_stats(__ioc)	\
818 		memset(&(__ioc)->stats, 0, sizeof((__ioc)->stats))
819 #define bfa_ioc_maxfrsize(__ioc)	((__ioc)->attr->maxfrsize)
820 #define bfa_ioc_rx_bbcredit(__ioc)	((__ioc)->attr->rx_bbcredit)
821 #define bfa_ioc_speed_sup(__ioc)	\
822 	((bfa_ioc_is_cna(__ioc)) ? BFA_PORT_SPEED_10GBPS :	\
823 	 BFI_ADAPTER_GETP(SPEED, (__ioc)->attr->adapter_prop))
824 #define bfa_ioc_get_nports(__ioc)	\
825 	BFI_ADAPTER_GETP(NPORTS, (__ioc)->attr->adapter_prop)
826 
827 #define bfa_ioc_stats(_ioc, _stats)	((_ioc)->stats._stats++)
828 #define BFA_IOC_FWIMG_MINSZ	(16 * 1024)
829 #define BFA_IOC_FW_SMEM_SIZE(__ioc)			\
830 	((bfa_ioc_asic_gen(__ioc) == BFI_ASIC_GEN_CB)	\
831 	 ? BFI_SMEM_CB_SIZE : BFI_SMEM_CT_SIZE)
832 #define BFA_IOC_FLASH_CHUNK_NO(off)		(off / BFI_FLASH_CHUNK_SZ_WORDS)
833 #define BFA_IOC_FLASH_OFFSET_IN_CHUNK(off)	(off % BFI_FLASH_CHUNK_SZ_WORDS)
834 #define BFA_IOC_FLASH_CHUNK_ADDR(chunkno)  (chunkno * BFI_FLASH_CHUNK_SZ_WORDS)
835 
836 /*
837  * IOC mailbox interface
838  */
839 void bfa_ioc_mbox_queue(struct bfa_ioc_s *ioc, struct bfa_mbox_cmd_s *cmd);
840 void bfa_ioc_mbox_register(struct bfa_ioc_s *ioc,
841 		bfa_ioc_mbox_mcfunc_t *mcfuncs);
842 void bfa_ioc_mbox_isr(struct bfa_ioc_s *ioc);
843 void bfa_ioc_mbox_send(struct bfa_ioc_s *ioc, void *ioc_msg, int len);
844 bfa_boolean_t bfa_ioc_msgget(struct bfa_ioc_s *ioc, void *mbmsg);
845 void bfa_ioc_mbox_regisr(struct bfa_ioc_s *ioc, enum bfi_mclass mc,
846 		bfa_ioc_mbox_mcfunc_t cbfn, void *cbarg);
847 
848 /*
849  * IOC interfaces
850  */
851 
852 #define bfa_ioc_pll_init_asic(__ioc) \
853 	((__ioc)->ioc_hwif->ioc_pll_init((__ioc)->pcidev.pci_bar_kva, \
854 			   (__ioc)->asic_mode))
855 
856 bfa_status_t bfa_ioc_pll_init(struct bfa_ioc_s *ioc);
857 bfa_status_t bfa_ioc_cb_pll_init(void __iomem *rb, enum bfi_asic_mode mode);
858 bfa_status_t bfa_ioc_ct_pll_init(void __iomem *rb, enum bfi_asic_mode mode);
859 bfa_status_t bfa_ioc_ct2_pll_init(void __iomem *rb, enum bfi_asic_mode mode);
860 
861 #define bfa_ioc_isr_mode_set(__ioc, __msix) do {			\
862 	if ((__ioc)->ioc_hwif->ioc_isr_mode_set)			\
863 		((__ioc)->ioc_hwif->ioc_isr_mode_set(__ioc, __msix));	\
864 } while (0)
865 #define	bfa_ioc_ownership_reset(__ioc)				\
866 			((__ioc)->ioc_hwif->ioc_ownership_reset(__ioc))
867 #define bfa_ioc_get_fcmode(__ioc)	((__ioc)->fcmode)
868 #define bfa_ioc_lpu_read_stat(__ioc) do {			\
869 	if ((__ioc)->ioc_hwif->ioc_lpu_read_stat)		\
870 		((__ioc)->ioc_hwif->ioc_lpu_read_stat(__ioc));	\
871 } while (0)
872 
873 void bfa_ioc_set_cb_hwif(struct bfa_ioc_s *ioc);
874 void bfa_ioc_set_ct_hwif(struct bfa_ioc_s *ioc);
875 void bfa_ioc_set_ct2_hwif(struct bfa_ioc_s *ioc);
876 void bfa_ioc_ct2_poweron(struct bfa_ioc_s *ioc);
877 
878 void bfa_ioc_attach(struct bfa_ioc_s *ioc, void *bfa,
879 		struct bfa_ioc_cbfn_s *cbfn, struct bfa_timer_mod_s *timer_mod);
880 void bfa_ioc_auto_recover(bfa_boolean_t auto_recover);
881 void bfa_ioc_detach(struct bfa_ioc_s *ioc);
882 void bfa_ioc_suspend(struct bfa_ioc_s *ioc);
883 void bfa_ioc_pci_init(struct bfa_ioc_s *ioc, struct bfa_pcidev_s *pcidev,
884 		enum bfi_pcifn_class clscode);
885 void bfa_ioc_mem_claim(struct bfa_ioc_s *ioc,  u8 *dm_kva, u64 dm_pa);
886 void bfa_ioc_enable(struct bfa_ioc_s *ioc);
887 void bfa_ioc_disable(struct bfa_ioc_s *ioc);
888 bfa_boolean_t bfa_ioc_intx_claim(struct bfa_ioc_s *ioc);
889 
890 bfa_status_t bfa_ioc_boot(struct bfa_ioc_s *ioc, u32 boot_type,
891 		u32 boot_env);
892 void bfa_ioc_isr(struct bfa_ioc_s *ioc, struct bfi_mbmsg_s *msg);
893 void bfa_ioc_error_isr(struct bfa_ioc_s *ioc);
894 bfa_boolean_t bfa_ioc_is_operational(struct bfa_ioc_s *ioc);
895 bfa_boolean_t bfa_ioc_is_initialized(struct bfa_ioc_s *ioc);
896 bfa_boolean_t bfa_ioc_is_disabled(struct bfa_ioc_s *ioc);
897 bfa_boolean_t bfa_ioc_is_acq_addr(struct bfa_ioc_s *ioc);
898 bfa_boolean_t bfa_ioc_fw_mismatch(struct bfa_ioc_s *ioc);
899 bfa_boolean_t bfa_ioc_adapter_is_disabled(struct bfa_ioc_s *ioc);
900 void bfa_ioc_reset_fwstate(struct bfa_ioc_s *ioc);
901 enum bfa_ioc_type_e bfa_ioc_get_type(struct bfa_ioc_s *ioc);
902 void bfa_ioc_get_adapter_serial_num(struct bfa_ioc_s *ioc, char *serial_num);
903 void bfa_ioc_get_adapter_fw_ver(struct bfa_ioc_s *ioc, char *fw_ver);
904 void bfa_ioc_get_adapter_optrom_ver(struct bfa_ioc_s *ioc, char *optrom_ver);
905 void bfa_ioc_get_adapter_model(struct bfa_ioc_s *ioc, char *model);
906 void bfa_ioc_get_adapter_manufacturer(struct bfa_ioc_s *ioc,
907 		char *manufacturer);
908 void bfa_ioc_get_pci_chip_rev(struct bfa_ioc_s *ioc, char *chip_rev);
909 enum bfa_ioc_state bfa_ioc_get_state(struct bfa_ioc_s *ioc);
910 
911 void bfa_ioc_get_attr(struct bfa_ioc_s *ioc, struct bfa_ioc_attr_s *ioc_attr);
912 void bfa_ioc_get_adapter_attr(struct bfa_ioc_s *ioc,
913 		struct bfa_adapter_attr_s *ad_attr);
914 void bfa_ioc_debug_memclaim(struct bfa_ioc_s *ioc, void *dbg_fwsave);
915 bfa_status_t bfa_ioc_debug_fwsave(struct bfa_ioc_s *ioc, void *trcdata,
916 		int *trclen);
917 bfa_status_t bfa_ioc_debug_fwtrc(struct bfa_ioc_s *ioc, void *trcdata,
918 				 int *trclen);
919 bfa_status_t bfa_ioc_debug_fwcore(struct bfa_ioc_s *ioc, void *buf,
920 	u32 *offset, int *buflen);
921 bfa_status_t bfa_ioc_fwsig_invalidate(struct bfa_ioc_s *ioc);
922 bfa_boolean_t bfa_ioc_sem_get(void __iomem *sem_reg);
923 void bfa_ioc_fwver_get(struct bfa_ioc_s *ioc,
924 			struct bfi_ioc_image_hdr_s *fwhdr);
925 bfa_boolean_t bfa_ioc_fwver_cmp(struct bfa_ioc_s *ioc,
926 			struct bfi_ioc_image_hdr_s *fwhdr);
927 void bfa_ioc_aen_post(struct bfa_ioc_s *ioc, enum bfa_ioc_aen_event event);
928 bfa_status_t bfa_ioc_fw_stats_get(struct bfa_ioc_s *ioc, void *stats);
929 bfa_status_t bfa_ioc_fw_stats_clear(struct bfa_ioc_s *ioc);
930 void bfa_ioc_debug_save_ftrc(struct bfa_ioc_s *ioc);
931 
932 /*
933  * asic block configuration related APIs
934  */
935 u32	bfa_ablk_meminfo(void);
936 void bfa_ablk_memclaim(struct bfa_ablk_s *ablk, u8 *dma_kva, u64 dma_pa);
937 void bfa_ablk_attach(struct bfa_ablk_s *ablk, struct bfa_ioc_s *ioc);
938 bfa_status_t bfa_ablk_query(struct bfa_ablk_s *ablk,
939 		struct bfa_ablk_cfg_s *ablk_cfg,
940 		bfa_ablk_cbfn_t cbfn, void *cbarg);
941 bfa_status_t bfa_ablk_adapter_config(struct bfa_ablk_s *ablk,
942 		enum bfa_mode_s mode, int max_pf, int max_vf,
943 		bfa_ablk_cbfn_t cbfn, void *cbarg);
944 bfa_status_t bfa_ablk_port_config(struct bfa_ablk_s *ablk, int port,
945 		enum bfa_mode_s mode, int max_pf, int max_vf,
946 		bfa_ablk_cbfn_t cbfn, void *cbarg);
947 bfa_status_t bfa_ablk_pf_create(struct bfa_ablk_s *ablk, u16 *pcifn,
948 		u8 port, enum bfi_pcifn_class personality,
949 		u16 bw_min, u16 bw_max, bfa_ablk_cbfn_t cbfn, void *cbarg);
950 bfa_status_t bfa_ablk_pf_delete(struct bfa_ablk_s *ablk, int pcifn,
951 		bfa_ablk_cbfn_t cbfn, void *cbarg);
952 bfa_status_t bfa_ablk_pf_update(struct bfa_ablk_s *ablk, int pcifn,
953 		u16 bw_min, u16 bw_max, bfa_ablk_cbfn_t cbfn, void *cbarg);
954 bfa_status_t bfa_ablk_optrom_en(struct bfa_ablk_s *ablk,
955 		bfa_ablk_cbfn_t cbfn, void *cbarg);
956 bfa_status_t bfa_ablk_optrom_dis(struct bfa_ablk_s *ablk,
957 		bfa_ablk_cbfn_t cbfn, void *cbarg);
958 
959 bfa_status_t bfa_ioc_flash_img_get_chnk(struct bfa_ioc_s *ioc, u32 off,
960 				u32 *fwimg);
961 /*
962  * bfa mfg wwn API functions
963  */
964 mac_t bfa_ioc_get_mac(struct bfa_ioc_s *ioc);
965 mac_t bfa_ioc_get_mfg_mac(struct bfa_ioc_s *ioc);
966 
967 /*
968  * F/W Image Size & Chunk
969  */
970 extern u32 bfi_image_cb_size;
971 extern u32 bfi_image_ct_size;
972 extern u32 bfi_image_ct2_size;
973 extern u32 *bfi_image_cb;
974 extern u32 *bfi_image_ct;
975 extern u32 *bfi_image_ct2;
976 
977 static inline u32 *
978 bfi_image_cb_get_chunk(u32 off)
979 {
980 	return (u32 *)(bfi_image_cb + off);
981 }
982 
983 static inline u32 *
984 bfi_image_ct_get_chunk(u32 off)
985 {
986 	return (u32 *)(bfi_image_ct + off);
987 }
988 
989 static inline u32 *
990 bfi_image_ct2_get_chunk(u32 off)
991 {
992 	return (u32 *)(bfi_image_ct2 + off);
993 }
994 
995 static inline u32*
996 bfa_cb_image_get_chunk(enum bfi_asic_gen asic_gen, u32 off)
997 {
998 	switch (asic_gen) {
999 	case BFI_ASIC_GEN_CB:
1000 		return bfi_image_cb_get_chunk(off);
1001 		break;
1002 	case BFI_ASIC_GEN_CT:
1003 		return bfi_image_ct_get_chunk(off);
1004 		break;
1005 	case BFI_ASIC_GEN_CT2:
1006 		return bfi_image_ct2_get_chunk(off);
1007 		break;
1008 	default:
1009 		return NULL;
1010 	}
1011 }
1012 
1013 static inline u32
1014 bfa_cb_image_get_size(enum bfi_asic_gen asic_gen)
1015 {
1016 	switch (asic_gen) {
1017 	case BFI_ASIC_GEN_CB:
1018 		return bfi_image_cb_size;
1019 		break;
1020 	case BFI_ASIC_GEN_CT:
1021 		return bfi_image_ct_size;
1022 		break;
1023 	case BFI_ASIC_GEN_CT2:
1024 		return bfi_image_ct2_size;
1025 		break;
1026 	default:
1027 		return 0;
1028 	}
1029 }
1030 
1031 /*
1032  * CNA TRCMOD declaration
1033  */
1034 /*
1035  * !!! Only append to the enums defined here to avoid any versioning
1036  * !!! needed between trace utility and driver version
1037  */
1038 enum {
1039 	BFA_TRC_CNA_PORT	= 1,
1040 	BFA_TRC_CNA_IOC		= 2,
1041 	BFA_TRC_CNA_IOC_CB	= 3,
1042 	BFA_TRC_CNA_IOC_CT	= 4,
1043 };
1044 
1045 #endif /* __BFA_IOC_H__ */
1046