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