[deliverable/linux.git] / drivers / scsi / bfa / bfad_im.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.
 */

#ifndef __BFAD_IM_H__
#define __BFAD_IM_H__

#include "bfa_fcs.h"

#define FCPI_NAME " fcpim"

#ifndef KOBJ_NAME_LEN
#define KOBJ_NAME_LEN           20
#endif

bfa_status_t bfad_im_module_init(void);
void bfad_im_module_exit(void);
bfa_status_t bfad_im_probe(struct bfad_s *bfad);
void bfad_im_probe_undo(struct bfad_s *bfad);
bfa_status_t bfad_im_port_new(struct bfad_s *bfad, struct bfad_port_s *port);
void bfad_im_port_delete(struct bfad_s *bfad, struct bfad_port_s *port);
void bfad_im_port_clean(struct bfad_im_port_s *im_port);
int  bfad_im_scsi_host_alloc(struct bfad_s *bfad,
		struct bfad_im_port_s *im_port, struct device *dev);
void bfad_im_scsi_host_free(struct bfad_s *bfad,
				struct bfad_im_port_s *im_port);
u32 bfad_im_supported_speeds(struct bfa_s *bfa);

#define MAX_FCP_TARGET 1024
#define MAX_FCP_LUN 16384
#define BFAD_TARGET_RESET_TMO 60
#define BFAD_LUN_RESET_TMO 60
#define ScsiResult(host_code, scsi_code) (((host_code) << 16) | scsi_code)
#define BFA_QUEUE_FULL_RAMP_UP_TIME 120

/*
 * itnim flags
 */
#define IO_DONE_BIT			0

struct bfad_itnim_data_s {
	struct bfad_itnim_s *itnim;
};

struct bfad_im_port_s {
	struct bfad_s         *bfad;
	struct bfad_port_s    *port;
	struct work_struct port_delete_work;
	int             idr_id;
	u16        cur_scsi_id;
	u16	flags;
	struct list_head binding_list;
	struct Scsi_Host *shost;
	struct list_head itnim_mapped_list;
	struct fc_vport *fc_vport;
};

enum bfad_itnim_state {
	ITNIM_STATE_NONE,
	ITNIM_STATE_ONLINE,
	ITNIM_STATE_OFFLINE_PENDING,
	ITNIM_STATE_OFFLINE,
	ITNIM_STATE_TIMEOUT,
	ITNIM_STATE_FREE,
};

/*
 * Per itnim data structure
 */
struct bfad_itnim_s {
	struct list_head list_entry;
	struct bfa_fcs_itnim_s fcs_itnim;
	struct work_struct itnim_work;
	u32        flags;
	enum bfad_itnim_state state;
	struct bfad_im_s *im;
	struct bfad_im_port_s *im_port;
	struct bfad_rport_s *drv_rport;
	struct fc_rport *fc_rport;
	struct bfa_itnim_s *bfa_itnim;
	u16        scsi_tgt_id;
	u16	   channel;
	u16        queue_work;
	unsigned long	last_ramp_up_time;
	unsigned long	last_queue_full_time;
};

enum bfad_binding_type {
	FCP_PWWN_BINDING = 0x1,
	FCP_NWWN_BINDING = 0x2,
	FCP_FCID_BINDING = 0x3,
};

struct bfad_fcp_binding {
	struct list_head list_entry;
	enum bfad_binding_type binding_type;
	u16        scsi_target_id;
	u32        fc_id;
	wwn_t           nwwn;
	wwn_t           pwwn;
};

struct bfad_im_s {
	struct bfad_s         *bfad;
	struct workqueue_struct *drv_workq;
	char            drv_workq_name[KOBJ_NAME_LEN];
	struct work_struct	aen_im_notify_work;
};

#define bfad_get_aen_entry(_drv, _entry) do {				\
	unsigned long	_flags;						\
	spin_lock_irqsave(&(_drv)->bfad_aen_spinlock, _flags);		\
	bfa_q_deq(&(_drv)->free_aen_q, &(_entry));			\
	if (_entry)							\
		list_add_tail(&(_entry)->qe, &(_drv)->active_aen_q);	\
	spin_unlock_irqrestore(&(_drv)->bfad_aen_spinlock, _flags);	\
} while (0)

/* post fc_host vendor event */
#define bfad_im_post_vendor_event(_entry, _drv, _cnt, _cat, _evt) do {	      \
	do_gettimeofday(&(_entry)->aen_tv);				      \
	(_entry)->bfad_num = (_drv)->inst_no;				      \
	(_entry)->seq_num = (_cnt);					      \
	(_entry)->aen_category = (_cat);				      \
	(_entry)->aen_type = (_evt);					      \
	if ((_drv)->bfad_flags & BFAD_FC4_PROBE_DONE)			      \
		queue_work((_drv)->im->drv_workq,			      \
			   &(_drv)->im->aen_im_notify_work);		      \
} while (0)

struct Scsi_Host *bfad_scsi_host_alloc(struct bfad_im_port_s *im_port,
				struct bfad_s *);
bfa_status_t bfad_thread_workq(struct bfad_s *bfad);
void bfad_destroy_workq(struct bfad_im_s *im);
void bfad_fc_host_init(struct bfad_im_port_s *im_port);
void bfad_scsi_host_free(struct bfad_s *bfad,
				 struct bfad_im_port_s *im_port);
void bfad_ramp_up_qdepth(struct bfad_itnim_s *itnim,
				 struct scsi_device *sdev);
void bfad_handle_qfull(struct bfad_itnim_s *itnim, struct scsi_device *sdev);
struct bfad_itnim_s *bfad_get_itnim(struct bfad_im_port_s *im_port, int id);

extern struct scsi_host_template bfad_im_scsi_host_template;
extern struct scsi_host_template bfad_im_vport_template;
extern struct fc_function_template bfad_im_fc_function_template;
extern struct fc_function_template bfad_im_vport_fc_function_template;
extern struct scsi_transport_template *bfad_im_scsi_transport_template;
extern struct scsi_transport_template *bfad_im_scsi_vport_transport_template;

extern struct device_attribute *bfad_im_host_attrs[];
extern struct device_attribute *bfad_im_vport_attrs[];

irqreturn_t bfad_intx(int irq, void *dev_id);

int bfad_im_bsg_request(struct fc_bsg_job *job);
int bfad_im_bsg_timeout(struct fc_bsg_job *job);

/*
 * Macro to set the SCSI device sdev_bflags - sdev_bflags are used by the
 * SCSI mid-layer to choose LUN Scanning mode REPORT_LUNS vs. Sequential Scan
 *
 * Internally iterate's over all the ITNIM's part of the im_port & set's the
 * sdev_bflags for the scsi_device associated with LUN #0.
 */
#define bfad_reset_sdev_bflags(__im_port, __lunmask_cfg) do {		\
	struct scsi_device *__sdev = NULL;				\
	struct bfad_itnim_s *__itnim = NULL;				\
	u32 scan_flags = BLIST_NOREPORTLUN | BLIST_SPARSELUN;		\
	list_for_each_entry(__itnim, &((__im_port)->itnim_mapped_list),	\
			    list_entry) {				\
		__sdev = scsi_device_lookup((__im_port)->shost,		\
					    __itnim->channel,		\
					    __itnim->scsi_tgt_id, 0);	\
		if (__sdev) {						\
			if ((__lunmask_cfg) == BFA_TRUE)		\
				__sdev->sdev_bflags |= scan_flags;	\
			else						\
				__sdev->sdev_bflags &= ~scan_flags;	\
			scsi_device_put(__sdev);			\
		}							\
	}								\
} while (0)

#endif
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
	18	#ifndef __BFAD_IM_H__
	19	#define __BFAD_IM_H__
	20
a36c61f9	21	#include "bfa_fcs.h"
7725ccfd JH	22
	23	#define FCPI_NAME " fcpim"
	24
a36c61f9 KG	25	#ifndef KOBJ_NAME_LEN
	26	#define KOBJ_NAME_LEN 20
	27	#endif
	28
7725ccfd JH	29	bfa_status_t bfad_im_module_init(void);
	30	void bfad_im_module_exit(void);
	31	bfa_status_t bfad_im_probe(struct bfad_s *bfad);
	32	void bfad_im_probe_undo(struct bfad_s *bfad);
7725ccfd JH	33	bfa_status_t bfad_im_port_new(struct bfad_s bfad, struct bfad_port_s port);
7725ccfd JH	34	void bfad_im_port_delete(struct bfad_s bfad, struct bfad_port_s port);
7725ccfd JH	35	void bfad_im_port_clean(struct bfad_im_port_s *im_port);
7725ccfd JH	36	int bfad_im_scsi_host_alloc(struct bfad_s *bfad,
b504293f	37	struct bfad_im_port_s im_port, struct device dev);
7725ccfd JH	38	void bfad_im_scsi_host_free(struct bfad_s *bfad,
7725ccfd JH	39	struct bfad_im_port_s *im_port);
6192bd7c	40	u32 bfad_im_supported_speeds(struct bfa_s *bfa);
7725ccfd JH	41
	42	#define MAX_FCP_TARGET 1024
	43	#define MAX_FCP_LUN 16384
	44	#define BFAD_TARGET_RESET_TMO 60
	45	#define BFAD_LUN_RESET_TMO 60
	46	#define ScsiResult(host_code, scsi_code) (((host_code) << 16) \| scsi_code)
	47	#define BFA_QUEUE_FULL_RAMP_UP_TIME 120
7725ccfd JH	48
	49	/*
	50	* itnim flags
	51	*/
7725ccfd JH	52	#define IO_DONE_BIT 0
	53
	54	struct bfad_itnim_data_s {
	55	struct bfad_itnim_s *itnim;
	56	};
	57
	58	struct bfad_im_port_s {
	59	struct bfad_s *bfad;
	60	struct bfad_port_s *port;
	61	struct work_struct port_delete_work;
	62	int idr_id;
	63	u16 cur_scsi_id;
a36c61f9	64	u16 flags;
7725ccfd JH	65	struct list_head binding_list;
	66	struct Scsi_Host *shost;
	67	struct list_head itnim_mapped_list;
b504293f	68	struct fc_vport *fc_vport;
7725ccfd JH	69	};
	70
	71	enum bfad_itnim_state {
	72	ITNIM_STATE_NONE,
	73	ITNIM_STATE_ONLINE,
	74	ITNIM_STATE_OFFLINE_PENDING,
	75	ITNIM_STATE_OFFLINE,
	76	ITNIM_STATE_TIMEOUT,
	77	ITNIM_STATE_FREE,
	78	};
	79
	80	/*
	81	* Per itnim data structure
	82	*/
	83	struct bfad_itnim_s {
	84	struct list_head list_entry;
	85	struct bfa_fcs_itnim_s fcs_itnim;
	86	struct work_struct itnim_work;
	87	u32 flags;
	88	enum bfad_itnim_state state;
	89	struct bfad_im_s *im;
	90	struct bfad_im_port_s *im_port;
	91	struct bfad_rport_s *drv_rport;
	92	struct fc_rport *fc_rport;
	93	struct bfa_itnim_s *bfa_itnim;
	94	u16 scsi_tgt_id;
5b7db7af	95	u16 channel;
7725ccfd JH	96	u16 queue_work;
	97	unsigned long last_ramp_up_time;
	98	unsigned long last_queue_full_time;
	99	};
	100
	101	enum bfad_binding_type {
	102	FCP_PWWN_BINDING = 0x1,
	103	FCP_NWWN_BINDING = 0x2,
	104	FCP_FCID_BINDING = 0x3,
	105	};
	106
	107	struct bfad_fcp_binding {
	108	struct list_head list_entry;
	109	enum bfad_binding_type binding_type;
	110	u16 scsi_target_id;
	111	u32 fc_id;
	112	wwn_t nwwn;
	113	wwn_t pwwn;
	114	};
	115
	116	struct bfad_im_s {
	117	struct bfad_s *bfad;
	118	struct workqueue_struct *drv_workq;
a36c61f9	119	char drv_workq_name[KOBJ_NAME_LEN];
7826f304	120	struct work_struct aen_im_notify_work;
7725ccfd JH	121	};
7725ccfd JH	122
7826f304 KG	123	#define bfad_get_aen_entry(_drv, _entry) do { \
	124	unsigned long _flags; \
	125	spin_lock_irqsave(&(_drv)->bfad_aen_spinlock, _flags); \
	126	bfa_q_deq(&(_drv)->free_aen_q, &(_entry)); \
	127	if (_entry) \
	128	list_add_tail(&(_entry)->qe, &(_drv)->active_aen_q); \
	129	spin_unlock_irqrestore(&(_drv)->bfad_aen_spinlock, _flags); \
	130	} while (0)
	131
	132	/* post fc_host vendor event */
	133	#define bfad_im_post_vendor_event(_entry, _drv, _cnt, _cat, _evt) do { \
	134	do_gettimeofday(&(_entry)->aen_tv); \
	135	(_entry)->bfad_num = (_drv)->inst_no; \
	136	(_entry)->seq_num = (_cnt); \
	137	(_entry)->aen_category = (_cat); \
	138	(_entry)->aen_type = (_evt); \
	139	if ((_drv)->bfad_flags & BFAD_FC4_PROBE_DONE) \
	140	queue_work((_drv)->im->drv_workq, \
	141	&(_drv)->im->aen_im_notify_work); \
	142	} while (0)
	143
f16a1750	144	struct Scsi_Host bfad_scsi_host_alloc(struct bfad_im_port_s im_port,
7725ccfd	145	struct bfad_s *);
f16a1750 MZ	146	bfa_status_t bfad_thread_workq(struct bfad_s *bfad);
	147	void bfad_destroy_workq(struct bfad_im_s *im);
	148	void bfad_fc_host_init(struct bfad_im_port_s *im_port);
	149	void bfad_scsi_host_free(struct bfad_s *bfad,
7725ccfd	150	struct bfad_im_port_s *im_port);
f16a1750	151	void bfad_ramp_up_qdepth(struct bfad_itnim_s *itnim,
7725ccfd	152	struct scsi_device *sdev);
f16a1750 MZ	153	void bfad_handle_qfull(struct bfad_itnim_s itnim, struct scsi_device sdev);
f16a1750 MZ	154	struct bfad_itnim_s bfad_get_itnim(struct bfad_im_port_s im_port, int id);
7725ccfd JH	155
	156	extern struct scsi_host_template bfad_im_scsi_host_template;
	157	extern struct scsi_host_template bfad_im_vport_template;
	158	extern struct fc_function_template bfad_im_fc_function_template;
b504293f	159	extern struct fc_function_template bfad_im_vport_fc_function_template;
7725ccfd	160	extern struct scsi_transport_template *bfad_im_scsi_transport_template;
b504293f	161	extern struct scsi_transport_template *bfad_im_scsi_vport_transport_template;
7725ccfd	162
a36c61f9 KG	163	extern struct device_attribute *bfad_im_host_attrs[];
	164	extern struct device_attribute *bfad_im_vport_attrs[];
	165
	166	irqreturn_t bfad_intx(int irq, void *dev_id);
	167
b85daafe KG	168	int bfad_im_bsg_request(struct fc_bsg_job *job);
	169	int bfad_im_bsg_timeout(struct fc_bsg_job *job);
	170
5b7db7af KG	171	/*
	172	* Macro to set the SCSI device sdev_bflags - sdev_bflags are used by the
	173	* SCSI mid-layer to choose LUN Scanning mode REPORT_LUNS vs. Sequential Scan
	174	*
	175	* Internally iterate's over all the ITNIM's part of the im_port & set's the
	176	* sdev_bflags for the scsi_device associated with LUN #0.
	177	*/
	178	#define bfad_reset_sdev_bflags(__im_port, __lunmask_cfg) do { \
	179	struct scsi_device *__sdev = NULL; \
	180	struct bfad_itnim_s *__itnim = NULL; \
	181	u32 scan_flags = BLIST_NOREPORTLUN \| BLIST_SPARSELUN; \
	182	list_for_each_entry(__itnim, &((__im_port)->itnim_mapped_list), \
	183	list_entry) { \
	184	__sdev = scsi_device_lookup((__im_port)->shost, \
	185	__itnim->channel, \
	186	__itnim->scsi_tgt_id, 0); \
	187	if (__sdev) { \
	188	if ((__lunmask_cfg) == BFA_TRUE) \
	189	__sdev->sdev_bflags \|= scan_flags; \
	190	else \
	191	__sdev->sdev_bflags &= ~scan_flags; \
	192	scsi_device_put(__sdev); \
	193	} \
	194	} \
	195	} while (0)
	196
7725ccfd	197	#endif