[mirror_ubuntu-bionic-kernel.git] / drivers / s390 / scsi / zfcp_fsf.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * zfcp device driver
 *
 * Interface to the FSF support functions.
 *
 * Copyright IBM Corp. 2002, 2017
 */

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