1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  *  Copyright (C) 2004 - 2010 Vladislav Bolkhovitin <vst@vlnb.net>
4  *  Copyright (C) 2004 - 2005 Leonid Stoljar
5  *  Copyright (C) 2006 Nathaniel Clark <nate@misrule.us>
6  *  Copyright (C) 2007 - 2010 ID7 Ltd.
7  *
8  *  Forward port and refactoring to modern qla2xxx and target/configfs
9  *
10  *  Copyright (C) 2010-2011 Nicholas A. Bellinger <nab@kernel.org>
11  *
12  *  Additional file for the target driver support.
13  */
14 /*
15  * This is the global def file that is useful for including from the
16  * target portion.
17  */
18 
19 #ifndef __QLA_TARGET_H
20 #define __QLA_TARGET_H
21 
22 #include "qla_def.h"
23 #include "qla_dsd.h"
24 
25 /*
26  * Must be changed on any change in any initiator visible interfaces or
27  * data in the target add-on
28  */
29 #define QLA2XXX_TARGET_MAGIC	269
30 
31 /*
32  * Must be changed on any change in any target visible interfaces or
33  * data in the initiator
34  */
35 #define QLA2XXX_INITIATOR_MAGIC   57222
36 
37 #define QLA2XXX_INI_MODE_STR_EXCLUSIVE	"exclusive"
38 #define QLA2XXX_INI_MODE_STR_DISABLED	"disabled"
39 #define QLA2XXX_INI_MODE_STR_ENABLED	"enabled"
40 #define QLA2XXX_INI_MODE_STR_DUAL		"dual"
41 
42 #define QLA2XXX_INI_MODE_EXCLUSIVE	0
43 #define QLA2XXX_INI_MODE_DISABLED	1
44 #define QLA2XXX_INI_MODE_ENABLED	2
45 #define QLA2XXX_INI_MODE_DUAL	3
46 
47 #define QLA2XXX_COMMAND_COUNT_INIT	250
48 #define QLA2XXX_IMMED_NOTIFY_COUNT_INIT 250
49 
50 /*
51  * Used to mark which completion handles (for RIO Status's) are for CTIO's
52  * vs. regular (non-target) info. This is checked for in
53  * qla2x00_process_response_queue() to see if a handle coming back in a
54  * multi-complete should come to the tgt driver or be handled there by qla2xxx
55  */
56 #define CTIO_COMPLETION_HANDLE_MARK	BIT_29
57 #if (CTIO_COMPLETION_HANDLE_MARK <= DEFAULT_OUTSTANDING_COMMANDS)
58 #error "CTIO_COMPLETION_HANDLE_MARK not larger than "
59 	"DEFAULT_OUTSTANDING_COMMANDS"
60 #endif
61 #define HANDLE_IS_CTIO_COMP(h) (h & CTIO_COMPLETION_HANDLE_MARK)
62 
63 /* Used to mark CTIO as intermediate */
64 #define CTIO_INTERMEDIATE_HANDLE_MARK	BIT_30
65 #define QLA_TGT_NULL_HANDLE	0
66 
67 #define QLA_TGT_HANDLE_MASK  0xF0000000
68 #define QLA_QPID_HANDLE_MASK 0x00FF0000 /* qpair id mask */
69 #define QLA_CMD_HANDLE_MASK  0x0000FFFF
70 #define QLA_TGT_SKIP_HANDLE	(0xFFFFFFFF & ~QLA_TGT_HANDLE_MASK)
71 
72 #define QLA_QPID_HANDLE_SHIFT 16
73 #define GET_QID(_h) ((_h & QLA_QPID_HANDLE_MASK) >> QLA_QPID_HANDLE_SHIFT)
74 
75 
76 #ifndef OF_SS_MODE_0
77 /*
78  * ISP target entries - Flags bit definitions.
79  */
80 #define OF_SS_MODE_0        0
81 #define OF_SS_MODE_1        1
82 #define OF_SS_MODE_2        2
83 #define OF_SS_MODE_3        3
84 
85 #define OF_EXPL_CONF        BIT_5       /* Explicit Confirmation Requested */
86 #define OF_DATA_IN          BIT_6       /* Data in to initiator */
87 					/*  (data from target to initiator) */
88 #define OF_DATA_OUT         BIT_7       /* Data out from initiator */
89 					/*  (data from initiator to target) */
90 #define OF_NO_DATA          (BIT_7 | BIT_6)
91 #define OF_INC_RC           BIT_8       /* Increment command resource count */
92 #define OF_FAST_POST        BIT_9       /* Enable mailbox fast posting. */
93 #define OF_CONF_REQ         BIT_13      /* Confirmation Requested */
94 #define OF_TERM_EXCH        BIT_14      /* Terminate exchange */
95 #define OF_SSTS             BIT_15      /* Send SCSI status */
96 #endif
97 
98 #ifndef QLA_TGT_DATASEGS_PER_CMD32
99 #define QLA_TGT_DATASEGS_PER_CMD32	3
100 #define QLA_TGT_DATASEGS_PER_CONT32	7
101 #define QLA_TGT_MAX_SG32(ql) \
102 	(((ql) > 0) ? (QLA_TGT_DATASEGS_PER_CMD32 + \
103 		QLA_TGT_DATASEGS_PER_CONT32*((ql) - 1)) : 0)
104 
105 #define QLA_TGT_DATASEGS_PER_CMD64	2
106 #define QLA_TGT_DATASEGS_PER_CONT64	5
107 #define QLA_TGT_MAX_SG64(ql) \
108 	(((ql) > 0) ? (QLA_TGT_DATASEGS_PER_CMD64 + \
109 		QLA_TGT_DATASEGS_PER_CONT64*((ql) - 1)) : 0)
110 #endif
111 
112 #ifndef QLA_TGT_DATASEGS_PER_CMD_24XX
113 #define QLA_TGT_DATASEGS_PER_CMD_24XX	1
114 #define QLA_TGT_DATASEGS_PER_CONT_24XX	5
115 #define QLA_TGT_MAX_SG_24XX(ql) \
116 	(min(1270, ((ql) > 0) ? (QLA_TGT_DATASEGS_PER_CMD_24XX + \
117 		QLA_TGT_DATASEGS_PER_CONT_24XX*((ql) - 1)) : 0))
118 #endif
119 #endif
120 
121 #define GET_TARGET_ID(ha, iocb) ((HAS_EXTENDED_IDS(ha))			\
122 			 ? le16_to_cpu((iocb)->u.isp2x.target.extended)	\
123 			 : (uint16_t)(iocb)->u.isp2x.target.id.standard)
124 
125 #ifndef NOTIFY_ACK_TYPE
126 #define NOTIFY_ACK_TYPE 0x0E	  /* Notify acknowledge entry. */
127 /*
128  * ISP queue -	notify acknowledge entry structure definition.
129  *		This is sent to the ISP from the target driver.
130  */
131 struct nack_to_isp {
132 	uint8_t	 entry_type;		    /* Entry type. */
133 	uint8_t	 entry_count;		    /* Entry count. */
134 	uint8_t	 sys_define;		    /* System defined. */
135 	uint8_t	 entry_status;		    /* Entry Status. */
136 	union {
137 		struct {
138 			uint32_t sys_define_2; /* System defined. */
139 			target_id_t target;
140 			uint8_t	 target_id;
141 			uint8_t	 reserved_1;
142 			uint16_t flags;
143 			uint16_t resp_code;
144 			uint16_t status;
145 			uint16_t task_flags;
146 			uint16_t seq_id;
147 			uint16_t srr_rx_id;
148 			uint32_t srr_rel_offs;
149 			uint16_t srr_ui;
150 			uint16_t srr_flags;
151 			uint16_t srr_reject_code;
152 			uint8_t  srr_reject_vendor_uniq;
153 			uint8_t  srr_reject_code_expl;
154 			uint8_t  reserved_2[24];
155 		} isp2x;
156 		struct {
157 			uint32_t handle;
158 			uint16_t nport_handle;
159 			uint16_t reserved_1;
160 			uint16_t flags;
161 			uint16_t srr_rx_id;
162 			uint16_t status;
163 			uint8_t  status_subcode;
164 			uint8_t  fw_handle;
165 			uint32_t exchange_address;
166 			uint32_t srr_rel_offs;
167 			uint16_t srr_ui;
168 			uint16_t srr_flags;
169 			uint8_t  reserved_4[19];
170 			uint8_t  vp_index;
171 			uint8_t  srr_reject_vendor_uniq;
172 			uint8_t  srr_reject_code_expl;
173 			uint8_t  srr_reject_code;
174 			uint8_t  reserved_5[5];
175 		} isp24;
176 	} u;
177 	uint8_t  reserved[2];
178 	uint16_t ox_id;
179 } __packed;
180 #define NOTIFY_ACK_FLAGS_TERMINATE	BIT_3
181 #define NOTIFY_ACK_SRR_FLAGS_ACCEPT	0
182 #define NOTIFY_ACK_SRR_FLAGS_REJECT	1
183 
184 #define NOTIFY_ACK_SRR_REJECT_REASON_UNABLE_TO_PERFORM	0x9
185 
186 #define NOTIFY_ACK_SRR_FLAGS_REJECT_EXPL_NO_EXPL		0
187 #define NOTIFY_ACK_SRR_FLAGS_REJECT_EXPL_UNABLE_TO_SUPPLY_DATA	0x2a
188 
189 #define NOTIFY_ACK_SUCCESS      0x01
190 #endif
191 
192 #ifndef ACCEPT_TGT_IO_TYPE
193 #define ACCEPT_TGT_IO_TYPE 0x16 /* Accept target I/O entry. */
194 #endif
195 
196 #ifndef CONTINUE_TGT_IO_TYPE
197 #define CONTINUE_TGT_IO_TYPE 0x17
198 /*
199  * ISP queue -	Continue Target I/O (CTIO) entry for status mode 0 structure.
200  *		This structure is sent to the ISP 2xxx from target driver.
201  */
202 struct ctio_to_2xxx {
203 	uint8_t	 entry_type;		/* Entry type. */
204 	uint8_t	 entry_count;		/* Entry count. */
205 	uint8_t	 sys_define;		/* System defined. */
206 	uint8_t	 entry_status;		/* Entry Status. */
207 	uint32_t handle;		/* System defined handle */
208 	target_id_t target;
209 	uint16_t rx_id;
210 	uint16_t flags;
211 	uint16_t status;
212 	uint16_t timeout;		/* 0 = 30 seconds, 0xFFFF = disable */
213 	uint16_t dseg_count;		/* Data segment count. */
214 	uint32_t relative_offset;
215 	uint32_t residual;
216 	uint16_t reserved_1[3];
217 	uint16_t scsi_status;
218 	uint32_t transfer_length;
219 	struct dsd32 dsd[3];
220 } __packed;
221 #define ATIO_PATH_INVALID       0x07
222 #define ATIO_CANT_PROV_CAP      0x16
223 #define ATIO_CDB_VALID          0x3D
224 
225 #define ATIO_EXEC_READ          BIT_1
226 #define ATIO_EXEC_WRITE         BIT_0
227 #endif
228 
229 #ifndef CTIO_A64_TYPE
230 #define CTIO_A64_TYPE 0x1F
231 #define CTIO_SUCCESS			0x01
232 #define CTIO_ABORTED			0x02
233 #define CTIO_INVALID_RX_ID		0x08
234 #define CTIO_TIMEOUT			0x0B
235 #define CTIO_DIF_ERROR			0x0C     /* DIF error detected  */
236 #define CTIO_LIP_RESET			0x0E
237 #define CTIO_TARGET_RESET		0x17
238 #define CTIO_PORT_UNAVAILABLE		0x28
239 #define CTIO_PORT_LOGGED_OUT		0x29
240 #define CTIO_PORT_CONF_CHANGED		0x2A
241 #define CTIO_SRR_RECEIVED		0x45
242 #endif
243 
244 #ifndef CTIO_RET_TYPE
245 #define CTIO_RET_TYPE	0x17		/* CTIO return entry */
246 #define ATIO_TYPE7 0x06 /* Accept target I/O entry for 24xx */
247 
248 struct fcp_hdr {
249 	uint8_t  r_ctl;
250 	uint8_t  d_id[3];
251 	uint8_t  cs_ctl;
252 	uint8_t  s_id[3];
253 	uint8_t  type;
254 	uint8_t  f_ctl[3];
255 	uint8_t  seq_id;
256 	uint8_t  df_ctl;
257 	uint16_t seq_cnt;
258 	__be16   ox_id;
259 	uint16_t rx_id;
260 	uint32_t parameter;
261 } __packed;
262 
263 struct fcp_hdr_le {
264 	uint8_t  d_id[3];
265 	uint8_t  r_ctl;
266 	uint8_t  s_id[3];
267 	uint8_t  cs_ctl;
268 	uint8_t  f_ctl[3];
269 	uint8_t  type;
270 	uint16_t seq_cnt;
271 	uint8_t  df_ctl;
272 	uint8_t  seq_id;
273 	uint16_t rx_id;
274 	uint16_t ox_id;
275 	uint32_t parameter;
276 } __packed;
277 
278 #define F_CTL_EXCH_CONTEXT_RESP	BIT_23
279 #define F_CTL_SEQ_CONTEXT_RESIP	BIT_22
280 #define F_CTL_LAST_SEQ		BIT_20
281 #define F_CTL_END_SEQ		BIT_19
282 #define F_CTL_SEQ_INITIATIVE	BIT_16
283 
284 #define R_CTL_BASIC_LINK_SERV	0x80
285 #define R_CTL_B_ACC		0x4
286 #define R_CTL_B_RJT		0x5
287 
288 struct atio7_fcp_cmnd {
289 	uint64_t lun;
290 	uint8_t  cmnd_ref;
291 	uint8_t  task_attr:3;
292 	uint8_t  reserved:5;
293 	uint8_t  task_mgmt_flags;
294 #define FCP_CMND_TASK_MGMT_CLEAR_ACA		6
295 #define FCP_CMND_TASK_MGMT_TARGET_RESET		5
296 #define FCP_CMND_TASK_MGMT_LU_RESET		4
297 #define FCP_CMND_TASK_MGMT_CLEAR_TASK_SET	2
298 #define FCP_CMND_TASK_MGMT_ABORT_TASK_SET	1
299 	uint8_t  wrdata:1;
300 	uint8_t  rddata:1;
301 	uint8_t  add_cdb_len:6;
302 	uint8_t  cdb[16];
303 	/*
304 	 * add_cdb is optional and can absent from struct atio7_fcp_cmnd. Size 4
305 	 * only to make sizeof(struct atio7_fcp_cmnd) be as expected by
306 	 * BUILD_BUG_ON in qlt_init().
307 	 */
308 	uint8_t  add_cdb[4];
309 	/* uint32_t data_length; */
310 } __packed;
311 
312 /*
313  * ISP queue -	Accept Target I/O (ATIO) type entry IOCB structure.
314  *		This is sent from the ISP to the target driver.
315  */
316 struct atio_from_isp {
317 	union {
318 		struct {
319 			uint16_t entry_hdr;
320 			uint8_t  sys_define;   /* System defined. */
321 			uint8_t  entry_status; /* Entry Status.   */
322 			uint32_t sys_define_2; /* System defined. */
323 			target_id_t target;
324 			uint16_t rx_id;
325 			uint16_t flags;
326 			uint16_t status;
327 			uint8_t  command_ref;
328 			uint8_t  task_codes;
329 			uint8_t  task_flags;
330 			uint8_t  execution_codes;
331 			uint8_t  cdb[MAX_CMDSZ];
332 			uint32_t data_length;
333 			uint16_t lun;
334 			uint8_t  initiator_port_name[WWN_SIZE]; /* on qla23xx */
335 			uint16_t reserved_32[6];
336 			uint16_t ox_id;
337 		} isp2x;
338 		struct {
339 			uint16_t entry_hdr;
340 			uint8_t  fcp_cmnd_len_low;
341 			uint8_t  fcp_cmnd_len_high:4;
342 			uint8_t  attr:4;
343 			uint32_t exchange_addr;
344 #define ATIO_EXCHANGE_ADDRESS_UNKNOWN	0xFFFFFFFF
345 			struct fcp_hdr fcp_hdr;
346 			struct atio7_fcp_cmnd fcp_cmnd;
347 		} isp24;
348 		struct {
349 			uint8_t  entry_type;	/* Entry type. */
350 			uint8_t  entry_count;	/* Entry count. */
351 			__le16	 attr_n_length;
352 #define FCP_CMD_LENGTH_MASK 0x0fff
353 #define FCP_CMD_LENGTH_MIN  0x38
354 			uint8_t  data[56];
355 			uint32_t signature;
356 #define ATIO_PROCESSED 0xDEADDEAD		/* Signature */
357 		} raw;
358 	} u;
359 } __packed;
360 
361 static inline int fcpcmd_is_corrupted(struct atio *atio)
362 {
363 	if (atio->entry_type == ATIO_TYPE7 &&
364 	    ((le16_to_cpu(atio->attr_n_length) & FCP_CMD_LENGTH_MASK) <
365 	     FCP_CMD_LENGTH_MIN))
366 		return 1;
367 	else
368 		return 0;
369 }
370 
371 /* adjust corrupted atio so we won't trip over the same entry again. */
372 static inline void adjust_corrupted_atio(struct atio_from_isp *atio)
373 {
374 	atio->u.raw.attr_n_length = cpu_to_le16(FCP_CMD_LENGTH_MIN);
375 	atio->u.isp24.fcp_cmnd.add_cdb_len = 0;
376 }
377 
378 static inline int get_datalen_for_atio(struct atio_from_isp *atio)
379 {
380 	int len = atio->u.isp24.fcp_cmnd.add_cdb_len;
381 
382 	return (be32_to_cpu(get_unaligned((uint32_t *)
383 	    &atio->u.isp24.fcp_cmnd.add_cdb[len * 4])));
384 }
385 
386 #define CTIO_TYPE7 0x12 /* Continue target I/O entry (for 24xx) */
387 
388 /*
389  * ISP queue -	Continue Target I/O (ATIO) type 7 entry (for 24xx) structure.
390  *		This structure is sent to the ISP 24xx from the target driver.
391  */
392 
393 struct ctio7_to_24xx {
394 	uint8_t	 entry_type;		    /* Entry type. */
395 	uint8_t	 entry_count;		    /* Entry count. */
396 	uint8_t	 sys_define;		    /* System defined. */
397 	uint8_t	 entry_status;		    /* Entry Status. */
398 	uint32_t handle;		    /* System defined handle */
399 	uint16_t nport_handle;
400 #define CTIO7_NHANDLE_UNRECOGNIZED	0xFFFF
401 	uint16_t timeout;
402 	uint16_t dseg_count;		    /* Data segment count. */
403 	uint8_t  vp_index;
404 	uint8_t  add_flags;
405 	uint8_t  initiator_id[3];
406 	uint8_t  reserved;
407 	uint32_t exchange_addr;
408 	union {
409 		struct {
410 			uint16_t reserved1;
411 			__le16 flags;
412 			uint32_t residual;
413 			__le16 ox_id;
414 			uint16_t scsi_status;
415 			uint32_t relative_offset;
416 			uint32_t reserved2;
417 			uint32_t transfer_length;
418 			uint32_t reserved3;
419 			struct dsd64 dsd;
420 		} status0;
421 		struct {
422 			uint16_t sense_length;
423 			__le16 flags;
424 			uint32_t residual;
425 			__le16 ox_id;
426 			uint16_t scsi_status;
427 			uint16_t response_len;
428 			uint16_t reserved;
429 			uint8_t sense_data[24];
430 		} status1;
431 	} u;
432 } __packed;
433 
434 /*
435  * ISP queue - CTIO type 7 from ISP 24xx to target driver
436  * returned entry structure.
437  */
438 struct ctio7_from_24xx {
439 	uint8_t	 entry_type;		    /* Entry type. */
440 	uint8_t	 entry_count;		    /* Entry count. */
441 	uint8_t	 sys_define;		    /* System defined. */
442 	uint8_t	 entry_status;		    /* Entry Status. */
443 	uint32_t handle;		    /* System defined handle */
444 	uint16_t status;
445 	uint16_t timeout;
446 	uint16_t dseg_count;		    /* Data segment count. */
447 	uint8_t  vp_index;
448 	uint8_t  reserved1[5];
449 	uint32_t exchange_address;
450 	uint16_t reserved2;
451 	uint16_t flags;
452 	uint32_t residual;
453 	uint16_t ox_id;
454 	uint16_t reserved3;
455 	uint32_t relative_offset;
456 	uint8_t  reserved4[24];
457 } __packed;
458 
459 /* CTIO7 flags values */
460 #define CTIO7_FLAGS_SEND_STATUS		BIT_15
461 #define CTIO7_FLAGS_TERMINATE		BIT_14
462 #define CTIO7_FLAGS_CONFORM_REQ		BIT_13
463 #define CTIO7_FLAGS_DONT_RET_CTIO	BIT_8
464 #define CTIO7_FLAGS_STATUS_MODE_0	0
465 #define CTIO7_FLAGS_STATUS_MODE_1	BIT_6
466 #define CTIO7_FLAGS_STATUS_MODE_2	BIT_7
467 #define CTIO7_FLAGS_EXPLICIT_CONFORM	BIT_5
468 #define CTIO7_FLAGS_CONFIRM_SATISF	BIT_4
469 #define CTIO7_FLAGS_DSD_PTR		BIT_2
470 #define CTIO7_FLAGS_DATA_IN		BIT_1 /* data to initiator */
471 #define CTIO7_FLAGS_DATA_OUT		BIT_0 /* data from initiator */
472 
473 #define ELS_PLOGI			0x3
474 #define ELS_FLOGI			0x4
475 #define ELS_LOGO			0x5
476 #define ELS_PRLI			0x20
477 #define ELS_PRLO			0x21
478 #define ELS_TPRLO			0x24
479 #define ELS_PDISC			0x50
480 #define ELS_ADISC			0x52
481 
482 /*
483  *CTIO Type CRC_2 IOCB
484  */
485 struct ctio_crc2_to_fw {
486 	uint8_t entry_type;		/* Entry type. */
487 #define CTIO_CRC2 0x7A
488 	uint8_t entry_count;		/* Entry count. */
489 	uint8_t sys_define;		/* System defined. */
490 	uint8_t entry_status;		/* Entry Status. */
491 
492 	uint32_t handle;		/* System handle. */
493 	uint16_t nport_handle;		/* N_PORT handle. */
494 	__le16 timeout;		/* Command timeout. */
495 
496 	uint16_t dseg_count;		/* Data segment count. */
497 	uint8_t  vp_index;
498 	uint8_t  add_flags;		/* additional flags */
499 #define CTIO_CRC2_AF_DIF_DSD_ENA BIT_3
500 
501 	uint8_t  initiator_id[3];	/* initiator ID */
502 	uint8_t  reserved1;
503 	uint32_t exchange_addr;		/* rcv exchange address */
504 	uint16_t reserved2;
505 	__le16 flags;			/* refer to CTIO7 flags values */
506 	uint32_t residual;
507 	__le16 ox_id;
508 	uint16_t scsi_status;
509 	__le32 relative_offset;
510 	uint32_t reserved5;
511 	__le32 transfer_length;		/* total fc transfer length */
512 	uint32_t reserved6;
513 	__le64	 crc_context_address __packed; /* Data segment address. */
514 	uint16_t crc_context_len;	/* Data segment length. */
515 	uint16_t reserved_1;		/* MUST be set to 0. */
516 };
517 
518 /* CTIO Type CRC_x Status IOCB */
519 struct ctio_crc_from_fw {
520 	uint8_t entry_type;		/* Entry type. */
521 	uint8_t entry_count;		/* Entry count. */
522 	uint8_t sys_define;		/* System defined. */
523 	uint8_t entry_status;		/* Entry Status. */
524 
525 	uint32_t handle;		/* System handle. */
526 	uint16_t status;
527 	uint16_t timeout;		/* Command timeout. */
528 	uint16_t dseg_count;		/* Data segment count. */
529 	uint32_t reserved1;
530 	uint16_t state_flags;
531 #define CTIO_CRC_SF_DIF_CHOPPED BIT_4
532 
533 	uint32_t exchange_address;	/* rcv exchange address */
534 	uint16_t reserved2;
535 	uint16_t flags;
536 	uint32_t resid_xfer_length;
537 	uint16_t ox_id;
538 	uint8_t  reserved3[12];
539 	uint16_t runt_guard;		/* reported runt blk guard */
540 	uint8_t  actual_dif[8];
541 	uint8_t  expected_dif[8];
542 } __packed;
543 
544 /*
545  * ISP queue - ABTS received/response entries structure definition for 24xx.
546  */
547 #define ABTS_RECV_24XX		0x54 /* ABTS received (for 24xx) */
548 #define ABTS_RESP_24XX		0x55 /* ABTS responce (for 24xx) */
549 
550 /*
551  * ISP queue -	ABTS received IOCB entry structure definition for 24xx.
552  *		The ABTS BLS received from the wire is sent to the
553  *		target driver by the ISP 24xx.
554  *		The IOCB is placed on the response queue.
555  */
556 struct abts_recv_from_24xx {
557 	uint8_t	 entry_type;		    /* Entry type. */
558 	uint8_t	 entry_count;		    /* Entry count. */
559 	uint8_t	 sys_define;		    /* System defined. */
560 	uint8_t	 entry_status;		    /* Entry Status. */
561 	uint8_t  reserved_1[6];
562 	uint16_t nport_handle;
563 	uint8_t  reserved_2[2];
564 	uint8_t  vp_index;
565 	uint8_t  reserved_3:4;
566 	uint8_t  sof_type:4;
567 	uint32_t exchange_address;
568 	struct fcp_hdr_le fcp_hdr_le;
569 	uint8_t  reserved_4[16];
570 	uint32_t exchange_addr_to_abort;
571 } __packed;
572 
573 #define ABTS_PARAM_ABORT_SEQ		BIT_0
574 
575 struct ba_acc_le {
576 	uint16_t reserved;
577 	uint8_t  seq_id_last;
578 	uint8_t  seq_id_valid;
579 #define SEQ_ID_VALID	0x80
580 #define SEQ_ID_INVALID	0x00
581 	uint16_t rx_id;
582 	uint16_t ox_id;
583 	uint16_t high_seq_cnt;
584 	uint16_t low_seq_cnt;
585 } __packed;
586 
587 struct ba_rjt_le {
588 	uint8_t vendor_uniq;
589 	uint8_t reason_expl;
590 	uint8_t reason_code;
591 #define BA_RJT_REASON_CODE_INVALID_COMMAND	0x1
592 #define BA_RJT_REASON_CODE_UNABLE_TO_PERFORM	0x9
593 	uint8_t reserved;
594 } __packed;
595 
596 /*
597  * ISP queue -	ABTS Response IOCB entry structure definition for 24xx.
598  *		The ABTS response to the ABTS received is sent by the
599  *		target driver to the ISP 24xx.
600  *		The IOCB is placed on the request queue.
601  */
602 struct abts_resp_to_24xx {
603 	uint8_t	 entry_type;		    /* Entry type. */
604 	uint8_t	 entry_count;		    /* Entry count. */
605 	uint8_t	 sys_define;		    /* System defined. */
606 	uint8_t	 entry_status;		    /* Entry Status. */
607 	uint32_t handle;
608 	uint16_t reserved_1;
609 	uint16_t nport_handle;
610 	uint16_t control_flags;
611 #define ABTS_CONTR_FLG_TERM_EXCHG	BIT_0
612 	uint8_t  vp_index;
613 	uint8_t  reserved_3:4;
614 	uint8_t  sof_type:4;
615 	uint32_t exchange_address;
616 	struct fcp_hdr_le fcp_hdr_le;
617 	union {
618 		struct ba_acc_le ba_acct;
619 		struct ba_rjt_le ba_rjt;
620 	} __packed payload;
621 	uint32_t reserved_4;
622 	uint32_t exchange_addr_to_abort;
623 } __packed;
624 
625 /*
626  * ISP queue -	ABTS Response IOCB from ISP24xx Firmware entry structure.
627  *		The ABTS response with completion status to the ABTS response
628  *		(sent by the target driver to the ISP 24xx) is sent by the
629  *		ISP24xx firmware to the target driver.
630  *		The IOCB is placed on the response queue.
631  */
632 struct abts_resp_from_24xx_fw {
633 	uint8_t	 entry_type;		    /* Entry type. */
634 	uint8_t	 entry_count;		    /* Entry count. */
635 	uint8_t	 sys_define;		    /* System defined. */
636 	uint8_t	 entry_status;		    /* Entry Status. */
637 	uint32_t handle;
638 	uint16_t compl_status;
639 #define ABTS_RESP_COMPL_SUCCESS		0
640 #define ABTS_RESP_COMPL_SUBCODE_ERROR	0x31
641 	uint16_t nport_handle;
642 	uint16_t reserved_1;
643 	uint8_t  reserved_2;
644 	uint8_t  reserved_3:4;
645 	uint8_t  sof_type:4;
646 	uint32_t exchange_address;
647 	struct fcp_hdr_le fcp_hdr_le;
648 	uint8_t reserved_4[8];
649 	uint32_t error_subcode1;
650 #define ABTS_RESP_SUBCODE_ERR_ABORTED_EXCH_NOT_TERM	0x1E
651 	uint32_t error_subcode2;
652 	uint32_t exchange_addr_to_abort;
653 } __packed;
654 
655 /********************************************************************\
656  * Type Definitions used by initiator & target halves
657 \********************************************************************/
658 
659 struct qla_tgt_mgmt_cmd;
660 struct fc_port;
661 struct qla_tgt_cmd;
662 
663 /*
664  * This structure provides a template of function calls that the
665  * target driver (from within qla_target.c) can issue to the
666  * target module (tcm_qla2xxx).
667  */
668 struct qla_tgt_func_tmpl {
669 	struct qla_tgt_cmd *(*find_cmd_by_tag)(struct fc_port *, uint64_t);
670 	int (*handle_cmd)(struct scsi_qla_host *, struct qla_tgt_cmd *,
671 			unsigned char *, uint32_t, int, int, int);
672 	void (*handle_data)(struct qla_tgt_cmd *);
673 	int (*handle_tmr)(struct qla_tgt_mgmt_cmd *, u64, uint16_t,
674 			uint32_t);
675 	void (*free_cmd)(struct qla_tgt_cmd *);
676 	void (*free_mcmd)(struct qla_tgt_mgmt_cmd *);
677 	void (*free_session)(struct fc_port *);
678 
679 	int (*check_initiator_node_acl)(struct scsi_qla_host *, unsigned char *,
680 					struct fc_port *);
681 	void (*update_sess)(struct fc_port *, port_id_t, uint16_t, bool);
682 	struct fc_port *(*find_sess_by_loop_id)(struct scsi_qla_host *,
683 						const uint16_t);
684 	struct fc_port *(*find_sess_by_s_id)(struct scsi_qla_host *,
685 						const uint8_t *);
686 	void (*clear_nacl_from_fcport_map)(struct fc_port *);
687 	void (*put_sess)(struct fc_port *);
688 	void (*shutdown_sess)(struct fc_port *);
689 	int (*get_dif_tags)(struct qla_tgt_cmd *cmd, uint16_t *pfw_prot_opts);
690 	int (*chk_dif_tags)(uint32_t tag);
691 	void (*add_target)(struct scsi_qla_host *);
692 	void (*remove_target)(struct scsi_qla_host *);
693 };
694 
695 int qla2x00_wait_for_hba_online(struct scsi_qla_host *);
696 
697 #include <target/target_core_base.h>
698 
699 #define QLA_TGT_TIMEOUT			10	/* in seconds */
700 
701 #define QLA_TGT_MAX_HW_PENDING_TIME	60 /* in seconds */
702 
703 /* Immediate notify status constants */
704 #define IMM_NTFY_LIP_RESET          0x000E
705 #define IMM_NTFY_LIP_LINK_REINIT    0x000F
706 #define IMM_NTFY_IOCB_OVERFLOW      0x0016
707 #define IMM_NTFY_ABORT_TASK         0x0020
708 #define IMM_NTFY_PORT_LOGOUT        0x0029
709 #define IMM_NTFY_PORT_CONFIG        0x002A
710 #define IMM_NTFY_GLBL_TPRLO         0x002D
711 #define IMM_NTFY_GLBL_LOGO          0x002E
712 #define IMM_NTFY_RESOURCE           0x0034
713 #define IMM_NTFY_MSG_RX             0x0036
714 #define IMM_NTFY_SRR                0x0045
715 #define IMM_NTFY_ELS                0x0046
716 
717 /* Immediate notify task flags */
718 #define IMM_NTFY_TASK_MGMT_SHIFT    8
719 
720 #define QLA_TGT_CLEAR_ACA               0x40
721 #define QLA_TGT_TARGET_RESET            0x20
722 #define QLA_TGT_LUN_RESET               0x10
723 #define QLA_TGT_CLEAR_TS                0x04
724 #define QLA_TGT_ABORT_TS                0x02
725 #define QLA_TGT_ABORT_ALL_SESS          0xFFFF
726 #define QLA_TGT_ABORT_ALL               0xFFFE
727 #define QLA_TGT_NEXUS_LOSS_SESS         0xFFFD
728 #define QLA_TGT_NEXUS_LOSS              0xFFFC
729 #define QLA_TGT_ABTS			0xFFFB
730 #define QLA_TGT_2G_ABORT_TASK		0xFFFA
731 
732 /* Notify Acknowledge flags */
733 #define NOTIFY_ACK_RES_COUNT        BIT_8
734 #define NOTIFY_ACK_CLEAR_LIP_RESET  BIT_5
735 #define NOTIFY_ACK_TM_RESP_CODE_VALID BIT_4
736 
737 /* Command's states */
738 #define QLA_TGT_STATE_NEW		0 /* New command + target processing */
739 #define QLA_TGT_STATE_NEED_DATA		1 /* target needs data to continue */
740 #define QLA_TGT_STATE_DATA_IN		2 /* Data arrived + target processing */
741 #define QLA_TGT_STATE_PROCESSED		3 /* target done processing */
742 
743 /* ATIO task_codes field */
744 #define ATIO_SIMPLE_QUEUE           0
745 #define ATIO_HEAD_OF_QUEUE          1
746 #define ATIO_ORDERED_QUEUE          2
747 #define ATIO_ACA_QUEUE              4
748 #define ATIO_UNTAGGED               5
749 
750 /* TM failed response codes, see FCP (9.4.11 FCP_RSP_INFO) */
751 #define	FC_TM_SUCCESS               0
752 #define	FC_TM_BAD_FCP_DATA          1
753 #define	FC_TM_BAD_CMD               2
754 #define	FC_TM_FCP_DATA_MISMATCH     3
755 #define	FC_TM_REJECT                4
756 #define FC_TM_FAILED                5
757 
758 #define QLA_TGT_SENSE_VALID(sense)  ((sense != NULL) && \
759 				(((const uint8_t *)(sense))[0] & 0x70) == 0x70)
760 
761 struct qla_port_24xx_data {
762 	uint8_t port_name[WWN_SIZE];
763 	uint16_t loop_id;
764 	uint16_t reserved;
765 };
766 
767 struct qla_qpair_hint {
768 	struct list_head hint_elem;
769 	struct qla_qpair *qpair;
770 	u16 cpuid;
771 	uint8_t cmd_cnt;
772 };
773 
774 struct qla_tgt {
775 	struct scsi_qla_host *vha;
776 	struct qla_hw_data *ha;
777 	struct btree_head64 lun_qpair_map;
778 	struct qla_qpair_hint *qphints;
779 	/*
780 	 * To sync between IRQ handlers and qlt_target_release(). Needed,
781 	 * because req_pkt() can drop/reaquire HW lock inside. Protected by
782 	 * HW lock.
783 	 */
784 	int atio_irq_cmd_count;
785 
786 	int sg_tablesize;
787 
788 	/* Target's flags, serialized by pha->hardware_lock */
789 	unsigned int link_reinit_iocb_pending:1;
790 
791 	/*
792 	 * Protected by tgt_mutex AND hardware_lock for writing and tgt_mutex
793 	 * OR hardware_lock for reading.
794 	 */
795 	int tgt_stop; /* the target mode driver is being stopped */
796 	int tgt_stopped; /* the target mode driver has been stopped */
797 
798 	/* Count of sessions refering qla_tgt. Protected by hardware_lock. */
799 	int sess_count;
800 
801 	/* Protected by hardware_lock */
802 	struct list_head del_sess_list;
803 
804 	spinlock_t sess_work_lock;
805 	struct list_head sess_works_list;
806 	struct work_struct sess_work;
807 
808 	struct imm_ntfy_from_isp link_reinit_iocb;
809 	wait_queue_head_t waitQ;
810 	int notify_ack_expected;
811 	int abts_resp_expected;
812 	int modify_lun_expected;
813 	atomic_t tgt_global_resets_count;
814 	struct list_head tgt_list_entry;
815 };
816 
817 struct qla_tgt_sess_op {
818 	struct scsi_qla_host *vha;
819 	uint32_t chip_reset;
820 	struct atio_from_isp atio;
821 	struct work_struct work;
822 	struct list_head cmd_list;
823 	bool aborted;
824 	struct rsp_que *rsp;
825 };
826 
827 enum trace_flags {
828 	TRC_NEW_CMD = BIT_0,
829 	TRC_DO_WORK = BIT_1,
830 	TRC_DO_WORK_ERR = BIT_2,
831 	TRC_XFR_RDY = BIT_3,
832 	TRC_XMIT_DATA = BIT_4,
833 	TRC_XMIT_STATUS = BIT_5,
834 	TRC_SRR_RSP =  BIT_6,
835 	TRC_SRR_XRDY = BIT_7,
836 	TRC_SRR_TERM = BIT_8,
837 	TRC_SRR_CTIO = BIT_9,
838 	TRC_FLUSH = BIT_10,
839 	TRC_CTIO_ERR = BIT_11,
840 	TRC_CTIO_DONE = BIT_12,
841 	TRC_CTIO_ABORTED =  BIT_13,
842 	TRC_CTIO_STRANGE = BIT_14,
843 	TRC_CMD_DONE = BIT_15,
844 	TRC_CMD_CHK_STOP = BIT_16,
845 	TRC_CMD_FREE = BIT_17,
846 	TRC_DATA_IN = BIT_18,
847 	TRC_ABORT = BIT_19,
848 	TRC_DIF_ERR = BIT_20,
849 };
850 
851 struct qla_tgt_cmd {
852 	/*
853 	 * Do not move cmd_type field. it needs to line up with srb->cmd_type
854 	 */
855 	uint8_t cmd_type;
856 	uint8_t pad[7];
857 	struct se_cmd se_cmd;
858 	struct fc_port *sess;
859 	struct qla_qpair *qpair;
860 	uint32_t reset_count;
861 	int state;
862 	struct work_struct work;
863 	/* Sense buffer that will be mapped into outgoing status */
864 	unsigned char sense_buffer[TRANSPORT_SENSE_BUFFER];
865 
866 	spinlock_t cmd_lock;
867 	/* to save extra sess dereferences */
868 	unsigned int conf_compl_supported:1;
869 	unsigned int sg_mapped:1;
870 	unsigned int free_sg:1;
871 	unsigned int write_data_transferred:1;
872 	unsigned int q_full:1;
873 	unsigned int term_exchg:1;
874 	unsigned int cmd_sent_to_fw:1;
875 	unsigned int cmd_in_wq:1;
876 
877 	/*
878 	 * This variable may be set from outside the LIO and I/O completion
879 	 * callback functions. Do not declare this member variable as a
880 	 * bitfield to avoid a read-modify-write operation when this variable
881 	 * is set.
882 	 */
883 	unsigned int aborted;
884 
885 	struct scatterlist *sg;	/* cmd data buffer SG vector */
886 	int sg_cnt;		/* SG segments count */
887 	int bufflen;		/* cmd buffer length */
888 	int offset;
889 	u64 unpacked_lun;
890 	enum dma_data_direction dma_data_direction;
891 
892 	uint16_t ctio_flags;
893 	uint16_t vp_idx;
894 	uint16_t loop_id;	/* to save extra sess dereferences */
895 	struct qla_tgt *tgt;	/* to save extra sess dereferences */
896 	struct scsi_qla_host *vha;
897 	struct list_head cmd_list;
898 
899 	struct atio_from_isp atio;
900 
901 	uint8_t ctx_dsd_alloced;
902 
903 	/* T10-DIF */
904 #define DIF_ERR_NONE 0
905 #define DIF_ERR_GRD 1
906 #define DIF_ERR_REF 2
907 #define DIF_ERR_APP 3
908 	int8_t dif_err_code;
909 	struct scatterlist *prot_sg;
910 	uint32_t prot_sg_cnt;
911 	uint32_t blk_sz, num_blks;
912 	uint8_t scsi_status, sense_key, asc, ascq;
913 
914 	struct crc_context *ctx;
915 	uint8_t		*cdb;
916 	uint64_t	lba;
917 	uint16_t	a_guard, e_guard, a_app_tag, e_app_tag;
918 	uint32_t	a_ref_tag, e_ref_tag;
919 #define DIF_BUNDL_DMA_VALID 1
920 	uint16_t prot_flags;
921 
922 	uint64_t jiffies_at_alloc;
923 	uint64_t jiffies_at_free;
924 
925 	enum trace_flags trc_flags;
926 };
927 
928 struct qla_tgt_sess_work_param {
929 	struct list_head sess_works_list_entry;
930 
931 #define QLA_TGT_SESS_WORK_ABORT	1
932 #define QLA_TGT_SESS_WORK_TM	2
933 	int type;
934 
935 	union {
936 		struct abts_recv_from_24xx abts;
937 		struct imm_ntfy_from_isp tm_iocb;
938 		struct atio_from_isp tm_iocb2;
939 	};
940 };
941 
942 struct qla_tgt_mgmt_cmd {
943 	uint8_t cmd_type;
944 	uint8_t pad[3];
945 	uint16_t tmr_func;
946 	uint8_t fc_tm_rsp;
947 	uint8_t abort_io_attr;
948 	struct fc_port *sess;
949 	struct qla_qpair *qpair;
950 	struct scsi_qla_host *vha;
951 	struct se_cmd se_cmd;
952 	struct work_struct free_work;
953 	unsigned int flags;
954 #define QLA24XX_MGMT_SEND_NACK	BIT_0
955 #define QLA24XX_MGMT_ABORT_IO_ATTR_VALID BIT_1
956 	uint32_t reset_count;
957 	struct work_struct work;
958 	uint64_t unpacked_lun;
959 	union {
960 		struct atio_from_isp atio;
961 		struct imm_ntfy_from_isp imm_ntfy;
962 		struct abts_recv_from_24xx abts;
963 	} __packed orig_iocb;
964 };
965 
966 struct qla_tgt_prm {
967 	struct qla_tgt_cmd *cmd;
968 	struct qla_tgt *tgt;
969 	void *pkt;
970 	struct scatterlist *sg;	/* cmd data buffer SG vector */
971 	unsigned char *sense_buffer;
972 	int seg_cnt;
973 	int req_cnt;
974 	uint16_t rq_result;
975 	int sense_buffer_len;
976 	int residual;
977 	int add_status_pkt;
978 	/* dif */
979 	struct scatterlist *prot_sg;
980 	uint16_t prot_seg_cnt;
981 	uint16_t tot_dsds;
982 };
983 
984 /* Check for Switch reserved address */
985 #define IS_SW_RESV_ADDR(_s_id) \
986 	((_s_id.b.domain == 0xff) && ((_s_id.b.area & 0xf0) == 0xf0))
987 
988 #define QLA_TGT_XMIT_DATA		1
989 #define QLA_TGT_XMIT_STATUS		2
990 #define QLA_TGT_XMIT_ALL		(QLA_TGT_XMIT_STATUS|QLA_TGT_XMIT_DATA)
991 
992 
993 extern struct qla_tgt_data qla_target;
994 
995 /*
996  * Function prototypes for qla_target.c logic used by qla2xxx LLD code.
997  */
998 extern int qlt_add_target(struct qla_hw_data *, struct scsi_qla_host *);
999 extern int qlt_remove_target(struct qla_hw_data *, struct scsi_qla_host *);
1000 extern int qlt_lport_register(void *, u64, u64, u64,
1001 			int (*callback)(struct scsi_qla_host *, void *, u64, u64));
1002 extern void qlt_lport_deregister(struct scsi_qla_host *);
1003 extern void qlt_unreg_sess(struct fc_port *);
1004 extern void qlt_fc_port_added(struct scsi_qla_host *, fc_port_t *);
1005 extern void qlt_fc_port_deleted(struct scsi_qla_host *, fc_port_t *, int);
1006 extern int __init qlt_init(void);
1007 extern void qlt_exit(void);
1008 extern void qlt_update_vp_map(struct scsi_qla_host *, int);
1009 extern void qlt_free_session_done(struct work_struct *);
1010 /*
1011  * This macro is used during early initializations when host->active_mode
1012  * is not set. Right now, ha value is ignored.
1013  */
1014 #define QLA_TGT_MODE_ENABLED() (ql2x_ini_mode != QLA2XXX_INI_MODE_ENABLED)
1015 
1016 extern int ql2x_ini_mode;
1017 
1018 static inline bool qla_tgt_mode_enabled(struct scsi_qla_host *ha)
1019 {
1020 	return ha->host->active_mode == MODE_TARGET;
1021 }
1022 
1023 static inline bool qla_ini_mode_enabled(struct scsi_qla_host *ha)
1024 {
1025 	return ha->host->active_mode == MODE_INITIATOR;
1026 }
1027 
1028 static inline bool qla_dual_mode_enabled(struct scsi_qla_host *ha)
1029 {
1030 	return (ha->host->active_mode == MODE_DUAL);
1031 }
1032 
1033 static inline uint32_t sid_to_key(const uint8_t *s_id)
1034 {
1035 	uint32_t key;
1036 
1037 	key = (((unsigned long)s_id[0] << 16) |
1038 	       ((unsigned long)s_id[1] << 8) |
1039 	       (unsigned long)s_id[2]);
1040 	return key;
1041 }
1042 
1043 static inline void sid_to_portid(const uint8_t *s_id, port_id_t *p)
1044 {
1045 	memset(p, 0, sizeof(*p));
1046 	p->b.domain = s_id[0];
1047 	p->b.area = s_id[1];
1048 	p->b.al_pa = s_id[2];
1049 }
1050 
1051 /*
1052  * Exported symbols from qla_target.c LLD logic used by qla2xxx code..
1053  */
1054 extern void qlt_response_pkt_all_vps(struct scsi_qla_host *, struct rsp_que *,
1055 	response_t *);
1056 extern int qlt_rdy_to_xfer(struct qla_tgt_cmd *);
1057 extern int qlt_xmit_response(struct qla_tgt_cmd *, int, uint8_t);
1058 extern int qlt_abort_cmd(struct qla_tgt_cmd *);
1059 extern void qlt_xmit_tm_rsp(struct qla_tgt_mgmt_cmd *);
1060 extern void qlt_free_mcmd(struct qla_tgt_mgmt_cmd *);
1061 extern void qlt_free_cmd(struct qla_tgt_cmd *cmd);
1062 extern void qlt_async_event(uint16_t, struct scsi_qla_host *, uint16_t *);
1063 extern void qlt_enable_vha(struct scsi_qla_host *);
1064 extern void qlt_vport_create(struct scsi_qla_host *, struct qla_hw_data *);
1065 extern u8 qlt_rff_id(struct scsi_qla_host *);
1066 extern void qlt_init_atio_q_entries(struct scsi_qla_host *);
1067 extern void qlt_24xx_process_atio_queue(struct scsi_qla_host *, uint8_t);
1068 extern void qlt_24xx_config_rings(struct scsi_qla_host *);
1069 extern void qlt_24xx_config_nvram_stage1(struct scsi_qla_host *,
1070 	struct nvram_24xx *);
1071 extern void qlt_24xx_config_nvram_stage2(struct scsi_qla_host *,
1072 	struct init_cb_24xx *);
1073 extern void qlt_81xx_config_nvram_stage2(struct scsi_qla_host *,
1074 	struct init_cb_81xx *);
1075 extern void qlt_81xx_config_nvram_stage1(struct scsi_qla_host *,
1076 	struct nvram_81xx *);
1077 extern int qlt_24xx_process_response_error(struct scsi_qla_host *,
1078 	struct sts_entry_24xx *);
1079 extern void qlt_modify_vp_config(struct scsi_qla_host *,
1080 	struct vp_config_entry_24xx *);
1081 extern void qlt_probe_one_stage1(struct scsi_qla_host *, struct qla_hw_data *);
1082 extern int qlt_mem_alloc(struct qla_hw_data *);
1083 extern void qlt_mem_free(struct qla_hw_data *);
1084 extern int qlt_stop_phase1(struct qla_tgt *);
1085 extern void qlt_stop_phase2(struct qla_tgt *);
1086 extern irqreturn_t qla83xx_msix_atio_q(int, void *);
1087 extern void qlt_83xx_iospace_config(struct qla_hw_data *);
1088 extern int qlt_free_qfull_cmds(struct qla_qpair *);
1089 extern void qlt_logo_completion_handler(fc_port_t *, int);
1090 extern void qlt_do_generation_tick(struct scsi_qla_host *, int *);
1091 
1092 void qlt_send_resp_ctio(struct qla_qpair *, struct qla_tgt_cmd *, uint8_t,
1093     uint8_t, uint8_t, uint8_t);
1094 
1095 #endif /* __QLA_TARGET_H */
1096