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