[deliverable/linux.git] / drivers / scsi / bfa / bfa_modules.h

/*
 * Copyright (c) 2005-2010 Brocade Communications Systems, Inc.
 * All rights reserved
 * www.brocade.com
 *
 * Linux driver for Brocade Fibre Channel Host Bus Adapter.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License (GPL) Version 2 as
 * published by the Free Software Foundation
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 */

/*
 *  bfa_modules.h BFA modules
 */

#ifndef __BFA_MODULES_H__
#define __BFA_MODULES_H__

#include "bfa_cs.h"
#include "bfa.h"
#include "bfa_svc.h"
#include "bfa_fcpim.h"
#include "bfa_port.h"

struct bfa_modules_s {
	struct bfa_fcdiag_s	fcdiag;		/* fcdiag module */
	struct bfa_fcport_s	fcport;		/*  fc port module	      */
	struct bfa_fcxp_mod_s	fcxp_mod;	/*  fcxp module	      */
	struct bfa_lps_mod_s	lps_mod;	/*  fcxp module	      */
	struct bfa_uf_mod_s	uf_mod;		/*  unsolicited frame module */
	struct bfa_rport_mod_s	rport_mod;	/*  remote port module	      */
	struct bfa_fcp_mod_s	fcp_mod;	/*  FCP initiator module     */
	struct bfa_sgpg_mod_s	sgpg_mod;	/*  SG page module	      */
	struct bfa_port_s	port;		/*  Physical port module     */
	struct bfa_ablk_s	ablk;		/*  ASIC block config module */
	struct bfa_cee_s	cee;		/*  CEE Module	*/
	struct bfa_sfp_s	sfp;		/*  SFP module	*/
	struct bfa_flash_s	flash;		/*  flash module */
	struct bfa_diag_s	diag_mod;	/*  diagnostics module	*/
	struct bfa_phy_s	phy;		/*  phy module		*/
	struct bfa_dconf_mod_s	dconf_mod;	/*  DCONF common module	*/
	struct bfa_fru_s	fru;		/*  fru module		*/
};

/*
 * !!! Only append to the enums defined here to avoid any versioning
 * !!! needed between trace utility and driver version
 */
enum {
	BFA_TRC_HAL_CORE	= 1,
	BFA_TRC_HAL_FCXP	= 2,
	BFA_TRC_HAL_FCPIM	= 3,
	BFA_TRC_HAL_IOCFC_CT	= 4,
	BFA_TRC_HAL_IOCFC_CB	= 5,
};

/*
 * Macro to define a new BFA module
 */
#define BFA_MODULE(__mod)						\
	static void bfa_ ## __mod ## _meminfo(				\
			struct bfa_iocfc_cfg_s *cfg,			\
			struct bfa_meminfo_s *meminfo,			\
			struct bfa_s *bfa);				\
	static void bfa_ ## __mod ## _attach(struct bfa_s *bfa,		\
			void *bfad, struct bfa_iocfc_cfg_s *cfg,	\
			struct bfa_pcidev_s *pcidev);      \
	static void bfa_ ## __mod ## _detach(struct bfa_s *bfa);      \
	static void bfa_ ## __mod ## _start(struct bfa_s *bfa);      \
	static void bfa_ ## __mod ## _stop(struct bfa_s *bfa);      \
	static void bfa_ ## __mod ## _iocdisable(struct bfa_s *bfa);      \
									\
	extern struct bfa_module_s hal_mod_ ## __mod;			\
	struct bfa_module_s hal_mod_ ## __mod = {			\
		bfa_ ## __mod ## _meminfo,				\
		bfa_ ## __mod ## _attach,				\
		bfa_ ## __mod ## _detach,				\
		bfa_ ## __mod ## _start,				\
		bfa_ ## __mod ## _stop,					\
		bfa_ ## __mod ## _iocdisable,				\
	}

#define BFA_CACHELINE_SZ	(256)

/*
 * Structure used to interact between different BFA sub modules
 *
 * Each sub module needs to implement only the entry points relevant to it (and
 * can leave entry points as NULL)
 */
struct bfa_module_s {
	void (*meminfo) (struct bfa_iocfc_cfg_s *cfg,
			 struct bfa_meminfo_s *meminfo,
			 struct bfa_s *bfa);
	void (*attach) (struct bfa_s *bfa, void *bfad,
			struct bfa_iocfc_cfg_s *cfg,
			struct bfa_pcidev_s *pcidev);
	void (*detach) (struct bfa_s *bfa);
	void (*start) (struct bfa_s *bfa);
	void (*stop) (struct bfa_s *bfa);
	void (*iocdisable) (struct bfa_s *bfa);
};


struct bfa_s {
	void			*bfad;		/*  BFA driver instance    */
	struct bfa_plog_s	*plog;		/*  portlog buffer	    */
	struct bfa_trc_mod_s	*trcmod;	/*  driver tracing	    */
	struct bfa_ioc_s	ioc;		/*  IOC module		    */
	struct bfa_iocfc_s	iocfc;		/*  IOCFC module	    */
	struct bfa_timer_mod_s	timer_mod;	/*  timer module	    */
	struct bfa_modules_s	modules;	/*  BFA modules	    */
	struct list_head	comp_q;		/*  pending completions     */
	bfa_boolean_t		queue_process;	/*  queue processing enabled */
	struct list_head	reqq_waitq[BFI_IOC_MAX_CQS];
	bfa_boolean_t		fcs;		/*  FCS is attached to BFA */
	struct bfa_msix_s	msix;
	int			bfa_aen_seq;
	bfa_boolean_t		intr_enabled;	/*  Status of interrupts */
};

extern bfa_boolean_t bfa_auto_recover;
extern struct bfa_module_s hal_mod_fcdiag;
extern struct bfa_module_s hal_mod_sgpg;
extern struct bfa_module_s hal_mod_fcport;
extern struct bfa_module_s hal_mod_fcxp;
extern struct bfa_module_s hal_mod_lps;
extern struct bfa_module_s hal_mod_uf;
extern struct bfa_module_s hal_mod_rport;
extern struct bfa_module_s hal_mod_fcp;
extern struct bfa_module_s hal_mod_dconf;

#endif /* __BFA_MODULES_H__ */
Commit	Line	Data
7725ccfd	1	/*
a36c61f9	2	* Copyright (c) 2005-2010 Brocade Communications Systems, Inc.
7725ccfd JH	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
acdc79a6	18	/*
a36c61f9 KG	19	* bfa_modules.h BFA modules
	20	*/
	21
	22	#ifndef __BFA_MODULES_H__
	23	#define __BFA_MODULES_H__
	24
	25	#include "bfa_cs.h"
	26	#include "bfa.h"
	27	#include "bfa_svc.h"
	28	#include "bfa_fcpim.h"
	29	#include "bfa_port.h"
	30
	31	struct bfa_modules_s {
3d7fc66d	32	struct bfa_fcdiag_s fcdiag; /* fcdiag module */
a36c61f9 KG	33	struct bfa_fcport_s fcport; /* fc port module */
	34	struct bfa_fcxp_mod_s fcxp_mod; /* fcxp module */
	35	struct bfa_lps_mod_s lps_mod; /* fcxp module */
	36	struct bfa_uf_mod_s uf_mod; /* unsolicited frame module */
	37	struct bfa_rport_mod_s rport_mod; /* remote port module */
e2187d7f	38	struct bfa_fcp_mod_s fcp_mod; /* FCP initiator module */
a36c61f9 KG	39	struct bfa_sgpg_mod_s sgpg_mod; /* SG page module */
a36c61f9 KG	40	struct bfa_port_s port; /* Physical port module */
1a4d8e1b	41	struct bfa_ablk_s ablk; /* ASIC block config module */
148d6103	42	struct bfa_cee_s cee; /* CEE Module */
51e569aa	43	struct bfa_sfp_s sfp; /* SFP module */
5a54b1d5	44	struct bfa_flash_s flash; /* flash module */
3d7fc66d	45	struct bfa_diag_s diag_mod; /* diagnostics module */
3350d98d	46	struct bfa_phy_s phy; /* phy module */
45c5dc1d	47	struct bfa_dconf_mod_s dconf_mod; /* DCONF common module */
e6826c96	48	struct bfa_fru_s fru; /* fru module */
a36c61f9 KG	49	};
	50
	51	/*
	52	* !!! Only append to the enums defined here to avoid any versioning
	53	* !!! needed between trace utility and driver version
	54	*/
	55	enum {
	56	BFA_TRC_HAL_CORE = 1,
	57	BFA_TRC_HAL_FCXP = 2,
	58	BFA_TRC_HAL_FCPIM = 3,
	59	BFA_TRC_HAL_IOCFC_CT = 4,
	60	BFA_TRC_HAL_IOCFC_CB = 5,
	61	};
7725ccfd	62
acdc79a6	63	/*
7725ccfd JH	64	* Macro to define a new BFA module
7725ccfd JH	65	*/
a36c61f9	66	#define BFA_MODULE(__mod) \
7725ccfd	67	static void bfa_ ## __mod ## _meminfo( \
4507025d KG	68	struct bfa_iocfc_cfg_s *cfg, \
	69	struct bfa_meminfo_s *meminfo, \
	70	struct bfa_s *bfa); \
7725ccfd	71	static void bfa_ ## __mod ## _attach(struct bfa_s *bfa, \
a36c61f9	72	void bfad, struct bfa_iocfc_cfg_s cfg, \
7725ccfd	73	struct bfa_pcidev_s *pcidev); \
7725ccfd JH	74	static void bfa_ ## __mod ## _detach(struct bfa_s *bfa); \
	75	static void bfa_ ## __mod ## _start(struct bfa_s *bfa); \
	76	static void bfa_ ## __mod ## _stop(struct bfa_s *bfa); \
	77	static void bfa_ ## __mod ## _iocdisable(struct bfa_s *bfa); \
	78	\
	79	extern struct bfa_module_s hal_mod_ ## __mod; \
	80	struct bfa_module_s hal_mod_ ## __mod = { \
	81	bfa_ ## __mod ## _meminfo, \
	82	bfa_ ## __mod ## _attach, \
7725ccfd JH	83	bfa_ ## __mod ## _detach, \
	84	bfa_ ## __mod ## _start, \
	85	bfa_ ## __mod ## _stop, \
	86	bfa_ ## __mod ## _iocdisable, \
	87	}
	88
	89	#define BFA_CACHELINE_SZ (256)
	90
acdc79a6	91	/*
7725ccfd JH	92	* Structure used to interact between different BFA sub modules
	93	*
	94	* Each sub module needs to implement only the entry points relevant to it (and
	95	* can leave entry points as NULL)
	96	*/
	97	struct bfa_module_s {
4507025d KG	98	void (meminfo) (struct bfa_iocfc_cfg_s cfg,
	99	struct bfa_meminfo_s *meminfo,
	100	struct bfa_s *bfa);
7725ccfd JH	101	void (attach) (struct bfa_s bfa, void *bfad,
7725ccfd JH	102	struct bfa_iocfc_cfg_s *cfg,
7725ccfd	103	struct bfa_pcidev_s *pcidev);
7725ccfd JH	104	void (detach) (struct bfa_s bfa);
	105	void (start) (struct bfa_s bfa);
	106	void (stop) (struct bfa_s bfa);
	107	void (iocdisable) (struct bfa_s bfa);
	108	};
	109
7725ccfd JH	110
	111	struct bfa_s {
	112	void bfad; / BFA driver instance */
7725ccfd	113	struct bfa_plog_s plog; / portlog buffer */
7725ccfd JH	114	struct bfa_trc_mod_s trcmod; / driver tracing */
	115	struct bfa_ioc_s ioc; /* IOC module */
	116	struct bfa_iocfc_s iocfc; /* IOCFC module */
	117	struct bfa_timer_mod_s timer_mod; /* timer module */
	118	struct bfa_modules_s modules; /* BFA modules */
a36c61f9	119	struct list_head comp_q; /* pending completions */
775c7742	120	bfa_boolean_t queue_process; /* queue processing enabled */
a36c61f9	121	struct list_head reqq_waitq[BFI_IOC_MAX_CQS];
7725ccfd JH	122	bfa_boolean_t fcs; /* FCS is attached to BFA */
7725ccfd JH	123	struct bfa_msix_s msix;
7826f304	124	int bfa_aen_seq;
9aec0249	125	bfa_boolean_t intr_enabled; /* Status of interrupts */
7725ccfd JH	126	};
7725ccfd JH	127
7725ccfd	128	extern bfa_boolean_t bfa_auto_recover;
3d7fc66d	129	extern struct bfa_module_s hal_mod_fcdiag;
7725ccfd	130	extern struct bfa_module_s hal_mod_sgpg;
1c8a4c37	131	extern struct bfa_module_s hal_mod_fcport;
7725ccfd JH	132	extern struct bfa_module_s hal_mod_fcxp;
	133	extern struct bfa_module_s hal_mod_lps;
	134	extern struct bfa_module_s hal_mod_uf;
	135	extern struct bfa_module_s hal_mod_rport;
e2187d7f	136	extern struct bfa_module_s hal_mod_fcp;
45c5dc1d	137	extern struct bfa_module_s hal_mod_dconf;
7725ccfd	138
a36c61f9	139	#endif /* __BFA_MODULES_H__ */