[linux-2.6-block.git] / include / scsi / scsi_transport_fc.h

/* 
 *  FiberChannel transport specific attributes exported to sysfs.
 *
 *  Copyright (c) 2003 Silicon Graphics, Inc.  All rights reserved.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  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.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *  ========
 *
 *  Copyright (C) 2004-2005   James Smart, Emulex Corporation
 *    Rewrite for host, target, device, and remote port attributes,
 *    statistics, and service functions...
 *
 */
#ifndef SCSI_TRANSPORT_FC_H
#define SCSI_TRANSPORT_FC_H

#include <linux/sched.h>
#include <scsi/scsi.h>
#include <scsi/scsi_netlink.h>

struct scsi_transport_template;


/*
 * FC Port definitions - Following FC HBAAPI guidelines
 *
 * Note: Not all binary values for the different fields match HBAAPI.
 *  Instead, we use densely packed ordinal values or enums.
 *  We get away with this as we never present the actual binary values
 *  externally. For sysfs, we always present the string that describes
 *  the value. Thus, an admin doesn't need a magic HBAAPI decoder ring
 *  to understand the values. The HBAAPI user-space library is free to
 *  convert the strings into the HBAAPI-specified binary values.
 *
 * Note: Not all HBAAPI-defined values are contained in the definitions
 *  below. Those not appropriate to an fc_host (e.g. FCP initiator) have
 *  been removed.
 */

/*
 * fc_port_type: If you alter this, you also need to alter scsi_transport_fc.c
 * (for the ascii descriptions).
 */
enum fc_port_type {
	FC_PORTTYPE_UNKNOWN,
	FC_PORTTYPE_OTHER,
	FC_PORTTYPE_NOTPRESENT,
	FC_PORTTYPE_NPORT,		/* Attached to FPort */
	FC_PORTTYPE_NLPORT,		/* (Public) Loop w/ FLPort */
	FC_PORTTYPE_LPORT,		/* (Private) Loop w/o FLPort */
	FC_PORTTYPE_PTP,		/* Point to Point w/ another NPort */
};

/*
 * fc_port_state: If you alter this, you also need to alter scsi_transport_fc.c
 * (for the ascii descriptions).
 */
enum fc_port_state {
	FC_PORTSTATE_UNKNOWN,
	FC_PORTSTATE_NOTPRESENT,
	FC_PORTSTATE_ONLINE,
	FC_PORTSTATE_OFFLINE,		/* User has taken Port Offline */
	FC_PORTSTATE_BLOCKED,
	FC_PORTSTATE_BYPASSED,
	FC_PORTSTATE_DIAGNOSTICS,
	FC_PORTSTATE_LINKDOWN,
	FC_PORTSTATE_ERROR,
	FC_PORTSTATE_LOOPBACK,
	FC_PORTSTATE_DELETED,
};


/* 
 * FC Classes of Service
 * Note: values are not enumerated, as they can be "or'd" together
 * for reporting (e.g. report supported_classes). If you alter this list,
 * you also need to alter scsi_transport_fc.c (for the ascii descriptions).
 */
#define FC_COS_UNSPECIFIED		0
#define FC_COS_CLASS1			2
#define FC_COS_CLASS2			4
#define FC_COS_CLASS3			8
#define FC_COS_CLASS4			0x10
#define FC_COS_CLASS6			0x40

/* 
 * FC Port Speeds
 * Note: values are not enumerated, as they can be "or'd" together
 * for reporting (e.g. report supported_speeds). If you alter this list,
 * you also need to alter scsi_transport_fc.c (for the ascii descriptions).
 */
#define FC_PORTSPEED_UNKNOWN		0 /* Unknown - transceiver
					     incapable of reporting */
#define FC_PORTSPEED_1GBIT		1
#define FC_PORTSPEED_2GBIT		2
#define FC_PORTSPEED_4GBIT		4
#define FC_PORTSPEED_10GBIT		8
#define FC_PORTSPEED_NOT_NEGOTIATED	(1 << 15) /* Speed not established */

/*
 * fc_tgtid_binding_type: If you alter this, you also need to alter
 * scsi_transport_fc.c (for the ascii descriptions).
 */
enum fc_tgtid_binding_type  {
	FC_TGTID_BIND_NONE,
	FC_TGTID_BIND_BY_WWPN,
	FC_TGTID_BIND_BY_WWNN,
	FC_TGTID_BIND_BY_ID,
};

/*
 * FC Remote Port Roles
 * Note: values are not enumerated, as they can be "or'd" together
 * for reporting (e.g. report roles). If you alter this list,
 * you also need to alter scsi_transport_fc.c (for the ascii descriptions).
 */
#define FC_RPORT_ROLE_UNKNOWN			0x00
#define FC_RPORT_ROLE_FCP_TARGET		0x01
#define FC_RPORT_ROLE_FCP_INITIATOR		0x02
#define FC_RPORT_ROLE_IP_PORT			0x04


/*
 * fc_rport_identifiers: This set of data contains all elements
 * to uniquely identify a remote FC port. The driver uses this data
 * to report the existence of a remote FC port in the topology. Internally,
 * the transport uses this data for attributes and to manage consistent
 * target id bindings.
 */
struct fc_rport_identifiers {
	u64 node_name;
	u64 port_name;
	u32 port_id;
	u32 roles;
};

/* Macro for use in defining Remote Port attributes */
#define FC_RPORT_ATTR(_name,_mode,_show,_store)				\
struct class_device_attribute class_device_attr_rport_##_name = 	\
	__ATTR(_name,_mode,_show,_store)


/*
 * FC Remote Port Attributes
 *
 * This structure exists for each remote FC port that a LLDD notifies
 * the subsystem of.  A remote FC port may or may not be a SCSI Target,
 * also be a SCSI initiator, IP endpoint, etc. As such, the remote
 * port is considered a separate entity, independent of "role" (such
 * as scsi target).
 *
 * --
 *
 * Attributes are based on HBAAPI V2.0 definitions. Only those
 * attributes that are determinable by the local port (aka Host)
 * are contained.
 *
 * Fixed attributes are not expected to change. The driver is
 * expected to set these values after successfully calling
 * fc_remote_port_add(). The transport fully manages all get functions
 * w/o driver interaction.
 *
 * Dynamic attributes are expected to change. The driver participates
 * in all get/set operations via functions provided by the driver.
 *
 * Private attributes are transport-managed values. They are fully
 * managed by the transport w/o driver interaction.
 */

struct fc_rport {	/* aka fc_starget_attrs */
	/* Fixed Attributes */
	u32 maxframe_size;
	u32 supported_classes;

	/* Dynamic Attributes */
	u32 dev_loss_tmo;	/* Remote Port loss timeout in seconds. */

	/* Private (Transport-managed) Attributes */
	u64 node_name;
	u64 port_name;
	u32 port_id;
	u32 roles;
	enum fc_port_state port_state;	/* Will only be ONLINE or UNKNOWN */
	u32 scsi_target_id;
	u32 fast_io_fail_tmo;

	/* exported data */
	void *dd_data;			/* Used for driver-specific storage */

	/* internal data */
	unsigned int channel;
	u32 number;
	u8 flags;
	struct list_head peers;
	struct device dev;
 	struct delayed_work dev_loss_work;
 	struct work_struct scan_work;
 	struct delayed_work fail_io_work;
 	struct work_struct stgt_delete_work;
	struct work_struct rport_delete_work;
} __attribute__((aligned(sizeof(unsigned long))));

/* bit field values for struct fc_rport "flags" field: */
#define FC_RPORT_DEVLOSS_PENDING	0x01
#define FC_RPORT_SCAN_PENDING		0x02

#define	dev_to_rport(d)				\
	container_of(d, struct fc_rport, dev)
#define transport_class_to_rport(classdev)	\
	dev_to_rport(classdev->dev)
#define rport_to_shost(r)			\
	dev_to_shost(r->dev.parent)

/*
 * FC SCSI Target Attributes
 *
 * The SCSI Target is considered an extention of a remote port (as
 * a remote port can be more than a SCSI Target). Within the scsi
 * subsystem, we leave the Target as a separate entity. Doing so
 * provides backward compatibility with prior FC transport api's,
 * and lets remote ports be handled entirely within the FC transport
 * and independently from the scsi subsystem. The drawback is that
 * some data will be duplicated.
 */

struct fc_starget_attrs {	/* aka fc_target_attrs */
	/* Dynamic Attributes */
	u64 node_name;
	u64 port_name;
	u32 port_id;
};

#define fc_starget_node_name(x) \
	(((struct fc_starget_attrs *)&(x)->starget_data)->node_name)
#define fc_starget_port_name(x)	\
	(((struct fc_starget_attrs *)&(x)->starget_data)->port_name)
#define fc_starget_port_id(x) \
	(((struct fc_starget_attrs *)&(x)->starget_data)->port_id)

#define starget_to_rport(s)			\
	scsi_is_fc_rport(s->dev.parent) ? dev_to_rport(s->dev.parent) : NULL


/*
 * FC Local Port (Host) Statistics
 */

/* FC Statistics - Following FC HBAAPI v2.0 guidelines */
struct fc_host_statistics {
	/* port statistics */
	u64 seconds_since_last_reset;
	u64 tx_frames;
	u64 tx_words;
	u64 rx_frames;
	u64 rx_words;
	u64 lip_count;
	u64 nos_count;
	u64 error_frames;
	u64 dumped_frames;
	u64 link_failure_count;
	u64 loss_of_sync_count;
	u64 loss_of_signal_count;
	u64 prim_seq_protocol_err_count;
	u64 invalid_tx_word_count;
	u64 invalid_crc_count;
	
	/* fc4 statistics  (only FCP supported currently) */
	u64 fcp_input_requests;
	u64 fcp_output_requests;
	u64 fcp_control_requests;
	u64 fcp_input_megabytes;
	u64 fcp_output_megabytes;
};


/*
 * FC Event Codes - Polled and Async, following FC HBAAPI v2.0 guidelines
 */

/*
 * fc_host_event_code: If you alter this, you also need to alter
 * scsi_transport_fc.c (for the ascii descriptions).
 */
enum fc_host_event_code  {
	FCH_EVT_LIP			= 0x1,
	FCH_EVT_LINKUP			= 0x2,
	FCH_EVT_LINKDOWN		= 0x3,
	FCH_EVT_LIPRESET		= 0x4,
	FCH_EVT_RSCN			= 0x5,
	FCH_EVT_ADAPTER_CHANGE		= 0x103,
	FCH_EVT_PORT_UNKNOWN		= 0x200,
	FCH_EVT_PORT_OFFLINE		= 0x201,
	FCH_EVT_PORT_ONLINE		= 0x202,
	FCH_EVT_PORT_FABRIC		= 0x204,
	FCH_EVT_LINK_UNKNOWN		= 0x500,
	FCH_EVT_VENDOR_UNIQUE		= 0xffff,
};


/*
 * FC Local Port (Host) Attributes
 *
 * Attributes are based on HBAAPI V2.0 definitions.
 * Note: OSDeviceName is determined by user-space library
 *
 * Fixed attributes are not expected to change. The driver is
 * expected to set these values after successfully calling scsi_add_host().
 * The transport fully manages all get functions w/o driver interaction.
 *
 * Dynamic attributes are expected to change. The driver participates
 * in all get/set operations via functions provided by the driver.
 *
 * Private attributes are transport-managed values. They are fully
 * managed by the transport w/o driver interaction.
 */

#define FC_FC4_LIST_SIZE		32
#define FC_SYMBOLIC_NAME_SIZE		256
#define FC_VERSION_STRING_SIZE		64
#define FC_SERIAL_NUMBER_SIZE		80

struct fc_host_attrs {
	/* Fixed Attributes */
	u64 node_name;
	u64 port_name;
	u64 permanent_port_name;
	u32 supported_classes;
	u8  supported_fc4s[FC_FC4_LIST_SIZE];
	u32 supported_speeds;
	u32 maxframe_size;
	char serial_number[FC_SERIAL_NUMBER_SIZE];

	/* Dynamic Attributes */
	u32 port_id;
	enum fc_port_type port_type;
	enum fc_port_state port_state;
	u8  active_fc4s[FC_FC4_LIST_SIZE];
	u32 speed;
	u64 fabric_name;
	char symbolic_name[FC_SYMBOLIC_NAME_SIZE];
	char system_hostname[FC_SYMBOLIC_NAME_SIZE];

	/* Private (Transport-managed) Attributes */
	enum fc_tgtid_binding_type  tgtid_bind_type;

	/* internal data */
	struct list_head rports;
	struct list_head rport_bindings;
	u32 next_rport_number;
	u32 next_target_id;

	/* work queues for rport state manipulation */
	char work_q_name[KOBJ_NAME_LEN];
	struct workqueue_struct *work_q;
	char devloss_work_q_name[KOBJ_NAME_LEN];
	struct workqueue_struct *devloss_work_q;
};

#define shost_to_fc_host(x) \
	((struct fc_host_attrs *)(x)->shost_data)

#define fc_host_node_name(x) \
	(((struct fc_host_attrs *)(x)->shost_data)->node_name)
#define fc_host_port_name(x)	\
	(((struct fc_host_attrs *)(x)->shost_data)->port_name)
#define fc_host_permanent_port_name(x)	\
	(((struct fc_host_attrs *)(x)->shost_data)->permanent_port_name)
#define fc_host_supported_classes(x)	\
	(((struct fc_host_attrs *)(x)->shost_data)->supported_classes)
#define fc_host_supported_fc4s(x)	\
	(((struct fc_host_attrs *)(x)->shost_data)->supported_fc4s)
#define fc_host_supported_speeds(x)	\
	(((struct fc_host_attrs *)(x)->shost_data)->supported_speeds)
#define fc_host_maxframe_size(x)	\
	(((struct fc_host_attrs *)(x)->shost_data)->maxframe_size)
#define fc_host_serial_number(x)	\
	(((struct fc_host_attrs *)(x)->shost_data)->serial_number)
#define fc_host_port_id(x)	\
	(((struct fc_host_attrs *)(x)->shost_data)->port_id)
#define fc_host_port_type(x)	\
	(((struct fc_host_attrs *)(x)->shost_data)->port_type)
#define fc_host_port_state(x)	\
	(((struct fc_host_attrs *)(x)->shost_data)->port_state)
#define fc_host_active_fc4s(x)	\
	(((struct fc_host_attrs *)(x)->shost_data)->active_fc4s)
#define fc_host_speed(x)	\
	(((struct fc_host_attrs *)(x)->shost_data)->speed)
#define fc_host_fabric_name(x)	\
	(((struct fc_host_attrs *)(x)->shost_data)->fabric_name)
#define fc_host_symbolic_name(x)	\
	(((struct fc_host_attrs *)(x)->shost_data)->symbolic_name)
#define fc_host_system_hostname(x)	\
	(((struct fc_host_attrs *)(x)->shost_data)->system_hostname)
#define fc_host_tgtid_bind_type(x) \
	(((struct fc_host_attrs *)(x)->shost_data)->tgtid_bind_type)
#define fc_host_rports(x) \
	(((struct fc_host_attrs *)(x)->shost_data)->rports)
#define fc_host_rport_bindings(x) \
	(((struct fc_host_attrs *)(x)->shost_data)->rport_bindings)
#define fc_host_next_rport_number(x) \
	(((struct fc_host_attrs *)(x)->shost_data)->next_rport_number)
#define fc_host_next_target_id(x) \
	(((struct fc_host_attrs *)(x)->shost_data)->next_target_id)
#define fc_host_work_q_name(x) \
	(((struct fc_host_attrs *)(x)->shost_data)->work_q_name)
#define fc_host_work_q(x) \
	(((struct fc_host_attrs *)(x)->shost_data)->work_q)
#define fc_host_devloss_work_q_name(x) \
	(((struct fc_host_attrs *)(x)->shost_data)->devloss_work_q_name)
#define fc_host_devloss_work_q(x) \
	(((struct fc_host_attrs *)(x)->shost_data)->devloss_work_q)


/* The functions by which the transport class and the driver communicate */
struct fc_function_template {
	void    (*get_rport_dev_loss_tmo)(struct fc_rport *);
	void	(*set_rport_dev_loss_tmo)(struct fc_rport *, u32);

	void	(*get_starget_node_name)(struct scsi_target *);
	void	(*get_starget_port_name)(struct scsi_target *);
	void 	(*get_starget_port_id)(struct scsi_target *);

	void 	(*get_host_port_id)(struct Scsi_Host *);
	void	(*get_host_port_type)(struct Scsi_Host *);
	void	(*get_host_port_state)(struct Scsi_Host *);
	void	(*get_host_active_fc4s)(struct Scsi_Host *);
	void	(*get_host_speed)(struct Scsi_Host *);
	void	(*get_host_fabric_name)(struct Scsi_Host *);
	void	(*get_host_symbolic_name)(struct Scsi_Host *);
	void	(*set_host_system_hostname)(struct Scsi_Host *);

	struct fc_host_statistics * (*get_fc_host_stats)(struct Scsi_Host *);
	void	(*reset_fc_host_stats)(struct Scsi_Host *);

	int	(*issue_fc_host_lip)(struct Scsi_Host *);

	void    (*dev_loss_tmo_callbk)(struct fc_rport *);
	void	(*terminate_rport_io)(struct fc_rport *);

	/* allocation lengths for host-specific data */
	u32	 			dd_fcrport_size;

	/* 
	 * The driver sets these to tell the transport class it
	 * wants the attributes displayed in sysfs.  If the show_ flag
	 * is not set, the attribute will be private to the transport
	 * class 
	 */

	/* remote port fixed attributes */
	unsigned long	show_rport_maxframe_size:1;
	unsigned long	show_rport_supported_classes:1;
	unsigned long   show_rport_dev_loss_tmo:1;

	/*
	 * target dynamic attributes
	 * These should all be "1" if the driver uses the remote port
	 * add/delete functions (so attributes reflect rport values).
	 */
	unsigned long	show_starget_node_name:1;
	unsigned long	show_starget_port_name:1;
	unsigned long	show_starget_port_id:1;

	/* host fixed attributes */
	unsigned long	show_host_node_name:1;
	unsigned long	show_host_port_name:1;
	unsigned long	show_host_permanent_port_name:1;
	unsigned long	show_host_supported_classes:1;
	unsigned long	show_host_supported_fc4s:1;
	unsigned long	show_host_supported_speeds:1;
	unsigned long	show_host_maxframe_size:1;
	unsigned long	show_host_serial_number:1;
	/* host dynamic attributes */
	unsigned long	show_host_port_id:1;
	unsigned long	show_host_port_type:1;
	unsigned long	show_host_port_state:1;
	unsigned long	show_host_active_fc4s:1;
	unsigned long	show_host_speed:1;
	unsigned long	show_host_fabric_name:1;
	unsigned long	show_host_symbolic_name:1;
	unsigned long	show_host_system_hostname:1;
};


/**
 * fc_remote_port_chkready - called to validate the remote port state
 *   prior to initiating io to the port.
 *
 * Returns a scsi result code that can be returned by the LLDD.
 *
 * @rport:	remote port to be checked
 **/
static inline int
fc_remote_port_chkready(struct fc_rport *rport)
{
	int result;

	switch (rport->port_state) {
	case FC_PORTSTATE_ONLINE:
		if (rport->roles & FC_RPORT_ROLE_FCP_TARGET)
			result = 0;
		else if (rport->flags & FC_RPORT_DEVLOSS_PENDING)
			result = DID_IMM_RETRY << 16;
		else
			result = DID_NO_CONNECT << 16;
		break;
	case FC_PORTSTATE_BLOCKED:
		result = DID_IMM_RETRY << 16;
		break;
	default:
		result = DID_NO_CONNECT << 16;
		break;
	}
	return result;
}

static inline u64 wwn_to_u64(u8 *wwn)
{
	return (u64)wwn[0] << 56 | (u64)wwn[1] << 48 |
	    (u64)wwn[2] << 40 | (u64)wwn[3] << 32 |
	    (u64)wwn[4] << 24 | (u64)wwn[5] << 16 |
	    (u64)wwn[6] <<  8 | (u64)wwn[7];
}

static inline void u64_to_wwn(u64 inm, u8 *wwn)
{
	wwn[0] = (inm >> 56) & 0xff;
	wwn[1] = (inm >> 48) & 0xff;
	wwn[2] = (inm >> 40) & 0xff;
	wwn[3] = (inm >> 32) & 0xff;
	wwn[4] = (inm >> 24) & 0xff;
	wwn[5] = (inm >> 16) & 0xff;
	wwn[6] = (inm >> 8) & 0xff;
	wwn[7] = inm & 0xff;
}

struct scsi_transport_template *fc_attach_transport(
			struct fc_function_template *);
void fc_release_transport(struct scsi_transport_template *);
void fc_remove_host(struct Scsi_Host *);
struct fc_rport *fc_remote_port_add(struct Scsi_Host *shost,
			int channel, struct fc_rport_identifiers  *ids);
void fc_remote_port_delete(struct fc_rport  *rport);
void fc_remote_port_rolechg(struct fc_rport  *rport, u32 roles);
int scsi_is_fc_rport(const struct device *);
u32 fc_get_event_number(void);
void fc_host_post_event(struct Scsi_Host *shost, u32 event_number,
		enum fc_host_event_code event_code, u32 event_data);
void fc_host_post_vendor_event(struct Scsi_Host *shost, u32 event_number,
		u32 data_len, char * data_buf, u64 vendor_id);
	/* Note: when specifying vendor_id to fc_host_post_vendor_event()
	 *   be sure to read the Vendor Type and ID formatting requirements
	 *   specified in scsi_netlink.h
	 */

#endif /* SCSI_TRANSPORT_FC_H */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* FiberChannel transport specific attributes exported to sysfs.
	3	*
	4	* Copyright (c) 2003 Silicon Graphics, Inc. All rights reserved.
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation; either version 2 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program; if not, write to the Free Software
	18	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	19	*
	20	* ========
	21	*
	22	* Copyright (C) 2004-2005 James Smart, Emulex Corporation
	23	* Rewrite for host, target, device, and remote port attributes,
	24	* statistics, and service functions...
	25	*
	26	*/
	27	#ifndef SCSI_TRANSPORT_FC_H
	28	#define SCSI_TRANSPORT_FC_H
	29
4e57b681	30	#include <linux/sched.h>
19a7b4ae	31	#include <scsi/scsi.h>
84314fd4	32	#include <scsi/scsi_netlink.h>
1da177e4 LT	33
	34	struct scsi_transport_template;
	35
	36
	37	/*
	38	* FC Port definitions - Following FC HBAAPI guidelines
	39	*
	40	* Note: Not all binary values for the different fields match HBAAPI.
	41	* Instead, we use densely packed ordinal values or enums.
	42	* We get away with this as we never present the actual binary values
	43	* externally. For sysfs, we always present the string that describes
	44	* the value. Thus, an admin doesn't need a magic HBAAPI decoder ring
	45	* to understand the values. The HBAAPI user-space library is free to
	46	* convert the strings into the HBAAPI-specified binary values.
	47	*
	48	* Note: Not all HBAAPI-defined values are contained in the definitions
	49	* below. Those not appropriate to an fc_host (e.g. FCP initiator) have
	50	* been removed.
	51	*/
	52
	53	/*
	54	* fc_port_type: If you alter this, you also need to alter scsi_transport_fc.c
	55	* (for the ascii descriptions).
	56	*/
	57	enum fc_port_type {
	58	FC_PORTTYPE_UNKNOWN,
	59	FC_PORTTYPE_OTHER,
	60	FC_PORTTYPE_NOTPRESENT,
	61	FC_PORTTYPE_NPORT, /* Attached to FPort */
	62	FC_PORTTYPE_NLPORT, /* (Public) Loop w/ FLPort */
	63	FC_PORTTYPE_LPORT, /* (Private) Loop w/o FLPort */
	64	FC_PORTTYPE_PTP, /* Point to Point w/ another NPort */
	65	};
	66
	67	/*
	68	* fc_port_state: If you alter this, you also need to alter scsi_transport_fc.c
	69	* (for the ascii descriptions).
	70	*/
	71	enum fc_port_state {
	72	FC_PORTSTATE_UNKNOWN,
	73	FC_PORTSTATE_NOTPRESENT,
	74	FC_PORTSTATE_ONLINE,
	75	FC_PORTSTATE_OFFLINE, /* User has taken Port Offline */
	76	FC_PORTSTATE_BLOCKED,
	77	FC_PORTSTATE_BYPASSED,
	78	FC_PORTSTATE_DIAGNOSTICS,
	79	FC_PORTSTATE_LINKDOWN,
	80	FC_PORTSTATE_ERROR,
	81	FC_PORTSTATE_LOOPBACK,
42e33148	82	FC_PORTSTATE_DELETED,
1da177e4 LT	83	};
	84
	85
	86	/*
	87	* FC Classes of Service
	88	* Note: values are not enumerated, as they can be "or'd" together
	89	* for reporting (e.g. report supported_classes). If you alter this list,
	90	* you also need to alter scsi_transport_fc.c (for the ascii descriptions).
	91	*/
	92	#define FC_COS_UNSPECIFIED 0
	93	#define FC_COS_CLASS1 2
	94	#define FC_COS_CLASS2 4
	95	#define FC_COS_CLASS3 8
	96	#define FC_COS_CLASS4 0x10
	97	#define FC_COS_CLASS6 0x40
	98
	99	/*
	100	* FC Port Speeds
	101	* Note: values are not enumerated, as they can be "or'd" together
	102	* for reporting (e.g. report supported_speeds). If you alter this list,
	103	* you also need to alter scsi_transport_fc.c (for the ascii descriptions).
	104	*/
	105	#define FC_PORTSPEED_UNKNOWN 0 /* Unknown - transceiver
	106	incapable of reporting */
	107	#define FC_PORTSPEED_1GBIT 1
	108	#define FC_PORTSPEED_2GBIT 2
1832a586 AH	109	#define FC_PORTSPEED_4GBIT 4
1832a586 AH	110	#define FC_PORTSPEED_10GBIT 8
1da177e4 LT	111	#define FC_PORTSPEED_NOT_NEGOTIATED (1 << 15) /* Speed not established */
	112
	113	/*
	114	* fc_tgtid_binding_type: If you alter this, you also need to alter
	115	* scsi_transport_fc.c (for the ascii descriptions).
	116	*/
	117	enum fc_tgtid_binding_type {
	118	FC_TGTID_BIND_NONE,
	119	FC_TGTID_BIND_BY_WWPN,
	120	FC_TGTID_BIND_BY_WWNN,
	121	FC_TGTID_BIND_BY_ID,
	122	};
	123
	124	/*
	125	* FC Remote Port Roles
	126	* Note: values are not enumerated, as they can be "or'd" together
	127	* for reporting (e.g. report roles). If you alter this list,
	128	* you also need to alter scsi_transport_fc.c (for the ascii descriptions).
	129	*/
	130	#define FC_RPORT_ROLE_UNKNOWN 0x00
	131	#define FC_RPORT_ROLE_FCP_TARGET 0x01
	132	#define FC_RPORT_ROLE_FCP_INITIATOR 0x02
	133	#define FC_RPORT_ROLE_IP_PORT 0x04
	134
	135
	136	/*
	137	* fc_rport_identifiers: This set of data contains all elements
	138	* to uniquely identify a remote FC port. The driver uses this data
	139	* to report the existence of a remote FC port in the topology. Internally,
	140	* the transport uses this data for attributes and to manage consistent
	141	* target id bindings.
	142	*/
	143	struct fc_rport_identifiers {
	144	u64 node_name;
	145	u64 port_name;
	146	u32 port_id;
	147	u32 roles;
	148	};
	149
	150	/* Macro for use in defining Remote Port attributes */
	151	#define FC_RPORT_ATTR(_name,_mode,_show,_store) \
	152	struct class_device_attribute class_device_attr_rport_##_name = \
	153	__ATTR(_name,_mode,_show,_store)
	154
	155
	156	/*
	157	* FC Remote Port Attributes
	158	*
	159	* This structure exists for each remote FC port that a LLDD notifies
	160	* the subsystem of. A remote FC port may or may not be a SCSI Target,
	161	* also be a SCSI initiator, IP endpoint, etc. As such, the remote
	162	* port is considered a separate entity, independent of "role" (such
	163	* as scsi target).
	164	*
	165	* --
	166	*
	167	* Attributes are based on HBAAPI V2.0 definitions. Only those
	168	* attributes that are determinable by the local port (aka Host)
	169	* are contained.
	170	*
	171	* Fixed attributes are not expected to change. The driver is
	172	* expected to set these values after successfully calling
	173	* fc_remote_port_add(). The transport fully manages all get functions
	174	* w/o driver interaction.
175	*
176	* Dynamic attributes are expected to change. The driver participates
177	* in all get/set operations via functions provided by the driver.
178	*
179	* Private attributes are transport-managed values. They are fully
180	* managed by the transport w/o driver interaction.
181	*/
182
183	struct fc_rport { /* aka fc_starget_attrs */
184	/* Fixed Attributes */
185	u32 maxframe_size;
186	u32 supported_classes;
187
188	/* Dynamic Attributes */
189	u32 dev_loss_tmo; /* Remote Port loss timeout in seconds. */
190
191	/* Private (Transport-managed) Attributes */
192	u64 node_name;
193	u64 port_name;
194	u32 port_id;
195	u32 roles;
196	enum fc_port_state port_state; /* Will only be ONLINE or UNKNOWN */
197	u32 scsi_target_id;
0f29b966	198	u32 fast_io_fail_tmo;
1da177e4 LT	199
	200	/* exported data */
	201	void dd_data; / Used for driver-specific storage */
	202
	203	/* internal data */
	204	unsigned int channel;
	205	u32 number;
aedf3497	206	u8 flags;
1da177e4 LT	207	struct list_head peers;
1da177e4 LT	208	struct device dev;
c4028958	209	struct delayed_work dev_loss_work;
1da177e4	210	struct work_struct scan_work;
c4028958	211	struct delayed_work fail_io_work;
aedf3497 JS	212	struct work_struct stgt_delete_work;
aedf3497 JS	213	struct work_struct rport_delete_work;
1da177e4 LT	214	} __attribute__((aligned(sizeof(unsigned long))));
1da177e4 LT	215
aedf3497 JS	216	/* bit field values for struct fc_rport "flags" field: */
	217	#define FC_RPORT_DEVLOSS_PENDING 0x01
	218	#define FC_RPORT_SCAN_PENDING 0x02
	219
1da177e4 LT	220	#define dev_to_rport(d) \
	221	container_of(d, struct fc_rport, dev)
	222	#define transport_class_to_rport(classdev) \
	223	dev_to_rport(classdev->dev)
	224	#define rport_to_shost(r) \
	225	dev_to_shost(r->dev.parent)
	226
	227	/*
	228	* FC SCSI Target Attributes
	229	*
	230	* The SCSI Target is considered an extention of a remote port (as
	231	* a remote port can be more than a SCSI Target). Within the scsi
	232	* subsystem, we leave the Target as a separate entity. Doing so
	233	* provides backward compatibility with prior FC transport api's,
	234	* and lets remote ports be handled entirely within the FC transport
	235	* and independently from the scsi subsystem. The drawback is that
	236	* some data will be duplicated.
	237	*/
	238
	239	struct fc_starget_attrs { /* aka fc_target_attrs */
	240	/* Dynamic Attributes */
	241	u64 node_name;
	242	u64 port_name;
	243	u32 port_id;
	244	};
	245
	246	#define fc_starget_node_name(x) \
	247	(((struct fc_starget_attrs *)&(x)->starget_data)->node_name)
	248	#define fc_starget_port_name(x) \
	249	(((struct fc_starget_attrs *)&(x)->starget_data)->port_name)
	250	#define fc_starget_port_id(x) \
	251	(((struct fc_starget_attrs *)&(x)->starget_data)->port_id)
	252
	253	#define starget_to_rport(s) \
	254	scsi_is_fc_rport(s->dev.parent) ? dev_to_rport(s->dev.parent) : NULL
	255
	256
	257	/*
	258	* FC Local Port (Host) Statistics
	259	*/
	260
	261	/* FC Statistics - Following FC HBAAPI v2.0 guidelines */
	262	struct fc_host_statistics {
	263	/* port statistics */
	264	u64 seconds_since_last_reset;
	265	u64 tx_frames;
	266	u64 tx_words;
	267	u64 rx_frames;
	268	u64 rx_words;
	269	u64 lip_count;
	270	u64 nos_count;
	271	u64 error_frames;
	272	u64 dumped_frames;
	273	u64 link_failure_count;
	274	u64 loss_of_sync_count;
	275	u64 loss_of_signal_count;
	276	u64 prim_seq_protocol_err_count;
	277	u64 invalid_tx_word_count;
	278	u64 invalid_crc_count;
	279
	280	/* fc4 statistics (only FCP supported currently) */
	281	u64 fcp_input_requests;
	282	u64 fcp_output_requests;
	283	u64 fcp_control_requests;
284	u64 fcp_input_megabytes;
285	u64 fcp_output_megabytes;
286	};
287
288
84314fd4 JS	289	/*
	290	* FC Event Codes - Polled and Async, following FC HBAAPI v2.0 guidelines
	291	*/
	292
	293	/*
	294	* fc_host_event_code: If you alter this, you also need to alter
	295	* scsi_transport_fc.c (for the ascii descriptions).
	296	*/
	297	enum fc_host_event_code {
	298	FCH_EVT_LIP = 0x1,
	299	FCH_EVT_LINKUP = 0x2,
	300	FCH_EVT_LINKDOWN = 0x3,
	301	FCH_EVT_LIPRESET = 0x4,
	302	FCH_EVT_RSCN = 0x5,
	303	FCH_EVT_ADAPTER_CHANGE = 0x103,
	304	FCH_EVT_PORT_UNKNOWN = 0x200,
	305	FCH_EVT_PORT_OFFLINE = 0x201,
	306	FCH_EVT_PORT_ONLINE = 0x202,
	307	FCH_EVT_PORT_FABRIC = 0x204,
	308	FCH_EVT_LINK_UNKNOWN = 0x500,
	309	FCH_EVT_VENDOR_UNIQUE = 0xffff,
	310	};
	311
	312
1da177e4 LT	313	/*
	314	* FC Local Port (Host) Attributes
	315	*
	316	* Attributes are based on HBAAPI V2.0 definitions.
	317	* Note: OSDeviceName is determined by user-space library
	318	*
	319	* Fixed attributes are not expected to change. The driver is
	320	* expected to set these values after successfully calling scsi_add_host().
	321	* The transport fully manages all get functions w/o driver interaction.
	322	*
	323	* Dynamic attributes are expected to change. The driver participates
	324	* in all get/set operations via functions provided by the driver.
	325	*
	326	* Private attributes are transport-managed values. They are fully
	327	* managed by the transport w/o driver interaction.
	328	*/
	329
	330	#define FC_FC4_LIST_SIZE 32
	331	#define FC_SYMBOLIC_NAME_SIZE 256
	332	#define FC_VERSION_STRING_SIZE 64
	333	#define FC_SERIAL_NUMBER_SIZE 80
	334
	335	struct fc_host_attrs {
	336	/* Fixed Attributes */
	337	u64 node_name;
	338	u64 port_name;
6b7281d0	339	u64 permanent_port_name;
1da177e4 LT	340	u32 supported_classes;
1da177e4 LT	341	u8 supported_fc4s[FC_FC4_LIST_SIZE];
1da177e4 LT	342	u32 supported_speeds;
	343	u32 maxframe_size;
	344	char serial_number[FC_SERIAL_NUMBER_SIZE];
	345
	346	/* Dynamic Attributes */
	347	u32 port_id;
	348	enum fc_port_type port_type;
	349	enum fc_port_state port_state;
	350	u8 active_fc4s[FC_FC4_LIST_SIZE];
	351	u32 speed;
	352	u64 fabric_name;
b8d08210 JS	353	char symbolic_name[FC_SYMBOLIC_NAME_SIZE];
b8d08210 JS	354	char system_hostname[FC_SYMBOLIC_NAME_SIZE];
1da177e4 LT	355
	356	/* Private (Transport-managed) Attributes */
	357	enum fc_tgtid_binding_type tgtid_bind_type;
	358
	359	/* internal data */
	360	struct list_head rports;
	361	struct list_head rport_bindings;
	362	u32 next_rport_number;
	363	u32 next_target_id;
1da177e4	364
aedf3497 JS	365	/* work queues for rport state manipulation */
	366	char work_q_name[KOBJ_NAME_LEN];
	367	struct workqueue_struct *work_q;
	368	char devloss_work_q_name[KOBJ_NAME_LEN];
	369	struct workqueue_struct *devloss_work_q;
	370	};
42e33148	371
aedf3497 JS	372	#define shost_to_fc_host(x) \
aedf3497 JS	373	((struct fc_host_attrs *)(x)->shost_data)
42e33148	374
1da177e4 LT	375	#define fc_host_node_name(x) \
	376	(((struct fc_host_attrs *)(x)->shost_data)->node_name)
	377	#define fc_host_port_name(x) \
	378	(((struct fc_host_attrs *)(x)->shost_data)->port_name)
6b7281d0 AH	379	#define fc_host_permanent_port_name(x) \
6b7281d0 AH	380	(((struct fc_host_attrs *)(x)->shost_data)->permanent_port_name)
1da177e4 LT	381	#define fc_host_supported_classes(x) \
	382	(((struct fc_host_attrs *)(x)->shost_data)->supported_classes)
	383	#define fc_host_supported_fc4s(x) \
	384	(((struct fc_host_attrs *)(x)->shost_data)->supported_fc4s)
1da177e4 LT	385	#define fc_host_supported_speeds(x) \
	386	(((struct fc_host_attrs *)(x)->shost_data)->supported_speeds)
	387	#define fc_host_maxframe_size(x) \
	388	(((struct fc_host_attrs *)(x)->shost_data)->maxframe_size)
	389	#define fc_host_serial_number(x) \
	390	(((struct fc_host_attrs *)(x)->shost_data)->serial_number)
	391	#define fc_host_port_id(x) \
	392	(((struct fc_host_attrs *)(x)->shost_data)->port_id)
	393	#define fc_host_port_type(x) \
	394	(((struct fc_host_attrs *)(x)->shost_data)->port_type)
	395	#define fc_host_port_state(x) \
	396	(((struct fc_host_attrs *)(x)->shost_data)->port_state)
	397	#define fc_host_active_fc4s(x) \
	398	(((struct fc_host_attrs *)(x)->shost_data)->active_fc4s)
	399	#define fc_host_speed(x) \
	400	(((struct fc_host_attrs *)(x)->shost_data)->speed)
	401	#define fc_host_fabric_name(x) \
	402	(((struct fc_host_attrs *)(x)->shost_data)->fabric_name)
b8d08210 JS	403	#define fc_host_symbolic_name(x) \
	404	(((struct fc_host_attrs *)(x)->shost_data)->symbolic_name)
	405	#define fc_host_system_hostname(x) \
	406	(((struct fc_host_attrs *)(x)->shost_data)->system_hostname)
1da177e4 LT	407	#define fc_host_tgtid_bind_type(x) \
	408	(((struct fc_host_attrs *)(x)->shost_data)->tgtid_bind_type)
	409	#define fc_host_rports(x) \
	410	(((struct fc_host_attrs *)(x)->shost_data)->rports)
	411	#define fc_host_rport_bindings(x) \
	412	(((struct fc_host_attrs *)(x)->shost_data)->rport_bindings)
	413	#define fc_host_next_rport_number(x) \
	414	(((struct fc_host_attrs *)(x)->shost_data)->next_rport_number)
	415	#define fc_host_next_target_id(x) \
	416	(((struct fc_host_attrs *)(x)->shost_data)->next_target_id)
aedf3497 JS	417	#define fc_host_work_q_name(x) \
	418	(((struct fc_host_attrs *)(x)->shost_data)->work_q_name)
	419	#define fc_host_work_q(x) \
	420	(((struct fc_host_attrs *)(x)->shost_data)->work_q)
	421	#define fc_host_devloss_work_q_name(x) \
	422	(((struct fc_host_attrs *)(x)->shost_data)->devloss_work_q_name)
	423	#define fc_host_devloss_work_q(x) \
	424	(((struct fc_host_attrs *)(x)->shost_data)->devloss_work_q)
1da177e4 LT	425
	426
	427	/* The functions by which the transport class and the driver communicate */
	428	struct fc_function_template {
	429	void (get_rport_dev_loss_tmo)(struct fc_rport );
	430	void (set_rport_dev_loss_tmo)(struct fc_rport , u32);
	431
	432	void (get_starget_node_name)(struct scsi_target );
	433	void (get_starget_port_name)(struct scsi_target );
	434	void (get_starget_port_id)(struct scsi_target );
	435
	436	void (get_host_port_id)(struct Scsi_Host );
	437	void (get_host_port_type)(struct Scsi_Host );
	438	void (get_host_port_state)(struct Scsi_Host );
	439	void (get_host_active_fc4s)(struct Scsi_Host );
	440	void (get_host_speed)(struct Scsi_Host );
	441	void (get_host_fabric_name)(struct Scsi_Host );
016131b8	442	void (get_host_symbolic_name)(struct Scsi_Host );
b8d08210	443	void (set_host_system_hostname)(struct Scsi_Host );
1da177e4 LT	444
	445	struct fc_host_statistics * (get_fc_host_stats)(struct Scsi_Host );
	446	void (reset_fc_host_stats)(struct Scsi_Host );
	447
91ca7b01 AV	448	int (issue_fc_host_lip)(struct Scsi_Host );
91ca7b01 AV	449
0f29b966 JS	450	void (dev_loss_tmo_callbk)(struct fc_rport );
	451	void (terminate_rport_io)(struct fc_rport );
	452
1da177e4 LT	453	/* allocation lengths for host-specific data */
	454	u32 dd_fcrport_size;
	455
	456	/*
	457	* The driver sets these to tell the transport class it
	458	* wants the attributes displayed in sysfs. If the show_ flag
	459	* is not set, the attribute will be private to the transport
	460	* class
	461	*/
	462
	463	/* remote port fixed attributes */
	464	unsigned long show_rport_maxframe_size:1;
	465	unsigned long show_rport_supported_classes:1;
	466	unsigned long show_rport_dev_loss_tmo:1;
	467
	468	/*
	469	* target dynamic attributes
	470	* These should all be "1" if the driver uses the remote port
	471	* add/delete functions (so attributes reflect rport values).
	472	*/
	473	unsigned long show_starget_node_name:1;
	474	unsigned long show_starget_port_name:1;
	475	unsigned long show_starget_port_id:1;
	476
	477	/* host fixed attributes */
	478	unsigned long show_host_node_name:1;
	479	unsigned long show_host_port_name:1;
6b7281d0	480	unsigned long show_host_permanent_port_name:1;
1da177e4 LT	481	unsigned long show_host_supported_classes:1;
1da177e4 LT	482	unsigned long show_host_supported_fc4s:1;
1da177e4 LT	483	unsigned long show_host_supported_speeds:1;
	484	unsigned long show_host_maxframe_size:1;
	485	unsigned long show_host_serial_number:1;
	486	/* host dynamic attributes */
	487	unsigned long show_host_port_id:1;
	488	unsigned long show_host_port_type:1;
	489	unsigned long show_host_port_state:1;
	490	unsigned long show_host_active_fc4s:1;
	491	unsigned long show_host_speed:1;
	492	unsigned long show_host_fabric_name:1;
016131b8	493	unsigned long show_host_symbolic_name:1;
b8d08210	494	unsigned long show_host_system_hostname:1;
1da177e4 LT	495	};
	496
	497
19a7b4ae JSEC	498	/**
	499	* fc_remote_port_chkready - called to validate the remote port state
	500	* prior to initiating io to the port.
	501	*
	502	* Returns a scsi result code that can be returned by the LLDD.
	503	*
	504	* @rport: remote port to be checked
	505	**/
	506	static inline int
	507	fc_remote_port_chkready(struct fc_rport *rport)
	508	{
	509	int result;
	510
	511	switch (rport->port_state) {
	512	case FC_PORTSTATE_ONLINE:
aedf3497 JS	513	if (rport->roles & FC_RPORT_ROLE_FCP_TARGET)
	514	result = 0;
	515	else if (rport->flags & FC_RPORT_DEVLOSS_PENDING)
	516	result = DID_IMM_RETRY << 16;
	517	else
	518	result = DID_NO_CONNECT << 16;
19a7b4ae JSEC	519	break;
19a7b4ae JSEC	520	case FC_PORTSTATE_BLOCKED:
aedf3497	521	result = DID_IMM_RETRY << 16;
19a7b4ae JSEC	522	break;
	523	default:
	524	result = DID_NO_CONNECT << 16;
	525	break;
	526	}
	527	return result;
	528	}
	529
b8d08210 JS	530	static inline u64 wwn_to_u64(u8 *wwn)
	531	{
	532	return (u64)wwn[0] << 56 \| (u64)wwn[1] << 48 \|
	533	(u64)wwn[2] << 40 \| (u64)wwn[3] << 32 \|
	534	(u64)wwn[4] << 24 \| (u64)wwn[5] << 16 \|
	535	(u64)wwn[6] << 8 \| (u64)wwn[7];
	536	}
	537
	538	static inline void u64_to_wwn(u64 inm, u8 *wwn)
	539	{
	540	wwn[0] = (inm >> 56) & 0xff;
	541	wwn[1] = (inm >> 48) & 0xff;
	542	wwn[2] = (inm >> 40) & 0xff;
	543	wwn[3] = (inm >> 32) & 0xff;
	544	wwn[4] = (inm >> 24) & 0xff;
	545	wwn[5] = (inm >> 16) & 0xff;
	546	wwn[6] = (inm >> 8) & 0xff;
	547	wwn[7] = inm & 0xff;
	548	}
19a7b4ae	549
1da177e4 LT	550	struct scsi_transport_template *fc_attach_transport(
	551	struct fc_function_template *);
	552	void fc_release_transport(struct scsi_transport_template *);
	553	void fc_remove_host(struct Scsi_Host *);
	554	struct fc_rport fc_remote_port_add(struct Scsi_Host shost,
	555	int channel, struct fc_rport_identifiers *ids);
	556	void fc_remote_port_delete(struct fc_rport *rport);
	557	void fc_remote_port_rolechg(struct fc_rport *rport, u32 roles);
1da177e4	558	int scsi_is_fc_rport(const struct device *);
84314fd4 JS	559	u32 fc_get_event_number(void);
	560	void fc_host_post_event(struct Scsi_Host *shost, u32 event_number,
	561	enum fc_host_event_code event_code, u32 event_data);
	562	void fc_host_post_vendor_event(struct Scsi_Host *shost, u32 event_number,
f14e2e29	563	u32 data_len, char * data_buf, u64 vendor_id);
84314fd4 JS	564	/* Note: when specifying vendor_id to fc_host_post_vendor_event()
	565	* be sure to read the Vendor Type and ID formatting requirements
	566	* specified in scsi_netlink.h
	567	*/
1da177e4 LT	568
1da177e4 LT	569	#endif /* SCSI_TRANSPORT_FC_H */