[deliverable/linux.git] / drivers / s390 / scsi / zfcp_fsf.h

/*
 * zfcp device driver
 *
 * Interface to the FSF support functions.
 *
 * Copyright IBM Corp. 2002, 2015
 */

#ifndef FSF_H
#define FSF_H

#include <linux/pfn.h>
#include <linux/scatterlist.h>
#include <scsi/libfc.h>

#define FSF_QTCB_CURRENT_VERSION		0x00000001

/* FSF commands */
#define	FSF_QTCB_FCP_CMND			0x00000001
#define	FSF_QTCB_ABORT_FCP_CMND			0x00000002
#define	FSF_QTCB_OPEN_PORT_WITH_DID		0x00000005
#define	FSF_QTCB_OPEN_LUN			0x00000006
#define	FSF_QTCB_CLOSE_LUN			0x00000007
#define	FSF_QTCB_CLOSE_PORT			0x00000008
#define	FSF_QTCB_CLOSE_PHYSICAL_PORT		0x00000009
#define	FSF_QTCB_SEND_ELS			0x0000000B
#define	FSF_QTCB_SEND_GENERIC			0x0000000C
#define	FSF_QTCB_EXCHANGE_CONFIG_DATA		0x0000000D
#define	FSF_QTCB_EXCHANGE_PORT_DATA		0x0000000E
#define FSF_QTCB_DOWNLOAD_CONTROL_FILE		0x00000012
#define FSF_QTCB_UPLOAD_CONTROL_FILE		0x00000013

/* FSF QTCB types */
#define FSF_IO_COMMAND				0x00000001
#define FSF_SUPPORT_COMMAND			0x00000002
#define FSF_CONFIG_COMMAND			0x00000003
#define FSF_PORT_COMMAND			0x00000004

/* FSF protocol states */
#define FSF_PROT_GOOD				0x00000001
#define FSF_PROT_QTCB_VERSION_ERROR		0x00000010
#define FSF_PROT_SEQ_NUMB_ERROR			0x00000020
#define FSF_PROT_UNSUPP_QTCB_TYPE		0x00000040
#define FSF_PROT_HOST_CONNECTION_INITIALIZING	0x00000080
#define FSF_PROT_FSF_STATUS_PRESENTED		0x00000100
#define FSF_PROT_DUPLICATE_REQUEST_ID		0x00000200
#define FSF_PROT_LINK_DOWN                      0x00000400
#define FSF_PROT_REEST_QUEUE                    0x00000800
#define FSF_PROT_ERROR_STATE			0x01000000

/* FSF states */
#define FSF_GOOD				0x00000000
#define FSF_PORT_ALREADY_OPEN			0x00000001
#define FSF_LUN_ALREADY_OPEN			0x00000002
#define FSF_PORT_HANDLE_NOT_VALID		0x00000003
#define FSF_LUN_HANDLE_NOT_VALID		0x00000004
#define FSF_HANDLE_MISMATCH			0x00000005
#define FSF_SERVICE_CLASS_NOT_SUPPORTED		0x00000006
#define FSF_FCPLUN_NOT_VALID			0x00000009
#define FSF_LUN_SHARING_VIOLATION               0x00000012
#define FSF_FCP_COMMAND_DOES_NOT_EXIST		0x00000022
#define FSF_DIRECTION_INDICATOR_NOT_VALID	0x00000030
#define FSF_CMND_LENGTH_NOT_VALID		0x00000033
#define FSF_MAXIMUM_NUMBER_OF_PORTS_EXCEEDED	0x00000040
#define FSF_MAXIMUM_NUMBER_OF_LUNS_EXCEEDED	0x00000041
#define FSF_ELS_COMMAND_REJECTED		0x00000050
#define FSF_GENERIC_COMMAND_REJECTED		0x00000051
#define FSF_PORT_BOXED				0x00000059
#define FSF_LUN_BOXED				0x0000005A
#define FSF_EXCHANGE_CONFIG_DATA_INCOMPLETE	0x0000005B
#define FSF_PAYLOAD_SIZE_MISMATCH		0x00000060
#define FSF_REQUEST_SIZE_TOO_LARGE		0x00000061
#define FSF_RESPONSE_SIZE_TOO_LARGE		0x00000062
#define FSF_SBAL_MISMATCH			0x00000063
#define FSF_INCONSISTENT_PROT_DATA		0x00000070
#define FSF_INVALID_PROT_PARM			0x00000071
#define FSF_BLOCK_GUARD_CHECK_FAILURE		0x00000081
#define FSF_APP_TAG_CHECK_FAILURE		0x00000082
#define FSF_REF_TAG_CHECK_FAILURE		0x00000083
#define FSF_ADAPTER_STATUS_AVAILABLE		0x000000AD
#define FSF_UNKNOWN_COMMAND			0x000000E2
#define FSF_UNKNOWN_OP_SUBTYPE                  0x000000E3
#define FSF_INVALID_COMMAND_OPTION              0x000000E5

#define FSF_PROT_STATUS_QUAL_SIZE		16
#define FSF_STATUS_QUALIFIER_SIZE		16

/* FSF status qualifier, recommendations */
#define FSF_SQ_NO_RECOM				0x00
#define FSF_SQ_FCP_RSP_AVAILABLE		0x01
#define FSF_SQ_RETRY_IF_POSSIBLE		0x02
#define FSF_SQ_ULP_DEPENDENT_ERP_REQUIRED	0x03
#define FSF_SQ_INVOKE_LINK_TEST_PROCEDURE	0x04
#define FSF_SQ_COMMAND_ABORTED			0x06
#define FSF_SQ_NO_RETRY_POSSIBLE		0x07

/* FSF status qualifier (most significant 4 bytes), local link down */
#define FSF_PSQ_LINK_NO_LIGHT			0x00000004
#define FSF_PSQ_LINK_WRAP_PLUG			0x00000008
#define FSF_PSQ_LINK_NO_FCP			0x00000010
#define FSF_PSQ_LINK_FIRMWARE_UPDATE		0x00000020
#define FSF_PSQ_LINK_INVALID_WWPN		0x00000100
#define FSF_PSQ_LINK_NO_NPIV_SUPPORT		0x00000200
#define FSF_PSQ_LINK_NO_FCP_RESOURCES		0x00000400
#define FSF_PSQ_LINK_NO_FABRIC_RESOURCES	0x00000800
#define FSF_PSQ_LINK_FABRIC_LOGIN_UNABLE	0x00001000
#define FSF_PSQ_LINK_WWPN_ASSIGNMENT_CORRUPTED	0x00002000
#define FSF_PSQ_LINK_MODE_TABLE_CURRUPTED	0x00004000
#define FSF_PSQ_LINK_NO_WWPN_ASSIGNMENT		0x00008000

/* payload size in status read buffer */
#define FSF_STATUS_READ_PAYLOAD_SIZE		4032

/* number of status read buffers that should be sent by ULP */
#define FSF_STATUS_READS_RECOM			16

/* status types in status read buffer */
#define FSF_STATUS_READ_PORT_CLOSED		0x00000001
#define FSF_STATUS_READ_INCOMING_ELS		0x00000002
#define FSF_STATUS_READ_SENSE_DATA_AVAIL        0x00000003
#define FSF_STATUS_READ_BIT_ERROR_THRESHOLD	0x00000004
#define FSF_STATUS_READ_LINK_DOWN		0x00000005
#define FSF_STATUS_READ_LINK_UP          	0x00000006
#define FSF_STATUS_READ_NOTIFICATION_LOST	0x00000009
#define FSF_STATUS_READ_FEATURE_UPDATE_ALERT	0x0000000C

/* status subtypes for link down */
#define FSF_STATUS_READ_SUB_NO_PHYSICAL_LINK	0x00000000
#define FSF_STATUS_READ_SUB_FDISC_FAILED	0x00000001
#define FSF_STATUS_READ_SUB_FIRMWARE_UPDATE	0x00000002

/* status subtypes for unsolicited status notification lost */
#define FSF_STATUS_READ_SUB_INCOMING_ELS	0x00000001

/* topologie that is detected by the adapter */
#define FSF_TOPO_P2P				0x00000001
#define FSF_TOPO_FABRIC				0x00000002
#define FSF_TOPO_AL				0x00000003

/* data direction for FCP commands */
#define FSF_DATADIR_WRITE			0x00000001
#define FSF_DATADIR_READ			0x00000002
#define FSF_DATADIR_CMND			0x00000004
#define FSF_DATADIR_DIF_WRITE_INSERT		0x00000009
#define FSF_DATADIR_DIF_READ_STRIP		0x0000000a
#define FSF_DATADIR_DIF_WRITE_CONVERT		0x0000000b
#define FSF_DATADIR_DIF_READ_CONVERT		0X0000000c

/* data protection control flags */
#define FSF_APP_TAG_CHECK_ENABLE		0x10

/* fc service class */
#define FSF_CLASS_3				0x00000003

/* logging space behind QTCB */
#define FSF_QTCB_LOG_SIZE			1024

/* channel features */
#define FSF_FEATURE_NOTIFICATION_LOST		0x00000008
#define FSF_FEATURE_HBAAPI_MANAGEMENT           0x00000010
#define FSF_FEATURE_ELS_CT_CHAINED_SBALS	0x00000020
#define FSF_FEATURE_UPDATE_ALERT		0x00000100
#define FSF_FEATURE_MEASUREMENT_DATA		0x00000200
#define FSF_FEATURE_DIF_PROT_TYPE1		0x00010000
#define FSF_FEATURE_DIX_PROT_TCPIP		0x00020000

/* host connection features */
#define FSF_FEATURE_NPIV_MODE			0x00000001

/* option */
#define FSF_OPEN_LUN_SUPPRESS_BOXING		0x00000001

struct fsf_queue_designator {
	u8  cssid;
	u8  chpid;
	u8  hla;
	u8  ua;
	u32 res1;
} __attribute__ ((packed));

struct fsf_bit_error_payload {
	u32 res1;
	u32 link_failure_error_count;
	u32 loss_of_sync_error_count;
	u32 loss_of_signal_error_count;
	u32 primitive_sequence_error_count;
	u32 invalid_transmission_word_error_count;
	u32 crc_error_count;
	u32 primitive_sequence_event_timeout_count;
	u32 elastic_buffer_overrun_error_count;
	u32 fcal_arbitration_timeout_count;
	u32 advertised_receive_b2b_credit;
	u32 current_receive_b2b_credit;
	u32 advertised_transmit_b2b_credit;
	u32 current_transmit_b2b_credit;
} __attribute__ ((packed));

struct fsf_link_down_info {
	u32 error_code;
	u32 res1;
	u8 res2[2];
	u8 primary_status;
	u8 ioerr_code;
	u8 action_code;
	u8 reason_code;
	u8 explanation_code;
	u8 vendor_specific_code;
} __attribute__ ((packed));

struct fsf_status_read_buffer {
	u32 status_type;
	u32 status_subtype;
	u32 length;
	u32 res1;
	struct fsf_queue_designator queue_designator;
	u8 res2;
	u8 d_id[3];
	u32 class;
	u64 fcp_lun;
	u8  res3[24];
	union {
		u8  data[FSF_STATUS_READ_PAYLOAD_SIZE];
		u32 word[FSF_STATUS_READ_PAYLOAD_SIZE/sizeof(u32)];
		struct fsf_link_down_info link_down_info;
		struct fsf_bit_error_payload bit_error;
	} payload;
} __attribute__ ((packed));

struct fsf_qual_version_error {
	u32 fsf_version;
	u32 res1[3];
} __attribute__ ((packed));

struct fsf_qual_sequence_error {
	u32 exp_req_seq_no;
	u32 res1[3];
} __attribute__ ((packed));

struct fsf_qual_latency_info {
	u32 channel_lat;
	u32 fabric_lat;
	u8 res1[8];
} __attribute__ ((packed));

union fsf_prot_status_qual {
	u32 word[FSF_PROT_STATUS_QUAL_SIZE / sizeof(u32)];
	u64 doubleword[FSF_PROT_STATUS_QUAL_SIZE / sizeof(u64)];
	struct fsf_qual_version_error   version_error;
	struct fsf_qual_sequence_error  sequence_error;
	struct fsf_link_down_info link_down_info;
	struct fsf_qual_latency_info latency_info;
} __attribute__ ((packed));

struct fsf_qtcb_prefix {
	u64 req_id;
	u32 qtcb_version;
	u32 ulp_info;
	u32 qtcb_type;
	u32 req_seq_no;
	u32 prot_status;
	union fsf_prot_status_qual prot_status_qual;
	u8  res1[20];
} __attribute__ ((packed));

struct fsf_statistics_info {
	u64 input_req;
	u64 output_req;
	u64 control_req;
	u64 input_mb;
	u64 output_mb;
	u64 seconds_act;
} __attribute__ ((packed));

union fsf_status_qual {
	u8  byte[FSF_STATUS_QUALIFIER_SIZE];
	u16 halfword[FSF_STATUS_QUALIFIER_SIZE / sizeof (u16)];
	u32 word[FSF_STATUS_QUALIFIER_SIZE / sizeof (u32)];
	u64 doubleword[FSF_STATUS_QUALIFIER_SIZE / sizeof(u64)];
	struct fsf_queue_designator fsf_queue_designator;
	struct fsf_link_down_info link_down_info;
} __attribute__ ((packed));

struct fsf_qtcb_header {
	u64 req_handle;
	u32 fsf_command;
	u32 res1;
	u32 port_handle;
	u32 lun_handle;
	u32 res2;
	u32 fsf_status;
	union fsf_status_qual fsf_status_qual;
	u8  res3[28];
	u16 log_start;
	u16 log_length;
	u8  res4[16];
} __attribute__ ((packed));

#define FSF_PLOGI_MIN_LEN	112

#define FSF_FCP_CMND_SIZE	288
#define FSF_FCP_RSP_SIZE	128

struct fsf_qtcb_bottom_io {
	u32 data_direction;
	u32 service_class;
	u8  res1;
	u8  data_prot_flags;
	u16 app_tag_value;
	u32 ref_tag_value;
	u32 fcp_cmnd_length;
	u32 data_block_length;
	u32 prot_data_length;
	u8  res2[4];
	u8  fcp_cmnd[FSF_FCP_CMND_SIZE];
	u8  fcp_rsp[FSF_FCP_RSP_SIZE];
	u8  res3[64];
} __attribute__ ((packed));

struct fsf_qtcb_bottom_support {
	u32 operation_subtype;
	u8  res1[13];
	u8 d_id[3];
	u32 option;
	u64 fcp_lun;
	u64 res2;
	u64 req_handle;
	u32 service_class;
	u8  res3[3];
	u8  timeout;
        u32 lun_access_info;
        u8  res4[180];
	u32 els1_length;
	u32 els2_length;
	u32 req_buf_length;
	u32 resp_buf_length;
	u8  els[256];
} __attribute__ ((packed));

#define ZFCP_FSF_TIMER_INT_MASK	0x3FFF

struct fsf_qtcb_bottom_config {
	u32 lic_version;
	u32 feature_selection;
	u32 high_qtcb_version;
	u32 low_qtcb_version;
	u32 max_qtcb_size;
	u32 max_data_transfer_size;
	u32 adapter_features;
	u32 connection_features;
	u32 fc_topology;
	u32 fc_link_speed;
	u32 adapter_type;
	u8 res0;
	u8 peer_d_id[3];
	u16 status_read_buf_num;
	u16 timer_interval;
	u8 res2[9];
	u8 s_id[3];
	u8 nport_serv_param[128];
	u8 res3[8];
	u32 adapter_ports;
	u32 hardware_version;
	u8 serial_number[32];
	u8 plogi_payload[112];
	struct fsf_statistics_info stat_info;
	u8 res4[112];
} __attribute__ ((packed));

struct fsf_qtcb_bottom_port {
	u64 wwpn;
	u32 fc_port_id;
	u32 port_type;
	u32 port_state;
	u32 class_of_service;	/* should be 0x00000006 for class 2 and 3 */
	u8 supported_fc4_types[32]; /* should be 0x00000100 for scsi fcp */
	u8 active_fc4_types[32];
	u32 supported_speed;	/* 0x0001 for 1 GBit/s or 0x0002 for 2 GBit/s */
	u32 maximum_frame_size;	/* fixed value of 2112 */
	u64 seconds_since_last_reset;
	u64 tx_frames;
	u64 tx_words;
	u64 rx_frames;
	u64 rx_words;
	u64 lip;		/* 0 */
	u64 nos;		/* currently 0 */
	u64 error_frames;	/* currently 0 */
	u64 dumped_frames;	/* currently 0 */
	u64 link_failure;
	u64 loss_of_sync;
	u64 loss_of_signal;
	u64 psp_error_counts;
	u64 invalid_tx_words;
	u64 invalid_crcs;
	u64 input_requests;
	u64 output_requests;
	u64 control_requests;
	u64 input_mb;		/* where 1 MByte == 1.000.000 Bytes */
	u64 output_mb;		/* where 1 MByte == 1.000.000 Bytes */
	u8 cp_util;
	u8 cb_util;
	u8 a_util;
	u8 res2[253];
} __attribute__ ((packed));

union fsf_qtcb_bottom {
	struct fsf_qtcb_bottom_io      io;
	struct fsf_qtcb_bottom_support support;
	struct fsf_qtcb_bottom_config  config;
	struct fsf_qtcb_bottom_port port;
};

struct fsf_qtcb {
	struct fsf_qtcb_prefix prefix;
	struct fsf_qtcb_header header;
	union  fsf_qtcb_bottom bottom;
	u8 log[FSF_QTCB_LOG_SIZE];
} __attribute__ ((packed));

struct zfcp_blk_drv_data {
#define ZFCP_BLK_DRV_DATA_MAGIC			0x1
	u32 magic;
#define ZFCP_BLK_LAT_VALID			0x1
#define ZFCP_BLK_REQ_ERROR			0x2
	u16 flags;
	u8 inb_usage;
	u8 outb_usage;
	u64 channel_lat;
	u64 fabric_lat;
} __attribute__ ((packed));

/**
 * struct zfcp_fsf_ct_els - zfcp data for ct or els request
 * @req: scatter-gather list for request
 * @resp: scatter-gather list for response
 * @handler: handler function (called for response to the request)
 * @handler_data: data passed to handler function
 * @port: Optional pointer to port for zfcp internal ELS (only test link ADISC)
 * @status: used to pass error status to calling function
 * @d_id: Destination ID of either open WKA port for CT or of D_ID for ELS
 */
struct zfcp_fsf_ct_els {
	struct scatterlist *req;
	struct scatterlist *resp;
	void (*handler)(void *);
	void *handler_data;
	struct zfcp_port *port;
	int status;
	u32 d_id;
};

#endif				/* FSF_H */
Commit	Line	Data
41fa2ada	1	/*
553448f6	2	* zfcp device driver
1da177e4	3	*
553448f6	4	* Interface to the FSF support functions.
41fa2ada	5	*
771bf035	6	* Copyright IBM Corp. 2002, 2015
1da177e4 LT	7	*/
	8
	9	#ifndef FSF_H
	10	#define FSF_H
	11
45633fdc	12	#include <linux/pfn.h>
d46f384a	13	#include <linux/scatterlist.h>
800c0cad	14	#include <scsi/libfc.h>
45633fdc	15
06506d00	16	#define FSF_QTCB_CURRENT_VERSION 0x00000001
1da177e4 LT	17
	18	/* FSF commands */
	19	#define FSF_QTCB_FCP_CMND 0x00000001
	20	#define FSF_QTCB_ABORT_FCP_CMND 0x00000002
	21	#define FSF_QTCB_OPEN_PORT_WITH_DID 0x00000005
	22	#define FSF_QTCB_OPEN_LUN 0x00000006
	23	#define FSF_QTCB_CLOSE_LUN 0x00000007
	24	#define FSF_QTCB_CLOSE_PORT 0x00000008
	25	#define FSF_QTCB_CLOSE_PHYSICAL_PORT 0x00000009
	26	#define FSF_QTCB_SEND_ELS 0x0000000B
	27	#define FSF_QTCB_SEND_GENERIC 0x0000000C
	28	#define FSF_QTCB_EXCHANGE_CONFIG_DATA 0x0000000D
	29	#define FSF_QTCB_EXCHANGE_PORT_DATA 0x0000000E
	30	#define FSF_QTCB_DOWNLOAD_CONTROL_FILE 0x00000012
	31	#define FSF_QTCB_UPLOAD_CONTROL_FILE 0x00000013
	32
	33	/* FSF QTCB types */
	34	#define FSF_IO_COMMAND 0x00000001
	35	#define FSF_SUPPORT_COMMAND 0x00000002
	36	#define FSF_CONFIG_COMMAND 0x00000003
	37	#define FSF_PORT_COMMAND 0x00000004
	38
06506d00	39	/* FSF protocol states */
1da177e4 LT	40	#define FSF_PROT_GOOD 0x00000001
	41	#define FSF_PROT_QTCB_VERSION_ERROR 0x00000010
	42	#define FSF_PROT_SEQ_NUMB_ERROR 0x00000020
	43	#define FSF_PROT_UNSUPP_QTCB_TYPE 0x00000040
	44	#define FSF_PROT_HOST_CONNECTION_INITIALIZING 0x00000080
	45	#define FSF_PROT_FSF_STATUS_PRESENTED 0x00000100
	46	#define FSF_PROT_DUPLICATE_REQUEST_ID 0x00000200
	47	#define FSF_PROT_LINK_DOWN 0x00000400
	48	#define FSF_PROT_REEST_QUEUE 0x00000800
	49	#define FSF_PROT_ERROR_STATE 0x01000000
	50
06506d00	51	/* FSF states */
1da177e4 LT	52	#define FSF_GOOD 0x00000000
	53	#define FSF_PORT_ALREADY_OPEN 0x00000001
	54	#define FSF_LUN_ALREADY_OPEN 0x00000002
	55	#define FSF_PORT_HANDLE_NOT_VALID 0x00000003
	56	#define FSF_LUN_HANDLE_NOT_VALID 0x00000004
	57	#define FSF_HANDLE_MISMATCH 0x00000005
	58	#define FSF_SERVICE_CLASS_NOT_SUPPORTED 0x00000006
	59	#define FSF_FCPLUN_NOT_VALID 0x00000009
1da177e4 LT	60	#define FSF_LUN_SHARING_VIOLATION 0x00000012
	61	#define FSF_FCP_COMMAND_DOES_NOT_EXIST 0x00000022
	62	#define FSF_DIRECTION_INDICATOR_NOT_VALID 0x00000030
	63	#define FSF_CMND_LENGTH_NOT_VALID 0x00000033
	64	#define FSF_MAXIMUM_NUMBER_OF_PORTS_EXCEEDED 0x00000040
	65	#define FSF_MAXIMUM_NUMBER_OF_LUNS_EXCEEDED 0x00000041
	66	#define FSF_ELS_COMMAND_REJECTED 0x00000050
	67	#define FSF_GENERIC_COMMAND_REJECTED 0x00000051
1da177e4 LT	68	#define FSF_PORT_BOXED 0x00000059
	69	#define FSF_LUN_BOXED 0x0000005A
	70	#define FSF_EXCHANGE_CONFIG_DATA_INCOMPLETE 0x0000005B
	71	#define FSF_PAYLOAD_SIZE_MISMATCH 0x00000060
	72	#define FSF_REQUEST_SIZE_TOO_LARGE 0x00000061
	73	#define FSF_RESPONSE_SIZE_TOO_LARGE 0x00000062
	74	#define FSF_SBAL_MISMATCH 0x00000063
ef3eb71d FB	75	#define FSF_INCONSISTENT_PROT_DATA 0x00000070
	76	#define FSF_INVALID_PROT_PARM 0x00000071
	77	#define FSF_BLOCK_GUARD_CHECK_FAILURE 0x00000081
	78	#define FSF_APP_TAG_CHECK_FAILURE 0x00000082
	79	#define FSF_REF_TAG_CHECK_FAILURE 0x00000083
1da177e4	80	#define FSF_ADAPTER_STATUS_AVAILABLE 0x000000AD
1da177e4 LT	81	#define FSF_UNKNOWN_COMMAND 0x000000E2
	82	#define FSF_UNKNOWN_OP_SUBTYPE 0x000000E3
	83	#define FSF_INVALID_COMMAND_OPTION 0x000000E5
1da177e4	84
8a36e453	85	#define FSF_PROT_STATUS_QUAL_SIZE 16
1da177e4 LT	86	#define FSF_STATUS_QUALIFIER_SIZE 16
	87
	88	/* FSF status qualifier, recommendations */
	89	#define FSF_SQ_NO_RECOM 0x00
	90	#define FSF_SQ_FCP_RSP_AVAILABLE 0x01
	91	#define FSF_SQ_RETRY_IF_POSSIBLE 0x02
	92	#define FSF_SQ_ULP_DEPENDENT_ERP_REQUIRED 0x03
	93	#define FSF_SQ_INVOKE_LINK_TEST_PROCEDURE 0x04
1da177e4 LT	94	#define FSF_SQ_COMMAND_ABORTED 0x06
	95	#define FSF_SQ_NO_RETRY_POSSIBLE 0x07
	96
1da177e4	97	/* FSF status qualifier (most significant 4 bytes), local link down */
aef4a983 MS	98	#define FSF_PSQ_LINK_NO_LIGHT 0x00000004
	99	#define FSF_PSQ_LINK_WRAP_PLUG 0x00000008
	100	#define FSF_PSQ_LINK_NO_FCP 0x00000010
	101	#define FSF_PSQ_LINK_FIRMWARE_UPDATE 0x00000020
	102	#define FSF_PSQ_LINK_INVALID_WWPN 0x00000100
	103	#define FSF_PSQ_LINK_NO_NPIV_SUPPORT 0x00000200
	104	#define FSF_PSQ_LINK_NO_FCP_RESOURCES 0x00000400
	105	#define FSF_PSQ_LINK_NO_FABRIC_RESOURCES 0x00000800
	106	#define FSF_PSQ_LINK_FABRIC_LOGIN_UNABLE 0x00001000
	107	#define FSF_PSQ_LINK_WWPN_ASSIGNMENT_CORRUPTED 0x00002000
	108	#define FSF_PSQ_LINK_MODE_TABLE_CURRUPTED 0x00004000
	109	#define FSF_PSQ_LINK_NO_WWPN_ASSIGNMENT 0x00008000
1da177e4 LT	110
	111	/* payload size in status read buffer */
	112	#define FSF_STATUS_READ_PAYLOAD_SIZE 4032
	113
	114	/* number of status read buffers that should be sent by ULP */
	115	#define FSF_STATUS_READS_RECOM 16
	116
	117	/* status types in status read buffer */
	118	#define FSF_STATUS_READ_PORT_CLOSED 0x00000001
	119	#define FSF_STATUS_READ_INCOMING_ELS 0x00000002
	120	#define FSF_STATUS_READ_SENSE_DATA_AVAIL 0x00000003
	121	#define FSF_STATUS_READ_BIT_ERROR_THRESHOLD 0x00000004
aef4a983	122	#define FSF_STATUS_READ_LINK_DOWN 0x00000005
1da177e4	123	#define FSF_STATUS_READ_LINK_UP 0x00000006
9eb69aff	124	#define FSF_STATUS_READ_NOTIFICATION_LOST 0x00000009
aef4a983	125	#define FSF_STATUS_READ_FEATURE_UPDATE_ALERT 0x0000000C
1da177e4	126
aef4a983 MS	127	/* status subtypes for link down */
	128	#define FSF_STATUS_READ_SUB_NO_PHYSICAL_LINK 0x00000000
	129	#define FSF_STATUS_READ_SUB_FDISC_FAILED 0x00000001
	130	#define FSF_STATUS_READ_SUB_FIRMWARE_UPDATE 0x00000002
	131
9eb69aff MS	132	/* status subtypes for unsolicited status notification lost */
9eb69aff MS	133	#define FSF_STATUS_READ_SUB_INCOMING_ELS 0x00000001
1da177e4 LT	134
1da177e4 LT	135	/* topologie that is detected by the adapter */
1da177e4 LT	136	#define FSF_TOPO_P2P 0x00000001
	137	#define FSF_TOPO_FABRIC 0x00000002
	138	#define FSF_TOPO_AL 0x00000003
1da177e4 LT	139
	140	/* data direction for FCP commands */
	141	#define FSF_DATADIR_WRITE 0x00000001
	142	#define FSF_DATADIR_READ 0x00000002
1da177e4	143	#define FSF_DATADIR_CMND 0x00000004
ef3eb71d FB	144	#define FSF_DATADIR_DIF_WRITE_INSERT 0x00000009
	145	#define FSF_DATADIR_DIF_READ_STRIP 0x0000000a
	146	#define FSF_DATADIR_DIF_WRITE_CONVERT 0x0000000b
	147	#define FSF_DATADIR_DIF_READ_CONVERT 0X0000000c
	148
	149	/* data protection control flags */
	150	#define FSF_APP_TAG_CHECK_ENABLE 0x10
1da177e4 LT	151
1da177e4 LT	152	/* fc service class */
1da177e4 LT	153	#define FSF_CLASS_3 0x00000003
1da177e4 LT	154
1da177e4 LT	155	/* logging space behind QTCB */
	156	#define FSF_QTCB_LOG_SIZE 1024
	157
	158	/* channel features */
9eb69aff	159	#define FSF_FEATURE_NOTIFICATION_LOST 0x00000008
1da177e4	160	#define FSF_FEATURE_HBAAPI_MANAGEMENT 0x00000010
39eb7e9a	161	#define FSF_FEATURE_ELS_CT_CHAINED_SBALS 0x00000020
aef4a983	162	#define FSF_FEATURE_UPDATE_ALERT 0x00000100
6d9d63b9	163	#define FSF_FEATURE_MEASUREMENT_DATA 0x00000200
ef3eb71d FB	164	#define FSF_FEATURE_DIF_PROT_TYPE1 0x00010000
ef3eb71d FB	165	#define FSF_FEATURE_DIX_PROT_TCPIP 0x00020000
aef4a983 MS	166
	167	/* host connection features */
	168	#define FSF_FEATURE_NPIV_MODE 0x00000001
1da177e4 LT	169
	170	/* option */
	171	#define FSF_OPEN_LUN_SUPPRESS_BOXING 0x00000001
1da177e4	172
1da177e4 LT	173	struct fsf_queue_designator {
	174	u8 cssid;
	175	u8 chpid;
	176	u8 hla;
	177	u8 ua;
	178	u32 res1;
	179	} __attribute__ ((packed));
	180
1da177e4 LT	181	struct fsf_bit_error_payload {
	182	u32 res1;
	183	u32 link_failure_error_count;
	184	u32 loss_of_sync_error_count;
	185	u32 loss_of_signal_error_count;
	186	u32 primitive_sequence_error_count;
	187	u32 invalid_transmission_word_error_count;
	188	u32 crc_error_count;
	189	u32 primitive_sequence_event_timeout_count;
	190	u32 elastic_buffer_overrun_error_count;
	191	u32 fcal_arbitration_timeout_count;
	192	u32 advertised_receive_b2b_credit;
	193	u32 current_receive_b2b_credit;
	194	u32 advertised_transmit_b2b_credit;
	195	u32 current_transmit_b2b_credit;
	196	} __attribute__ ((packed));
	197
c41f8cbd SS	198	struct fsf_link_down_info {
	199	u32 error_code;
	200	u32 res1;
	201	u8 res2[2];
	202	u8 primary_status;
	203	u8 ioerr_code;
	204	u8 action_code;
	205	u8 reason_code;
	206	u8 explanation_code;
	207	u8 vendor_specific_code;
	208	} __attribute__ ((packed));
	209
1da177e4 LT	210	struct fsf_status_read_buffer {
	211	u32 status_type;
	212	u32 status_subtype;
	213	u32 length;
	214	u32 res1;
	215	struct fsf_queue_designator queue_designator;
800c0cad CS	216	u8 res2;
800c0cad CS	217	u8 d_id[3];
1da177e4 LT	218	u32 class;
	219	u64 fcp_lun;
	220	u8 res3[24];
c41f8cbd SS	221	union {
	222	u8 data[FSF_STATUS_READ_PAYLOAD_SIZE];
	223	u32 word[FSF_STATUS_READ_PAYLOAD_SIZE/sizeof(u32)];
	224	struct fsf_link_down_info link_down_info;
	225	struct fsf_bit_error_payload bit_error;
	226	} payload;
1da177e4 LT	227	} __attribute__ ((packed));
	228
	229	struct fsf_qual_version_error {
	230	u32 fsf_version;
	231	u32 res1[3];
	232	} __attribute__ ((packed));
	233
	234	struct fsf_qual_sequence_error {
	235	u32 exp_req_seq_no;
	236	u32 res1[3];
	237	} __attribute__ ((packed));
	238
c9615858 CS	239	struct fsf_qual_latency_info {
	240	u32 channel_lat;
	241	u32 fabric_lat;
	242	u8 res1[8];
	243	} __attribute__ ((packed));
	244
1da177e4	245	union fsf_prot_status_qual {
553448f6	246	u32 word[FSF_PROT_STATUS_QUAL_SIZE / sizeof(u32)];
8a36e453	247	u64 doubleword[FSF_PROT_STATUS_QUAL_SIZE / sizeof(u64)];
1da177e4 LT	248	struct fsf_qual_version_error version_error;
1da177e4 LT	249	struct fsf_qual_sequence_error sequence_error;
aef4a983	250	struct fsf_link_down_info link_down_info;
c9615858	251	struct fsf_qual_latency_info latency_info;
1da177e4 LT	252	} __attribute__ ((packed));
	253
	254	struct fsf_qtcb_prefix {
	255	u64 req_id;
	256	u32 qtcb_version;
	257	u32 ulp_info;
	258	u32 qtcb_type;
	259	u32 req_seq_no;
	260	u32 prot_status;
	261	union fsf_prot_status_qual prot_status_qual;
	262	u8 res1[20];
	263	} __attribute__ ((packed));
	264
6d9d63b9 SS	265	struct fsf_statistics_info {
	266	u64 input_req;
	267	u64 output_req;
	268	u64 control_req;
	269	u64 input_mb;
	270	u64 output_mb;
	271	u64 seconds_act;
	272	} __attribute__ ((packed));
	273
1da177e4 LT	274	union fsf_status_qual {
	275	u8 byte[FSF_STATUS_QUALIFIER_SIZE];
	276	u16 halfword[FSF_STATUS_QUALIFIER_SIZE / sizeof (u16)];
	277	u32 word[FSF_STATUS_QUALIFIER_SIZE / sizeof (u32)];
8a36e453	278	u64 doubleword[FSF_STATUS_QUALIFIER_SIZE / sizeof(u64)];
1da177e4	279	struct fsf_queue_designator fsf_queue_designator;
aef4a983	280	struct fsf_link_down_info link_down_info;
1da177e4 LT	281	} __attribute__ ((packed));
	282
	283	struct fsf_qtcb_header {
	284	u64 req_handle;
	285	u32 fsf_command;
	286	u32 res1;
	287	u32 port_handle;
	288	u32 lun_handle;
	289	u32 res2;
	290	u32 fsf_status;
	291	union fsf_status_qual fsf_status_qual;
	292	u8 res3[28];
	293	u16 log_start;
	294	u16 log_length;
	295	u8 res4[16];
	296	} __attribute__ ((packed));
	297
39eb7e9a	298	#define FSF_PLOGI_MIN_LEN 112
1da177e4 LT	299
	300	#define FSF_FCP_CMND_SIZE 288
	301	#define FSF_FCP_RSP_SIZE 128
	302
	303	struct fsf_qtcb_bottom_io {
	304	u32 data_direction;
	305	u32 service_class;
ef3eb71d FB	306	u8 res1;
	307	u8 data_prot_flags;
	308	u16 app_tag_value;
	309	u32 ref_tag_value;
1da177e4	310	u32 fcp_cmnd_length;
ef3eb71d FB	311	u32 data_block_length;
	312	u32 prot_data_length;
	313	u8 res2[4];
1da177e4 LT	314	u8 fcp_cmnd[FSF_FCP_CMND_SIZE];
	315	u8 fcp_rsp[FSF_FCP_RSP_SIZE];
	316	u8 res3[64];
	317	} __attribute__ ((packed));
	318
	319	struct fsf_qtcb_bottom_support {
	320	u32 operation_subtype;
800c0cad CS	321	u8 res1[13];
800c0cad CS	322	u8 d_id[3];
1da177e4 LT	323	u32 option;
	324	u64 fcp_lun;
	325	u64 res2;
	326	u64 req_handle;
	327	u32 service_class;
	328	u8 res3[3];
	329	u8 timeout;
	330	u32 lun_access_info;
	331	u8 res4[180];
	332	u32 els1_length;
	333	u32 els2_length;
	334	u32 req_buf_length;
	335	u32 resp_buf_length;
	336	u8 els[256];
	337	} __attribute__ ((packed));
	338
faf4cd85 CS	339	#define ZFCP_FSF_TIMER_INT_MASK 0x3FFF
faf4cd85 CS	340
1da177e4 LT	341	struct fsf_qtcb_bottom_config {
	342	u32 lic_version;
	343	u32 feature_selection;
	344	u32 high_qtcb_version;
	345	u32 low_qtcb_version;
	346	u32 max_qtcb_size;
	347	u32 max_data_transfer_size;
aef4a983 MS	348	u32 adapter_features;
aef4a983 MS	349	u32 connection_features;
1da177e4 LT	350	u32 fc_topology;
	351	u32 fc_link_speed;
	352	u32 adapter_type;
800c0cad CS	353	u8 res0;
800c0cad CS	354	u8 peer_d_id[3];
64deb6ef	355	u16 status_read_buf_num;
c9615858	356	u16 timer_interval;
800c0cad CS	357	u8 res2[9];
800c0cad CS	358	u8 s_id[3];
9d05ce2c	359	u8 nport_serv_param[128];
1da177e4 LT	360	u8 res3[8];
	361	u32 adapter_ports;
	362	u32 hardware_version;
	363	u8 serial_number[32];
9d05ce2c	364	u8 plogi_payload[112];
6d9d63b9 SS	365	struct fsf_statistics_info stat_info;
6d9d63b9 SS	366	u8 res4[112];
1da177e4 LT	367	} __attribute__ ((packed));
	368
	369	struct fsf_qtcb_bottom_port {
aef4a983	370	u64 wwpn;
1da177e4 LT	371	u32 fc_port_id;
	372	u32 port_type;
	373	u32 port_state;
	374	u32 class_of_service; /* should be 0x00000006 for class 2 and 3 */
	375	u8 supported_fc4_types[32]; /* should be 0x00000100 for scsi fcp */
	376	u8 active_fc4_types[32];
	377	u32 supported_speed; /* 0x0001 for 1 GBit/s or 0x0002 for 2 GBit/s */
	378	u32 maximum_frame_size; /* fixed value of 2112 */
	379	u64 seconds_since_last_reset;
	380	u64 tx_frames;
	381	u64 tx_words;
	382	u64 rx_frames;
	383	u64 rx_words;
	384	u64 lip; /* 0 */
	385	u64 nos; /* currently 0 */
	386	u64 error_frames; /* currently 0 */
	387	u64 dumped_frames; /* currently 0 */
	388	u64 link_failure;
	389	u64 loss_of_sync;
	390	u64 loss_of_signal;
	391	u64 psp_error_counts;
	392	u64 invalid_tx_words;
	393	u64 invalid_crcs;
	394	u64 input_requests;
	395	u64 output_requests;
	396	u64 control_requests;
	397	u64 input_mb; /* where 1 MByte == 1.000.000 Bytes */
	398	u64 output_mb; /* where 1 MByte == 1.000.000 Bytes */
6d9d63b9 SS	399	u8 cp_util;
	400	u8 cb_util;
	401	u8 a_util;
	402	u8 res2[253];
1da177e4 LT	403	} __attribute__ ((packed));
	404
	405	union fsf_qtcb_bottom {
	406	struct fsf_qtcb_bottom_io io;
	407	struct fsf_qtcb_bottom_support support;
	408	struct fsf_qtcb_bottom_config config;
	409	struct fsf_qtcb_bottom_port port;
	410	};
	411
	412	struct fsf_qtcb {
	413	struct fsf_qtcb_prefix prefix;
	414	struct fsf_qtcb_header header;
	415	union fsf_qtcb_bottom bottom;
	416	u8 log[FSF_QTCB_LOG_SIZE];
	417	} __attribute__ ((packed));
	418
0997f1c5 SR	419	struct zfcp_blk_drv_data {
	420	#define ZFCP_BLK_DRV_DATA_MAGIC 0x1
	421	u32 magic;
	422	#define ZFCP_BLK_LAT_VALID 0x1
	423	#define ZFCP_BLK_REQ_ERROR 0x2
	424	u16 flags;
	425	u8 inb_usage;
	426	u8 outb_usage;
	427	u64 channel_lat;
	428	u64 fabric_lat;
	429	} __attribute__ ((packed));
	430
7c7dc196 CS	431	/**
	432	* struct zfcp_fsf_ct_els - zfcp data for ct or els request
	433	* @req: scatter-gather list for request
	434	* @resp: scatter-gather list for response
	435	* @handler: handler function (called for response to the request)
	436	* @handler_data: data passed to handler function
	437	* @port: Optional pointer to port for zfcp internal ELS (only test link ADISC)
	438	* @status: used to pass error status to calling function
771bf035	439	* @d_id: Destination ID of either open WKA port for CT or of D_ID for ELS
7c7dc196 CS	440	*/
	441	struct zfcp_fsf_ct_els {
	442	struct scatterlist *req;
	443	struct scatterlist *resp;
	444	void (handler)(void );
	445	void *handler_data;
	446	struct zfcp_port *port;
	447	int status;
771bf035	448	u32 d_id;
7c7dc196 CS	449	};
7c7dc196 CS	450
1da177e4	451	#endif /* FSF_H */