1/* SPDX-License-Identifier: GPL-2.0-only */ 2/* 3 * Copyright(c) 2007 Intel Corporation. All rights reserved. 4 * 5 * Maintained at www.Open-FCoE.org 6 */ 7 8#ifndef _FC_FCP_H_ 9#define _FC_FCP_H_ 10 11#include <scsi/scsi.h> 12 13/* 14 * Fibre Channel Protocol for SCSI. 15 * From T10 FCP-3, T10 project 1560-D Rev 4, Sept. 13, 2005. 16 */ 17 18/* 19 * fc/fs.h defines FC_TYPE_FCP. 20 */ 21 22/* 23 * Service parameter page parameters (word 3 bits) for Process Login. 24 */ 25#define FCP_SPPF_TASK_RETRY_ID 0x0200 /* task retry ID requested */ 26#define FCP_SPPF_RETRY 0x0100 /* retry supported */ 27#define FCP_SPPF_CONF_COMPL 0x0080 /* confirmed completion allowed */ 28#define FCP_SPPF_OVLY_ALLOW 0x0040 /* data overlay allowed */ 29#define FCP_SPPF_INIT_FCN 0x0020 /* initiator function */ 30#define FCP_SPPF_TARG_FCN 0x0010 /* target function */ 31#define FCP_SPPF_RD_XRDY_DIS 0x0002 /* disable XFER_RDY for reads */ 32#define FCP_SPPF_WR_XRDY_DIS 0x0001 /* disable XFER_RDY for writes */ 33 34/* 35 * FCP_CMND IU Payload. 36 */ 37struct fcp_cmnd { 38 struct scsi_lun fc_lun; /* logical unit number */ 39 __u8 fc_cmdref; /* command reference number */ 40 __u8 fc_pri_ta; /* priority and task attribute */ 41 __u8 fc_tm_flags; /* task management flags */ 42 __u8 fc_flags; /* additional len & flags */ 43 __u8 fc_cdb[16]; /* base CDB */ 44 __be32 fc_dl; /* data length (must follow fc_cdb) */ 45}; 46 47#define FCP_CMND_LEN 32 /* expected length of structure */ 48 49struct fcp_cmnd32 { 50 struct scsi_lun fc_lun; /* logical unit number */ 51 __u8 fc_cmdref; /* command reference number */ 52 __u8 fc_pri_ta; /* priority and task attribute */ 53 __u8 fc_tm_flags; /* task management flags */ 54 __u8 fc_flags; /* additional len & flags */ 55 __u8 fc_cdb[32]; /* base CDB */ 56 __be32 fc_dl; /* data length (must follow fc_cdb) */ 57}; 58 59#define FCP_CMND32_LEN 48 /* expected length of structure */ 60#define FCP_CMND32_ADD_LEN (16 / 4) /* Additional cdb length */ 61 62/* 63 * fc_pri_ta. 64 */ 65#define FCP_PTA_SIMPLE 0 /* simple task attribute */ 66#define FCP_PTA_HEADQ 1 /* head of queue task attribute */ 67#define FCP_PTA_ORDERED 2 /* ordered task attribute */ 68#define FCP_PTA_ACA 4 /* auto. contingent allegiance */ 69#define FCP_PTA_MASK 7 /* mask for task attribute field */ 70#define FCP_PRI_SHIFT 3 /* priority field starts in bit 3 */ 71#define FCP_PRI_RESVD_MASK 0x80 /* reserved bits in priority field */ 72 73/* 74 * fc_tm_flags - task management flags field. 75 */ 76#define FCP_TMF_CLR_ACA 0x40 /* clear ACA condition */ 77#define FCP_TMF_TGT_RESET 0x20 /* target reset task management, 78 deprecated as of FCP-3 */ 79#define FCP_TMF_LUN_RESET 0x10 /* logical unit reset task management */ 80#define FCP_TMF_CLR_TASK_SET 0x04 /* clear task set */ 81#define FCP_TMF_ABT_TASK_SET 0x02 /* abort task set */ 82 83/* 84 * fc_flags. 85 * Bits 7:2 are the additional FCP_CDB length / 4. 86 */ 87#define FCP_CFL_LEN_MASK 0xfc /* mask for additional length */ 88#define FCP_CFL_LEN_SHIFT 2 /* shift bits for additional length */ 89#define FCP_CFL_RDDATA 0x02 /* read data */ 90#define FCP_CFL_WRDATA 0x01 /* write data */ 91 92/* 93 * FCP_TXRDY IU - transfer ready payload. 94 */ 95struct fcp_txrdy { 96 __be32 ft_data_ro; /* data relative offset */ 97 __be32 ft_burst_len; /* burst length */ 98 __u8 _ft_resvd[4]; /* reserved */ 99}; 100 101#define FCP_TXRDY_LEN 12 /* expected length of structure */ 102 103/* 104 * FCP_RESP IU - response payload. 105 * 106 * The response payload comes in three parts: the flags/status, the 107 * sense/response lengths and the sense data/response info section. 108 * 109 * From FCP3r04, note 6 of section 9.5.13: 110 * 111 * Some early implementations presented the FCP_RSP IU without the FCP_RESID, 112 * FCP_SNS_LEN, and FCP_RSP_LEN fields if the FCP_RESID_UNDER, FCP_RESID_OVER, 113 * FCP_SNS_LEN_VALID, and FCP_RSP_LEN_VALID bits were all set to zero. This 114 * non-standard behavior should be tolerated. 115 * 116 * All response frames will always contain the fcp_resp template. Some 117 * will also include the fcp_resp_len template. 118 * 119 * From Table 23, the FCP_RSP_INFO can either be 4 bytes or 8 bytes, both 120 * are valid length. 121 */ 122struct fcp_resp { 123 __u8 _fr_resvd[8]; /* reserved */ 124 __be16 fr_retry_delay; /* retry delay timer */ 125 __u8 fr_flags; /* flags */ 126 __u8 fr_status; /* SCSI status code */ 127}; 128 129#define FCP_RESP_LEN 12 /* expected length of structure */ 130 131struct fcp_resp_ext { 132 __be32 fr_resid; /* Residual value */ 133 __be32 fr_sns_len; /* SCSI Sense length */ 134 __be32 fr_rsp_len; /* Response Info length */ 135 136 /* 137 * Optionally followed by RSP info and/or SNS info and/or 138 * bidirectional read residual length, if any. 139 */ 140}; 141 142#define FCP_RESP_EXT_LEN 12 /* expected length of the structure */ 143 144struct fcp_resp_rsp_info { 145 __u8 _fr_resvd[3]; /* reserved */ 146 __u8 rsp_code; /* Response Info Code */ 147 __u8 _fr_resvd2[4]; /* reserved */ 148}; 149 150#define FCP_RESP_RSP_INFO_LEN4 4 /* without reserved field */ 151#define FCP_RESP_RSP_INFO_LEN8 8 /* with reserved field */ 152 153struct fcp_resp_with_ext { 154 struct fcp_resp resp; 155 struct fcp_resp_ext ext; 156}; 157 158#define FCP_RESP_WITH_EXT (FCP_RESP_LEN + FCP_RESP_EXT_LEN) 159 160/* 161 * fr_flags. 162 */ 163#define FCP_BIDI_RSP 0x80 /* bidirectional read response */ 164#define FCP_BIDI_READ_UNDER 0x40 /* bidir. read less than requested */ 165#define FCP_BIDI_READ_OVER 0x20 /* DL insufficient for full transfer */ 166#define FCP_CONF_REQ 0x10 /* confirmation requested */ 167#define FCP_RESID_UNDER 0x08 /* transfer shorter than expected */ 168#define FCP_RESID_OVER 0x04 /* DL insufficient for full transfer */ 169#define FCP_SNS_LEN_VAL 0x02 /* SNS_LEN field is valid */ 170#define FCP_RSP_LEN_VAL 0x01 /* RSP_LEN field is valid */ 171 172/* 173 * rsp_codes 174 */ 175enum fcp_resp_rsp_codes { 176 FCP_TMF_CMPL = 0, 177 FCP_DATA_LEN_INVALID = 1, 178 FCP_CMND_FIELDS_INVALID = 2, 179 FCP_DATA_PARAM_MISMATCH = 3, 180 FCP_TMF_REJECTED = 4, 181 FCP_TMF_FAILED = 5, 182 FCP_TMF_INVALID_LUN = 9, 183}; 184 185/* 186 * FCP SRR Link Service request - Sequence Retransmission Request. 187 */ 188struct fcp_srr { 189 __u8 srr_op; /* opcode ELS_SRR */ 190 __u8 srr_resvd[3]; /* opcode / reserved - must be zero */ 191 __be16 srr_ox_id; /* OX_ID of failed command */ 192 __be16 srr_rx_id; /* RX_ID of failed command */ 193 __be32 srr_rel_off; /* relative offset */ 194 __u8 srr_r_ctl; /* r_ctl for the information unit */ 195 __u8 srr_resvd2[3]; /* reserved */ 196}; 197 198/* 199 * Feature bits in name server FC-4 Features object. 200 */ 201#define FCP_FEAT_TARG (1 << 0) /* target function supported */ 202#define FCP_FEAT_INIT (1 << 1) /* initiator function supported */ 203 204#endif /* _FC_FCP_H_ */ 205