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