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

/*
 * This file is part of the zfcp device driver for
 * FCP adapters for IBM System z9 and zSeries.
 *
 * (C) Copyright IBM Corp. 2002, 2006
 *
 * 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, 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., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#ifndef FSF_H
#define FSF_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 control file upload/download operations' subtype and options */
#define FSF_CFDC_OPERATION_SUBTYPE		0x00020001
#define FSF_CFDC_OPTION_NORMAL_MODE		0x00000000
#define FSF_CFDC_OPTION_FORCE			0x00000001
#define FSF_CFDC_OPTION_FULL_ACCESS		0x00000002
#define FSF_CFDC_OPTION_RESTRICTED_ACCESS	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_ACCESS_DENIED			0x00000010
#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_OPERATION_PARTIALLY_SUCCESSFUL	0x00000052
#define FSF_AUTHORIZATION_FAILURE		0x00000053
#define FSF_CFDC_ERROR_DETECTED			0x00000054
#define FSF_CONTROL_FILE_UPDATE_ERROR		0x00000055
#define FSF_CONTROL_FILE_TOO_LARGE		0x00000056
#define FSF_ACCESS_CONFLICT_DETECTED		0x00000057
#define FSF_CONFLICTS_OVERRULED			0x00000058
#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_OPEN_PORT_WITHOUT_PRLI		0x00000064
#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_ERROR                             0x000000FF  */

#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_ULP_PROGRAMMING_ERROR		0x05
#define FSF_SQ_COMMAND_ABORTED			0x06
#define FSF_SQ_NO_RETRY_POSSIBLE		0x07

/* FSF status qualifier for CFDC commands */
#define FSF_SQ_CFDC_HARDENED_ON_SE		0x00000000
#define FSF_SQ_CFDC_COULD_NOT_HARDEN_ON_SE	0x00000001
#define FSF_SQ_CFDC_COULD_NOT_HARDEN_ON_SE2	0x00000002
/* CFDC subtable codes */
#define FSF_SQ_CFDC_SUBTABLE_OS			0x0001
#define FSF_SQ_CFDC_SUBTABLE_PORT_WWPN		0x0002
#define FSF_SQ_CFDC_SUBTABLE_PORT_DID		0x0003
#define FSF_SQ_CFDC_SUBTABLE_LUN		0x0004

/* 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_CFDC_UPDATED		0x0000000A
#define FSF_STATUS_READ_CFDC_HARDENED		0x0000000B
#define FSF_STATUS_READ_FEATURE_UPDATE_ALERT	0x0000000C

/* status subtypes in status read buffer */
#define FSF_STATUS_READ_SUB_CLOSE_PHYS_PORT	0x00000001
#define FSF_STATUS_READ_SUB_ERROR_PORT		0x00000002

/* 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
#define FSF_STATUS_READ_SUB_SENSE_DATA		0x00000002
#define FSF_STATUS_READ_SUB_LINK_STATUS		0x00000004
#define FSF_STATUS_READ_SUB_PORT_CLOSED		0x00000008
#define FSF_STATUS_READ_SUB_BIT_ERROR_THRESHOLD	0x00000010
#define FSF_STATUS_READ_SUB_ACT_UPDATED		0x00000020
#define FSF_STATUS_READ_SUB_ACT_HARDENED	0x00000040
#define FSF_STATUS_READ_SUB_FEATURE_UPDATE_ALERT 0x00000080

/* status subtypes for CFDC */
#define FSF_STATUS_READ_SUB_CFDC_HARDENED_ON_SE	0x00000002
#define FSF_STATUS_READ_SUB_CFDC_HARDENED_ON_SE2 0x0000000F

/* topologie that is detected by the adapter */
#define FSF_TOPO_ERROR				0x00000000
#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_READ_WRITE			0x00000003
#define FSF_DATADIR_CMND			0x00000004

/* fc service class */
#define FSF_CLASS_1				0x00000001
#define FSF_CLASS_2				0x00000002
#define FSF_CLASS_3				0x00000003

/* SBAL chaining */
#define FSF_MAX_SBALS_PER_REQ			36
#define FSF_MAX_SBALS_PER_ELS_REQ		2

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

/* channel features */
#define FSF_FEATURE_CFDC			0x00000002
#define FSF_FEATURE_LUN_SHARING			0x00000004
#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

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

/* option */
#define FSF_OPEN_LUN_SUPPRESS_BOXING		0x00000001
#define FSF_OPEN_LUN_REPLICATE_SENSE		0x00000002

/* adapter types */
#define FSF_ADAPTER_TYPE_FICON                  0x00000001
#define FSF_ADAPTER_TYPE_FICON_EXPRESS          0x00000002

/* port types */
#define FSF_HBA_PORTTYPE_UNKNOWN		0x00000001
#define FSF_HBA_PORTTYPE_NOTPRESENT		0x00000003
#define FSF_HBA_PORTTYPE_NPORT			0x00000005
#define FSF_HBA_PORTTYPE_PTP			0x00000021
/* following are not defined and used by FSF Spec
   but are additionally defined by FC-HBA */
#define FSF_HBA_PORTTYPE_OTHER			0x00000002
#define FSF_HBA_PORTTYPE_NOTPRESENT		0x00000003
#define FSF_HBA_PORTTYPE_NLPORT			0x00000006
#define FSF_HBA_PORTTYPE_FLPORT			0x00000007
#define FSF_HBA_PORTTYPE_FPORT			0x00000008
#define FSF_HBA_PORTTYPE_LPORT			0x00000020

/* port states */
#define FSF_HBA_PORTSTATE_UNKNOWN		0x00000001
#define FSF_HBA_PORTSTATE_ONLINE		0x00000002
#define FSF_HBA_PORTSTATE_OFFLINE		0x00000003
#define FSF_HBA_PORTSTATE_LINKDOWN		0x00000006
#define FSF_HBA_PORTSTATE_ERROR			0x00000007

/* IO states of adapter */
#define FSF_IOSTAT_NPORT_RJT			0x00000004
#define FSF_IOSTAT_FABRIC_RJT			0x00000005
#define FSF_IOSTAT_LS_RJT			0x00000009

/* open LUN access flags*/
#define FSF_UNIT_ACCESS_OPEN_LUN_ALLOWED	0x01000000
#define FSF_UNIT_ACCESS_EXCLUSIVE		0x02000000
#define FSF_UNIT_ACCESS_OUTBOUND_TRANSFER	0x10000000

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

struct fsf_port_closed_payload {
	struct fsf_queue_designator queue_designator;
	u32                         port_handle;
} __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_status_read_buffer {
	u32 status_type;
	u32 status_subtype;
	u32 length;
	u32 res1;
	struct fsf_queue_designator queue_designator;
	u32 d_id;
	u32 class;
	u64 fcp_lun;
	u8  res3[24];
	u8  payload[FSF_STATUS_READ_PAYLOAD_SIZE];
} __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_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));

union fsf_prot_status_qual {
	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;
} __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));

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));

struct fsf_nport_serv_param {
	u8  common_serv_param[16];
	u64 wwpn;
	u64 wwnn;
	u8  class1_serv_param[16];
	u8  class2_serv_param[16];
	u8  class3_serv_param[16];
	u8  class4_serv_param[16];
	u8  vendor_version_level[16];
} __attribute__ ((packed));

struct fsf_plogi {
	u32    code;
	struct fsf_nport_serv_param serv_param;
} __attribute__ ((packed));

#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[8];
	u32 fcp_cmnd_length;
	u8  res2[12];
	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[12];
	u32 d_id;
	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));

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;
	u32 peer_d_id;
	u8 res2[12];
	u32 s_id;
	struct fsf_nport_serv_param nport_serv_param;
	u8 reserved_nport_serv_param[16];
	u8 res3[8];
	u32 adapter_ports;
	u32 hardware_version;
	u8 serial_number[32];
	struct fsf_nport_serv_param plogi_payload;
	u8 res4[160];
} __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 res2[256];
} __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));

#endif				/* FSF_H */
Commit	Line	Data
41fa2ada	1	/*
4a9d2d8b AH	2	* This file is part of the zfcp device driver for
4a9d2d8b AH	3	* FCP adapters for IBM System z9 and zSeries.
1da177e4	4	*
4a9d2d8b	5	* (C) Copyright IBM Corp. 2002, 2006
41fa2ada SS	6	*
	7	* This program is free software; you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License as published by
	9	* the Free Software Foundation; either version 2, or (at your option)
	10	* any later version.
	11	*
	12	* This program is distributed in the hope that it will be useful,
	13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	* GNU General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU General Public License
	18	* along with this program; if not, write to the Free Software
	19	* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
1da177e4 LT	20	*/
	21
	22	#ifndef FSF_H
	23	#define FSF_H
	24
06506d00	25	#define FSF_QTCB_CURRENT_VERSION 0x00000001
1da177e4 LT	26
	27	/* FSF commands */
	28	#define FSF_QTCB_FCP_CMND 0x00000001
	29	#define FSF_QTCB_ABORT_FCP_CMND 0x00000002
	30	#define FSF_QTCB_OPEN_PORT_WITH_DID 0x00000005
	31	#define FSF_QTCB_OPEN_LUN 0x00000006
	32	#define FSF_QTCB_CLOSE_LUN 0x00000007
	33	#define FSF_QTCB_CLOSE_PORT 0x00000008
	34	#define FSF_QTCB_CLOSE_PHYSICAL_PORT 0x00000009
	35	#define FSF_QTCB_SEND_ELS 0x0000000B
	36	#define FSF_QTCB_SEND_GENERIC 0x0000000C
	37	#define FSF_QTCB_EXCHANGE_CONFIG_DATA 0x0000000D
	38	#define FSF_QTCB_EXCHANGE_PORT_DATA 0x0000000E
	39	#define FSF_QTCB_DOWNLOAD_CONTROL_FILE 0x00000012
	40	#define FSF_QTCB_UPLOAD_CONTROL_FILE 0x00000013
	41
	42	/* FSF QTCB types */
	43	#define FSF_IO_COMMAND 0x00000001
	44	#define FSF_SUPPORT_COMMAND 0x00000002
	45	#define FSF_CONFIG_COMMAND 0x00000003
	46	#define FSF_PORT_COMMAND 0x00000004
	47
	48	/* FSF control file upload/download operations' subtype and options */
	49	#define FSF_CFDC_OPERATION_SUBTYPE 0x00020001
	50	#define FSF_CFDC_OPTION_NORMAL_MODE 0x00000000
	51	#define FSF_CFDC_OPTION_FORCE 0x00000001
	52	#define FSF_CFDC_OPTION_FULL_ACCESS 0x00000002
	53	#define FSF_CFDC_OPTION_RESTRICTED_ACCESS 0x00000004
	54
06506d00	55	/* FSF protocol states */
1da177e4 LT	56	#define FSF_PROT_GOOD 0x00000001
	57	#define FSF_PROT_QTCB_VERSION_ERROR 0x00000010
	58	#define FSF_PROT_SEQ_NUMB_ERROR 0x00000020
	59	#define FSF_PROT_UNSUPP_QTCB_TYPE 0x00000040
	60	#define FSF_PROT_HOST_CONNECTION_INITIALIZING 0x00000080
	61	#define FSF_PROT_FSF_STATUS_PRESENTED 0x00000100
	62	#define FSF_PROT_DUPLICATE_REQUEST_ID 0x00000200
	63	#define FSF_PROT_LINK_DOWN 0x00000400
	64	#define FSF_PROT_REEST_QUEUE 0x00000800
	65	#define FSF_PROT_ERROR_STATE 0x01000000
	66
06506d00	67	/* FSF states */
1da177e4 LT	68	#define FSF_GOOD 0x00000000
	69	#define FSF_PORT_ALREADY_OPEN 0x00000001
	70	#define FSF_LUN_ALREADY_OPEN 0x00000002
	71	#define FSF_PORT_HANDLE_NOT_VALID 0x00000003
	72	#define FSF_LUN_HANDLE_NOT_VALID 0x00000004
	73	#define FSF_HANDLE_MISMATCH 0x00000005
	74	#define FSF_SERVICE_CLASS_NOT_SUPPORTED 0x00000006
	75	#define FSF_FCPLUN_NOT_VALID 0x00000009
	76	#define FSF_ACCESS_DENIED 0x00000010
	77	#define FSF_LUN_SHARING_VIOLATION 0x00000012
	78	#define FSF_FCP_COMMAND_DOES_NOT_EXIST 0x00000022
	79	#define FSF_DIRECTION_INDICATOR_NOT_VALID 0x00000030
	80	#define FSF_CMND_LENGTH_NOT_VALID 0x00000033
	81	#define FSF_MAXIMUM_NUMBER_OF_PORTS_EXCEEDED 0x00000040
	82	#define FSF_MAXIMUM_NUMBER_OF_LUNS_EXCEEDED 0x00000041
	83	#define FSF_ELS_COMMAND_REJECTED 0x00000050
	84	#define FSF_GENERIC_COMMAND_REJECTED 0x00000051
	85	#define FSF_OPERATION_PARTIALLY_SUCCESSFUL 0x00000052
	86	#define FSF_AUTHORIZATION_FAILURE 0x00000053
	87	#define FSF_CFDC_ERROR_DETECTED 0x00000054
	88	#define FSF_CONTROL_FILE_UPDATE_ERROR 0x00000055
	89	#define FSF_CONTROL_FILE_TOO_LARGE 0x00000056
	90	#define FSF_ACCESS_CONFLICT_DETECTED 0x00000057
	91	#define FSF_CONFLICTS_OVERRULED 0x00000058
	92	#define FSF_PORT_BOXED 0x00000059
	93	#define FSF_LUN_BOXED 0x0000005A
	94	#define FSF_EXCHANGE_CONFIG_DATA_INCOMPLETE 0x0000005B
	95	#define FSF_PAYLOAD_SIZE_MISMATCH 0x00000060
	96	#define FSF_REQUEST_SIZE_TOO_LARGE 0x00000061
	97	#define FSF_RESPONSE_SIZE_TOO_LARGE 0x00000062
	98	#define FSF_SBAL_MISMATCH 0x00000063
	99	#define FSF_OPEN_PORT_WITHOUT_PRLI 0x00000064
	100	#define FSF_ADAPTER_STATUS_AVAILABLE 0x000000AD
	101	#define FSF_FCP_RSP_AVAILABLE 0x000000AF
	102	#define FSF_UNKNOWN_COMMAND 0x000000E2
	103	#define FSF_UNKNOWN_OP_SUBTYPE 0x000000E3
	104	#define FSF_INVALID_COMMAND_OPTION 0x000000E5
	105	/* #define FSF_ERROR 0x000000FF */
	106
8a36e453	107	#define FSF_PROT_STATUS_QUAL_SIZE 16
1da177e4 LT	108	#define FSF_STATUS_QUALIFIER_SIZE 16
	109
	110	/* FSF status qualifier, recommendations */
	111	#define FSF_SQ_NO_RECOM 0x00
	112	#define FSF_SQ_FCP_RSP_AVAILABLE 0x01
	113	#define FSF_SQ_RETRY_IF_POSSIBLE 0x02
	114	#define FSF_SQ_ULP_DEPENDENT_ERP_REQUIRED 0x03
	115	#define FSF_SQ_INVOKE_LINK_TEST_PROCEDURE 0x04
	116	#define FSF_SQ_ULP_PROGRAMMING_ERROR 0x05
	117	#define FSF_SQ_COMMAND_ABORTED 0x06
	118	#define FSF_SQ_NO_RETRY_POSSIBLE 0x07
	119
	120	/* FSF status qualifier for CFDC commands */
6f71d9bc	121	#define FSF_SQ_CFDC_HARDENED_ON_SE 0x00000000
1da177e4 LT	122	#define FSF_SQ_CFDC_COULD_NOT_HARDEN_ON_SE 0x00000001
	123	#define FSF_SQ_CFDC_COULD_NOT_HARDEN_ON_SE2 0x00000002
	124	/* CFDC subtable codes */
	125	#define FSF_SQ_CFDC_SUBTABLE_OS 0x0001
	126	#define FSF_SQ_CFDC_SUBTABLE_PORT_WWPN 0x0002
	127	#define FSF_SQ_CFDC_SUBTABLE_PORT_DID 0x0003
	128	#define FSF_SQ_CFDC_SUBTABLE_LUN 0x0004
	129
	130	/* FSF status qualifier (most significant 4 bytes), local link down */
aef4a983 MS	131	#define FSF_PSQ_LINK_NO_LIGHT 0x00000004
	132	#define FSF_PSQ_LINK_WRAP_PLUG 0x00000008
	133	#define FSF_PSQ_LINK_NO_FCP 0x00000010
	134	#define FSF_PSQ_LINK_FIRMWARE_UPDATE 0x00000020
	135	#define FSF_PSQ_LINK_INVALID_WWPN 0x00000100
	136	#define FSF_PSQ_LINK_NO_NPIV_SUPPORT 0x00000200
	137	#define FSF_PSQ_LINK_NO_FCP_RESOURCES 0x00000400
	138	#define FSF_PSQ_LINK_NO_FABRIC_RESOURCES 0x00000800
	139	#define FSF_PSQ_LINK_FABRIC_LOGIN_UNABLE 0x00001000
	140	#define FSF_PSQ_LINK_WWPN_ASSIGNMENT_CORRUPTED 0x00002000
	141	#define FSF_PSQ_LINK_MODE_TABLE_CURRUPTED 0x00004000
	142	#define FSF_PSQ_LINK_NO_WWPN_ASSIGNMENT 0x00008000
1da177e4 LT	143
	144	/* payload size in status read buffer */
	145	#define FSF_STATUS_READ_PAYLOAD_SIZE 4032
	146
	147	/* number of status read buffers that should be sent by ULP */
	148	#define FSF_STATUS_READS_RECOM 16
	149
	150	/* status types in status read buffer */
	151	#define FSF_STATUS_READ_PORT_CLOSED 0x00000001
	152	#define FSF_STATUS_READ_INCOMING_ELS 0x00000002
	153	#define FSF_STATUS_READ_SENSE_DATA_AVAIL 0x00000003
	154	#define FSF_STATUS_READ_BIT_ERROR_THRESHOLD 0x00000004
aef4a983	155	#define FSF_STATUS_READ_LINK_DOWN 0x00000005
1da177e4	156	#define FSF_STATUS_READ_LINK_UP 0x00000006
9eb69aff	157	#define FSF_STATUS_READ_NOTIFICATION_LOST 0x00000009
1da177e4 LT	158	#define FSF_STATUS_READ_CFDC_UPDATED 0x0000000A
1da177e4 LT	159	#define FSF_STATUS_READ_CFDC_HARDENED 0x0000000B
aef4a983	160	#define FSF_STATUS_READ_FEATURE_UPDATE_ALERT 0x0000000C
1da177e4 LT	161
	162	/* status subtypes in status read buffer */
	163	#define FSF_STATUS_READ_SUB_CLOSE_PHYS_PORT 0x00000001
	164	#define FSF_STATUS_READ_SUB_ERROR_PORT 0x00000002
	165
aef4a983 MS	166	/* status subtypes for link down */
	167	#define FSF_STATUS_READ_SUB_NO_PHYSICAL_LINK 0x00000000
	168	#define FSF_STATUS_READ_SUB_FDISC_FAILED 0x00000001
	169	#define FSF_STATUS_READ_SUB_FIRMWARE_UPDATE 0x00000002
	170
9eb69aff MS	171	/* status subtypes for unsolicited status notification lost */
	172	#define FSF_STATUS_READ_SUB_INCOMING_ELS 0x00000001
	173	#define FSF_STATUS_READ_SUB_SENSE_DATA 0x00000002
	174	#define FSF_STATUS_READ_SUB_LINK_STATUS 0x00000004
	175	#define FSF_STATUS_READ_SUB_PORT_CLOSED 0x00000008
	176	#define FSF_STATUS_READ_SUB_BIT_ERROR_THRESHOLD 0x00000010
	177	#define FSF_STATUS_READ_SUB_ACT_UPDATED 0x00000020
	178	#define FSF_STATUS_READ_SUB_ACT_HARDENED 0x00000040
	179	#define FSF_STATUS_READ_SUB_FEATURE_UPDATE_ALERT 0x00000080
	180
1da177e4 LT	181	/* status subtypes for CFDC */
	182	#define FSF_STATUS_READ_SUB_CFDC_HARDENED_ON_SE 0x00000002
	183	#define FSF_STATUS_READ_SUB_CFDC_HARDENED_ON_SE2 0x0000000F
	184
	185	/* topologie that is detected by the adapter */
	186	#define FSF_TOPO_ERROR 0x00000000
	187	#define FSF_TOPO_P2P 0x00000001
	188	#define FSF_TOPO_FABRIC 0x00000002
	189	#define FSF_TOPO_AL 0x00000003
1da177e4 LT	190
	191	/* data direction for FCP commands */
	192	#define FSF_DATADIR_WRITE 0x00000001
	193	#define FSF_DATADIR_READ 0x00000002
	194	#define FSF_DATADIR_READ_WRITE 0x00000003
	195	#define FSF_DATADIR_CMND 0x00000004
	196
	197	/* fc service class */
	198	#define FSF_CLASS_1 0x00000001
	199	#define FSF_CLASS_2 0x00000002
	200	#define FSF_CLASS_3 0x00000003
	201
	202	/* SBAL chaining */
	203	#define FSF_MAX_SBALS_PER_REQ 36
	204	#define FSF_MAX_SBALS_PER_ELS_REQ 2
	205
	206	/* logging space behind QTCB */
	207	#define FSF_QTCB_LOG_SIZE 1024
	208
	209	/* channel features */
1da177e4 LT	210	#define FSF_FEATURE_CFDC 0x00000002
1da177e4 LT	211	#define FSF_FEATURE_LUN_SHARING 0x00000004
9eb69aff	212	#define FSF_FEATURE_NOTIFICATION_LOST 0x00000008
1da177e4 LT	213	#define FSF_FEATURE_HBAAPI_MANAGEMENT 0x00000010
1da177e4 LT	214	#define FSF_FEATURE_ELS_CT_CHAINED_SBALS 0x00000020
aef4a983 MS	215	#define FSF_FEATURE_UPDATE_ALERT 0x00000100
	216
	217	/* host connection features */
	218	#define FSF_FEATURE_NPIV_MODE 0x00000001
	219	#define FSF_FEATURE_VM_ASSIGNED_WWPN 0x00000002
1da177e4 LT	220
	221	/* option */
	222	#define FSF_OPEN_LUN_SUPPRESS_BOXING 0x00000001
	223	#define FSF_OPEN_LUN_REPLICATE_SENSE 0x00000002
	224
	225	/* adapter types */
	226	#define FSF_ADAPTER_TYPE_FICON 0x00000001
	227	#define FSF_ADAPTER_TYPE_FICON_EXPRESS 0x00000002
	228
	229	/* port types */
	230	#define FSF_HBA_PORTTYPE_UNKNOWN 0x00000001
	231	#define FSF_HBA_PORTTYPE_NOTPRESENT 0x00000003
	232	#define FSF_HBA_PORTTYPE_NPORT 0x00000005
	233	#define FSF_HBA_PORTTYPE_PTP 0x00000021
	234	/* following are not defined and used by FSF Spec
	235	but are additionally defined by FC-HBA */
	236	#define FSF_HBA_PORTTYPE_OTHER 0x00000002
	237	#define FSF_HBA_PORTTYPE_NOTPRESENT 0x00000003
	238	#define FSF_HBA_PORTTYPE_NLPORT 0x00000006
	239	#define FSF_HBA_PORTTYPE_FLPORT 0x00000007
	240	#define FSF_HBA_PORTTYPE_FPORT 0x00000008
	241	#define FSF_HBA_PORTTYPE_LPORT 0x00000020
	242
	243	/* port states */
	244	#define FSF_HBA_PORTSTATE_UNKNOWN 0x00000001
	245	#define FSF_HBA_PORTSTATE_ONLINE 0x00000002
	246	#define FSF_HBA_PORTSTATE_OFFLINE 0x00000003
	247	#define FSF_HBA_PORTSTATE_LINKDOWN 0x00000006
	248	#define FSF_HBA_PORTSTATE_ERROR 0x00000007
	249
	250	/* IO states of adapter */
	251	#define FSF_IOSTAT_NPORT_RJT 0x00000004
	252	#define FSF_IOSTAT_FABRIC_RJT 0x00000005
	253	#define FSF_IOSTAT_LS_RJT 0x00000009
	254
	255	/* open LUN access flags*/
	256	#define FSF_UNIT_ACCESS_OPEN_LUN_ALLOWED 0x01000000
	257	#define FSF_UNIT_ACCESS_EXCLUSIVE 0x02000000
	258	#define FSF_UNIT_ACCESS_OUTBOUND_TRANSFER 0x10000000
	259
1da177e4 LT	260	struct fsf_queue_designator {
	261	u8 cssid;
	262	u8 chpid;
	263	u8 hla;
	264	u8 ua;
	265	u32 res1;
	266	} __attribute__ ((packed));
	267
	268	struct fsf_port_closed_payload {
	269	struct fsf_queue_designator queue_designator;
	270	u32 port_handle;
	271	} __attribute__ ((packed));
	272
	273	struct fsf_bit_error_payload {
	274	u32 res1;
	275	u32 link_failure_error_count;
	276	u32 loss_of_sync_error_count;
	277	u32 loss_of_signal_error_count;
	278	u32 primitive_sequence_error_count;
	279	u32 invalid_transmission_word_error_count;
	280	u32 crc_error_count;
	281	u32 primitive_sequence_event_timeout_count;
	282	u32 elastic_buffer_overrun_error_count;
	283	u32 fcal_arbitration_timeout_count;
	284	u32 advertised_receive_b2b_credit;
	285	u32 current_receive_b2b_credit;
	286	u32 advertised_transmit_b2b_credit;
	287	u32 current_transmit_b2b_credit;
	288	} __attribute__ ((packed));
	289
	290	struct fsf_status_read_buffer {
	291	u32 status_type;
	292	u32 status_subtype;
	293	u32 length;
	294	u32 res1;
	295	struct fsf_queue_designator queue_designator;
	296	u32 d_id;
	297	u32 class;
	298	u64 fcp_lun;
	299	u8 res3[24];
	300	u8 payload[FSF_STATUS_READ_PAYLOAD_SIZE];
	301	} __attribute__ ((packed));
	302
	303	struct fsf_qual_version_error {
	304	u32 fsf_version;
	305	u32 res1[3];
	306	} __attribute__ ((packed));
	307
	308	struct fsf_qual_sequence_error {
	309	u32 exp_req_seq_no;
	310	u32 res1[3];
	311	} __attribute__ ((packed));
	312
aef4a983 MS	313	struct fsf_link_down_info {
	314	u32 error_code;
	315	u32 res1;
	316	u8 res2[2];
	317	u8 primary_status;
	318	u8 ioerr_code;
	319	u8 action_code;
	320	u8 reason_code;
	321	u8 explanation_code;
	322	u8 vendor_specific_code;
1da177e4 LT	323	} __attribute__ ((packed));
	324
	325	union fsf_prot_status_qual {
8a36e453	326	u64 doubleword[FSF_PROT_STATUS_QUAL_SIZE / sizeof(u64)];
1da177e4 LT	327	struct fsf_qual_version_error version_error;
1da177e4 LT	328	struct fsf_qual_sequence_error sequence_error;
aef4a983	329	struct fsf_link_down_info link_down_info;
1da177e4 LT	330	} __attribute__ ((packed));
	331
	332	struct fsf_qtcb_prefix {
	333	u64 req_id;
	334	u32 qtcb_version;
	335	u32 ulp_info;
	336	u32 qtcb_type;
	337	u32 req_seq_no;
	338	u32 prot_status;
	339	union fsf_prot_status_qual prot_status_qual;
	340	u8 res1[20];
	341	} __attribute__ ((packed));
	342
	343	union fsf_status_qual {
	344	u8 byte[FSF_STATUS_QUALIFIER_SIZE];
	345	u16 halfword[FSF_STATUS_QUALIFIER_SIZE / sizeof (u16)];
	346	u32 word[FSF_STATUS_QUALIFIER_SIZE / sizeof (u32)];
8a36e453	347	u64 doubleword[FSF_STATUS_QUALIFIER_SIZE / sizeof(u64)];
1da177e4	348	struct fsf_queue_designator fsf_queue_designator;
aef4a983	349	struct fsf_link_down_info link_down_info;
1da177e4 LT	350	} __attribute__ ((packed));
	351
	352	struct fsf_qtcb_header {
	353	u64 req_handle;
	354	u32 fsf_command;
	355	u32 res1;
	356	u32 port_handle;
	357	u32 lun_handle;
	358	u32 res2;
	359	u32 fsf_status;
	360	union fsf_status_qual fsf_status_qual;
	361	u8 res3[28];
	362	u16 log_start;
	363	u16 log_length;
	364	u8 res4[16];
	365	} __attribute__ ((packed));
	366
	367	struct fsf_nport_serv_param {
	368	u8 common_serv_param[16];
	369	u64 wwpn;
	370	u64 wwnn;
	371	u8 class1_serv_param[16];
	372	u8 class2_serv_param[16];
	373	u8 class3_serv_param[16];
	374	u8 class4_serv_param[16];
	375	u8 vendor_version_level[16];
1da177e4 LT	376	} __attribute__ ((packed));
	377
	378	struct fsf_plogi {
	379	u32 code;
	380	struct fsf_nport_serv_param serv_param;
	381	} __attribute__ ((packed));
	382
	383	#define FSF_FCP_CMND_SIZE 288
	384	#define FSF_FCP_RSP_SIZE 128
	385
	386	struct fsf_qtcb_bottom_io {
	387	u32 data_direction;
	388	u32 service_class;
	389	u8 res1[8];
	390	u32 fcp_cmnd_length;
	391	u8 res2[12];
	392	u8 fcp_cmnd[FSF_FCP_CMND_SIZE];
	393	u8 fcp_rsp[FSF_FCP_RSP_SIZE];
	394	u8 res3[64];
	395	} __attribute__ ((packed));
	396
	397	struct fsf_qtcb_bottom_support {
	398	u32 operation_subtype;
	399	u8 res1[12];
	400	u32 d_id;
	401	u32 option;
	402	u64 fcp_lun;
	403	u64 res2;
	404	u64 req_handle;
	405	u32 service_class;
	406	u8 res3[3];
	407	u8 timeout;
	408	u32 lun_access_info;
	409	u8 res4[180];
	410	u32 els1_length;
	411	u32 els2_length;
	412	u32 req_buf_length;
	413	u32 resp_buf_length;
	414	u8 els[256];
	415	} __attribute__ ((packed));
	416
	417	struct fsf_qtcb_bottom_config {
	418	u32 lic_version;
	419	u32 feature_selection;
	420	u32 high_qtcb_version;
	421	u32 low_qtcb_version;
	422	u32 max_qtcb_size;
	423	u32 max_data_transfer_size;
aef4a983 MS	424	u32 adapter_features;
aef4a983 MS	425	u32 connection_features;
1da177e4 LT	426	u32 fc_topology;
	427	u32 fc_link_speed;
	428	u32 adapter_type;
	429	u32 peer_d_id;
	430	u8 res2[12];
	431	u32 s_id;
	432	struct fsf_nport_serv_param nport_serv_param;
6f71d9bc	433	u8 reserved_nport_serv_param[16];
1da177e4 LT	434	u8 res3[8];
	435	u32 adapter_ports;
	436	u32 hardware_version;
	437	u8 serial_number[32];
6f71d9bc	438	struct fsf_nport_serv_param plogi_payload;
6f71d9bc	439	u8 res4[160];
1da177e4 LT	440	} __attribute__ ((packed));
	441
	442	struct fsf_qtcb_bottom_port {
aef4a983	443	u64 wwpn;
1da177e4 LT	444	u32 fc_port_id;
	445	u32 port_type;
	446	u32 port_state;
	447	u32 class_of_service; /* should be 0x00000006 for class 2 and 3 */
	448	u8 supported_fc4_types[32]; /* should be 0x00000100 for scsi fcp */
	449	u8 active_fc4_types[32];
	450	u32 supported_speed; /* 0x0001 for 1 GBit/s or 0x0002 for 2 GBit/s */
	451	u32 maximum_frame_size; /* fixed value of 2112 */
	452	u64 seconds_since_last_reset;
	453	u64 tx_frames;
	454	u64 tx_words;
	455	u64 rx_frames;
	456	u64 rx_words;
	457	u64 lip; /* 0 */
	458	u64 nos; /* currently 0 */
	459	u64 error_frames; /* currently 0 */
	460	u64 dumped_frames; /* currently 0 */
	461	u64 link_failure;
	462	u64 loss_of_sync;
	463	u64 loss_of_signal;
	464	u64 psp_error_counts;
	465	u64 invalid_tx_words;
	466	u64 invalid_crcs;
	467	u64 input_requests;
	468	u64 output_requests;
	469	u64 control_requests;
	470	u64 input_mb; /* where 1 MByte == 1.000.000 Bytes */
	471	u64 output_mb; /* where 1 MByte == 1.000.000 Bytes */
	472	u8 res2[256];
	473	} __attribute__ ((packed));
	474
	475	union fsf_qtcb_bottom {
	476	struct fsf_qtcb_bottom_io io;
	477	struct fsf_qtcb_bottom_support support;
	478	struct fsf_qtcb_bottom_config config;
	479	struct fsf_qtcb_bottom_port port;
	480	};
	481
	482	struct fsf_qtcb {
	483	struct fsf_qtcb_prefix prefix;
	484	struct fsf_qtcb_header header;
	485	union fsf_qtcb_bottom bottom;
	486	u8 log[FSF_QTCB_LOG_SIZE];
	487	} __attribute__ ((packed));
	488
	489	#endif /* FSF_H */