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