1 /*
2  * SCSI Primary Commands (SPC) parsing and emulation.
3  *
4  * (c) Copyright 2002-2013 Datera, Inc.
5  *
6  * Nicholas A. Bellinger <nab@kernel.org>
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
21  */
22 
23 #include <linux/kernel.h>
24 #include <linux/module.h>
25 #include <asm/unaligned.h>
26 
27 #include <scsi/scsi_proto.h>
28 #include <scsi/scsi_common.h>
29 #include <scsi/scsi_tcq.h>
30 
31 #include <target/target_core_base.h>
32 #include <target/target_core_backend.h>
33 #include <target/target_core_fabric.h>
34 
35 #include "target_core_internal.h"
36 #include "target_core_alua.h"
37 #include "target_core_pr.h"
38 #include "target_core_ua.h"
39 #include "target_core_xcopy.h"
40 
41 static void spc_fill_alua_data(struct se_lun *lun, unsigned char *buf)
42 {
43 	struct t10_alua_tg_pt_gp *tg_pt_gp;
44 
45 	/*
46 	 * Set SCCS for MAINTENANCE_IN + REPORT_TARGET_PORT_GROUPS.
47 	 */
48 	buf[5]	= 0x80;
49 
50 	/*
51 	 * Set TPGS field for explicit and/or implicit ALUA access type
52 	 * and opteration.
53 	 *
54 	 * See spc4r17 section 6.4.2 Table 135
55 	 */
56 	spin_lock(&lun->lun_tg_pt_gp_lock);
57 	tg_pt_gp = lun->lun_tg_pt_gp;
58 	if (tg_pt_gp)
59 		buf[5] |= tg_pt_gp->tg_pt_gp_alua_access_type;
60 	spin_unlock(&lun->lun_tg_pt_gp_lock);
61 }
62 
63 sense_reason_t
64 spc_emulate_inquiry_std(struct se_cmd *cmd, unsigned char *buf)
65 {
66 	struct se_lun *lun = cmd->se_lun;
67 	struct se_device *dev = cmd->se_dev;
68 	struct se_session *sess = cmd->se_sess;
69 
70 	/* Set RMB (removable media) for tape devices */
71 	if (dev->transport->get_device_type(dev) == TYPE_TAPE)
72 		buf[1] = 0x80;
73 
74 	buf[2] = 0x05; /* SPC-3 */
75 
76 	/*
77 	 * NORMACA and HISUP = 0, RESPONSE DATA FORMAT = 2
78 	 *
79 	 * SPC4 says:
80 	 *   A RESPONSE DATA FORMAT field set to 2h indicates that the
81 	 *   standard INQUIRY data is in the format defined in this
82 	 *   standard. Response data format values less than 2h are
83 	 *   obsolete. Response data format values greater than 2h are
84 	 *   reserved.
85 	 */
86 	buf[3] = 2;
87 
88 	/*
89 	 * Enable SCCS and TPGS fields for Emulated ALUA
90 	 */
91 	spc_fill_alua_data(lun, buf);
92 
93 	/*
94 	 * Set Third-Party Copy (3PC) bit to indicate support for EXTENDED_COPY
95 	 */
96 	if (dev->dev_attrib.emulate_3pc)
97 		buf[5] |= 0x8;
98 	/*
99 	 * Set Protection (PROTECT) bit when DIF has been enabled on the
100 	 * device, and the fabric supports VERIFY + PASS.  Also report
101 	 * PROTECT=1 if sess_prot_type has been configured to allow T10-PI
102 	 * to unprotected devices.
103 	 */
104 	if (sess->sup_prot_ops & (TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS)) {
105 		if (dev->dev_attrib.pi_prot_type || cmd->se_sess->sess_prot_type)
106 			buf[5] |= 0x1;
107 	}
108 
109 	buf[7] = 0x2; /* CmdQue=1 */
110 
111 	memcpy(&buf[8], "LIO-ORG ", 8);
112 	memset(&buf[16], 0x20, 16);
113 	memcpy(&buf[16], dev->t10_wwn.model,
114 	       min_t(size_t, strlen(dev->t10_wwn.model), 16));
115 	memcpy(&buf[32], dev->t10_wwn.revision,
116 	       min_t(size_t, strlen(dev->t10_wwn.revision), 4));
117 	buf[4] = 31; /* Set additional length to 31 */
118 
119 	return 0;
120 }
121 EXPORT_SYMBOL(spc_emulate_inquiry_std);
122 
123 /* unit serial number */
124 static sense_reason_t
125 spc_emulate_evpd_80(struct se_cmd *cmd, unsigned char *buf)
126 {
127 	struct se_device *dev = cmd->se_dev;
128 	u16 len;
129 
130 	if (dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL) {
131 		len = sprintf(&buf[4], "%s", dev->t10_wwn.unit_serial);
132 		len++; /* Extra Byte for NULL Terminator */
133 		buf[3] = len;
134 	}
135 	return 0;
136 }
137 
138 void spc_parse_naa_6h_vendor_specific(struct se_device *dev,
139 				      unsigned char *buf)
140 {
141 	unsigned char *p = &dev->t10_wwn.unit_serial[0];
142 	int cnt;
143 	bool next = true;
144 
145 	/*
146 	 * Generate up to 36 bits of VENDOR SPECIFIC IDENTIFIER starting on
147 	 * byte 3 bit 3-0 for NAA IEEE Registered Extended DESIGNATOR field
148 	 * format, followed by 64 bits of VENDOR SPECIFIC IDENTIFIER EXTENSION
149 	 * to complete the payload.  These are based from VPD=0x80 PRODUCT SERIAL
150 	 * NUMBER set via vpd_unit_serial in target_core_configfs.c to ensure
151 	 * per device uniqeness.
152 	 */
153 	for (cnt = 0; *p && cnt < 13; p++) {
154 		int val = hex_to_bin(*p);
155 
156 		if (val < 0)
157 			continue;
158 
159 		if (next) {
160 			next = false;
161 			buf[cnt++] |= val;
162 		} else {
163 			next = true;
164 			buf[cnt] = val << 4;
165 		}
166 	}
167 }
168 
169 /*
170  * Device identification VPD, for a complete list of
171  * DESIGNATOR TYPEs see spc4r17 Table 459.
172  */
173 sense_reason_t
174 spc_emulate_evpd_83(struct se_cmd *cmd, unsigned char *buf)
175 {
176 	struct se_device *dev = cmd->se_dev;
177 	struct se_lun *lun = cmd->se_lun;
178 	struct se_portal_group *tpg = NULL;
179 	struct t10_alua_lu_gp_member *lu_gp_mem;
180 	struct t10_alua_tg_pt_gp *tg_pt_gp;
181 	unsigned char *prod = &dev->t10_wwn.model[0];
182 	u32 prod_len;
183 	u32 unit_serial_len, off = 0;
184 	u16 len = 0, id_len;
185 
186 	off = 4;
187 
188 	/*
189 	 * NAA IEEE Registered Extended Assigned designator format, see
190 	 * spc4r17 section 7.7.3.6.5
191 	 *
192 	 * We depend upon a target_core_mod/ConfigFS provided
193 	 * /sys/kernel/config/target/core/$HBA/$DEV/wwn/vpd_unit_serial
194 	 * value in order to return the NAA id.
195 	 */
196 	if (!(dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL))
197 		goto check_t10_vend_desc;
198 
199 	/* CODE SET == Binary */
200 	buf[off++] = 0x1;
201 
202 	/* Set ASSOCIATION == addressed logical unit: 0)b */
203 	buf[off] = 0x00;
204 
205 	/* Identifier/Designator type == NAA identifier */
206 	buf[off++] |= 0x3;
207 	off++;
208 
209 	/* Identifier/Designator length */
210 	buf[off++] = 0x10;
211 
212 	/*
213 	 * Start NAA IEEE Registered Extended Identifier/Designator
214 	 */
215 	buf[off++] = (0x6 << 4);
216 
217 	/*
218 	 * Use OpenFabrics IEEE Company ID: 00 14 05
219 	 */
220 	buf[off++] = 0x01;
221 	buf[off++] = 0x40;
222 	buf[off] = (0x5 << 4);
223 
224 	/*
225 	 * Return ConfigFS Unit Serial Number information for
226 	 * VENDOR_SPECIFIC_IDENTIFIER and
227 	 * VENDOR_SPECIFIC_IDENTIFIER_EXTENTION
228 	 */
229 	spc_parse_naa_6h_vendor_specific(dev, &buf[off]);
230 
231 	len = 20;
232 	off = (len + 4);
233 
234 check_t10_vend_desc:
235 	/*
236 	 * T10 Vendor Identifier Page, see spc4r17 section 7.7.3.4
237 	 */
238 	id_len = 8; /* For Vendor field */
239 	prod_len = 4; /* For VPD Header */
240 	prod_len += 8; /* For Vendor field */
241 	prod_len += strlen(prod);
242 	prod_len++; /* For : */
243 
244 	if (dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL) {
245 		unit_serial_len = strlen(&dev->t10_wwn.unit_serial[0]);
246 		unit_serial_len++; /* For NULL Terminator */
247 
248 		id_len += sprintf(&buf[off+12], "%s:%s", prod,
249 				&dev->t10_wwn.unit_serial[0]);
250 	}
251 	buf[off] = 0x2; /* ASCII */
252 	buf[off+1] = 0x1; /* T10 Vendor ID */
253 	buf[off+2] = 0x0;
254 	memcpy(&buf[off+4], "LIO-ORG", 8);
255 	/* Extra Byte for NULL Terminator */
256 	id_len++;
257 	/* Identifier Length */
258 	buf[off+3] = id_len;
259 	/* Header size for Designation descriptor */
260 	len += (id_len + 4);
261 	off += (id_len + 4);
262 
263 	if (1) {
264 		struct t10_alua_lu_gp *lu_gp;
265 		u32 padding, scsi_name_len, scsi_target_len;
266 		u16 lu_gp_id = 0;
267 		u16 tg_pt_gp_id = 0;
268 		u16 tpgt;
269 
270 		tpg = lun->lun_tpg;
271 		/*
272 		 * Relative target port identifer, see spc4r17
273 		 * section 7.7.3.7
274 		 *
275 		 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
276 		 * section 7.5.1 Table 362
277 		 */
278 		buf[off] = tpg->proto_id << 4;
279 		buf[off++] |= 0x1; /* CODE SET == Binary */
280 		buf[off] = 0x80; /* Set PIV=1 */
281 		/* Set ASSOCIATION == target port: 01b */
282 		buf[off] |= 0x10;
283 		/* DESIGNATOR TYPE == Relative target port identifer */
284 		buf[off++] |= 0x4;
285 		off++; /* Skip over Reserved */
286 		buf[off++] = 4; /* DESIGNATOR LENGTH */
287 		/* Skip over Obsolete field in RTPI payload
288 		 * in Table 472 */
289 		off += 2;
290 		buf[off++] = ((lun->lun_rtpi >> 8) & 0xff);
291 		buf[off++] = (lun->lun_rtpi & 0xff);
292 		len += 8; /* Header size + Designation descriptor */
293 		/*
294 		 * Target port group identifier, see spc4r17
295 		 * section 7.7.3.8
296 		 *
297 		 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
298 		 * section 7.5.1 Table 362
299 		 */
300 		spin_lock(&lun->lun_tg_pt_gp_lock);
301 		tg_pt_gp = lun->lun_tg_pt_gp;
302 		if (!tg_pt_gp) {
303 			spin_unlock(&lun->lun_tg_pt_gp_lock);
304 			goto check_lu_gp;
305 		}
306 		tg_pt_gp_id = tg_pt_gp->tg_pt_gp_id;
307 		spin_unlock(&lun->lun_tg_pt_gp_lock);
308 
309 		buf[off] = tpg->proto_id << 4;
310 		buf[off++] |= 0x1; /* CODE SET == Binary */
311 		buf[off] = 0x80; /* Set PIV=1 */
312 		/* Set ASSOCIATION == target port: 01b */
313 		buf[off] |= 0x10;
314 		/* DESIGNATOR TYPE == Target port group identifier */
315 		buf[off++] |= 0x5;
316 		off++; /* Skip over Reserved */
317 		buf[off++] = 4; /* DESIGNATOR LENGTH */
318 		off += 2; /* Skip over Reserved Field */
319 		buf[off++] = ((tg_pt_gp_id >> 8) & 0xff);
320 		buf[off++] = (tg_pt_gp_id & 0xff);
321 		len += 8; /* Header size + Designation descriptor */
322 		/*
323 		 * Logical Unit Group identifier, see spc4r17
324 		 * section 7.7.3.8
325 		 */
326 check_lu_gp:
327 		lu_gp_mem = dev->dev_alua_lu_gp_mem;
328 		if (!lu_gp_mem)
329 			goto check_scsi_name;
330 
331 		spin_lock(&lu_gp_mem->lu_gp_mem_lock);
332 		lu_gp = lu_gp_mem->lu_gp;
333 		if (!lu_gp) {
334 			spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
335 			goto check_scsi_name;
336 		}
337 		lu_gp_id = lu_gp->lu_gp_id;
338 		spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
339 
340 		buf[off++] |= 0x1; /* CODE SET == Binary */
341 		/* DESIGNATOR TYPE == Logical Unit Group identifier */
342 		buf[off++] |= 0x6;
343 		off++; /* Skip over Reserved */
344 		buf[off++] = 4; /* DESIGNATOR LENGTH */
345 		off += 2; /* Skip over Reserved Field */
346 		buf[off++] = ((lu_gp_id >> 8) & 0xff);
347 		buf[off++] = (lu_gp_id & 0xff);
348 		len += 8; /* Header size + Designation descriptor */
349 		/*
350 		 * SCSI name string designator, see spc4r17
351 		 * section 7.7.3.11
352 		 *
353 		 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
354 		 * section 7.5.1 Table 362
355 		 */
356 check_scsi_name:
357 		buf[off] = tpg->proto_id << 4;
358 		buf[off++] |= 0x3; /* CODE SET == UTF-8 */
359 		buf[off] = 0x80; /* Set PIV=1 */
360 		/* Set ASSOCIATION == target port: 01b */
361 		buf[off] |= 0x10;
362 		/* DESIGNATOR TYPE == SCSI name string */
363 		buf[off++] |= 0x8;
364 		off += 2; /* Skip over Reserved and length */
365 		/*
366 		 * SCSI name string identifer containing, $FABRIC_MOD
367 		 * dependent information.  For LIO-Target and iSCSI
368 		 * Target Port, this means "<iSCSI name>,t,0x<TPGT> in
369 		 * UTF-8 encoding.
370 		 */
371 		tpgt = tpg->se_tpg_tfo->tpg_get_tag(tpg);
372 		scsi_name_len = sprintf(&buf[off], "%s,t,0x%04x",
373 					tpg->se_tpg_tfo->tpg_get_wwn(tpg), tpgt);
374 		scsi_name_len += 1 /* Include  NULL terminator */;
375 		/*
376 		 * The null-terminated, null-padded (see 4.4.2) SCSI
377 		 * NAME STRING field contains a UTF-8 format string.
378 		 * The number of bytes in the SCSI NAME STRING field
379 		 * (i.e., the value in the DESIGNATOR LENGTH field)
380 		 * shall be no larger than 256 and shall be a multiple
381 		 * of four.
382 		 */
383 		padding = ((-scsi_name_len) & 3);
384 		if (padding)
385 			scsi_name_len += padding;
386 		if (scsi_name_len > 256)
387 			scsi_name_len = 256;
388 
389 		buf[off-1] = scsi_name_len;
390 		off += scsi_name_len;
391 		/* Header size + Designation descriptor */
392 		len += (scsi_name_len + 4);
393 
394 		/*
395 		 * Target device designator
396 		 */
397 		buf[off] = tpg->proto_id << 4;
398 		buf[off++] |= 0x3; /* CODE SET == UTF-8 */
399 		buf[off] = 0x80; /* Set PIV=1 */
400 		/* Set ASSOCIATION == target device: 10b */
401 		buf[off] |= 0x20;
402 		/* DESIGNATOR TYPE == SCSI name string */
403 		buf[off++] |= 0x8;
404 		off += 2; /* Skip over Reserved and length */
405 		/*
406 		 * SCSI name string identifer containing, $FABRIC_MOD
407 		 * dependent information.  For LIO-Target and iSCSI
408 		 * Target Port, this means "<iSCSI name>" in
409 		 * UTF-8 encoding.
410 		 */
411 		scsi_target_len = sprintf(&buf[off], "%s",
412 					  tpg->se_tpg_tfo->tpg_get_wwn(tpg));
413 		scsi_target_len += 1 /* Include  NULL terminator */;
414 		/*
415 		 * The null-terminated, null-padded (see 4.4.2) SCSI
416 		 * NAME STRING field contains a UTF-8 format string.
417 		 * The number of bytes in the SCSI NAME STRING field
418 		 * (i.e., the value in the DESIGNATOR LENGTH field)
419 		 * shall be no larger than 256 and shall be a multiple
420 		 * of four.
421 		 */
422 		padding = ((-scsi_target_len) & 3);
423 		if (padding)
424 			scsi_target_len += padding;
425 		if (scsi_target_len > 256)
426 			scsi_target_len = 256;
427 
428 		buf[off-1] = scsi_target_len;
429 		off += scsi_target_len;
430 
431 		/* Header size + Designation descriptor */
432 		len += (scsi_target_len + 4);
433 	}
434 	buf[2] = ((len >> 8) & 0xff);
435 	buf[3] = (len & 0xff); /* Page Length for VPD 0x83 */
436 	return 0;
437 }
438 EXPORT_SYMBOL(spc_emulate_evpd_83);
439 
440 /* Extended INQUIRY Data VPD Page */
441 static sense_reason_t
442 spc_emulate_evpd_86(struct se_cmd *cmd, unsigned char *buf)
443 {
444 	struct se_device *dev = cmd->se_dev;
445 	struct se_session *sess = cmd->se_sess;
446 
447 	buf[3] = 0x3c;
448 	/*
449 	 * Set GRD_CHK + REF_CHK for TYPE1 protection, or GRD_CHK
450 	 * only for TYPE3 protection.
451 	 */
452 	if (sess->sup_prot_ops & (TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS)) {
453 		if (dev->dev_attrib.pi_prot_type == TARGET_DIF_TYPE1_PROT ||
454 		    cmd->se_sess->sess_prot_type == TARGET_DIF_TYPE1_PROT)
455 			buf[4] = 0x5;
456 		else if (dev->dev_attrib.pi_prot_type == TARGET_DIF_TYPE3_PROT ||
457 			cmd->se_sess->sess_prot_type == TARGET_DIF_TYPE3_PROT)
458 			buf[4] = 0x4;
459 	}
460 
461 	/* Set HEADSUP, ORDSUP, SIMPSUP */
462 	buf[5] = 0x07;
463 
464 	/* If WriteCache emulation is enabled, set V_SUP */
465 	if (target_check_wce(dev))
466 		buf[6] = 0x01;
467 	/* If an LBA map is present set R_SUP */
468 	spin_lock(&cmd->se_dev->t10_alua.lba_map_lock);
469 	if (!list_empty(&dev->t10_alua.lba_map_list))
470 		buf[8] = 0x10;
471 	spin_unlock(&cmd->se_dev->t10_alua.lba_map_lock);
472 	return 0;
473 }
474 
475 /* Block Limits VPD page */
476 static sense_reason_t
477 spc_emulate_evpd_b0(struct se_cmd *cmd, unsigned char *buf)
478 {
479 	struct se_device *dev = cmd->se_dev;
480 	int have_tp = 0;
481 	int opt, min;
482 
483 	/*
484 	 * Following spc3r22 section 6.5.3 Block Limits VPD page, when
485 	 * emulate_tpu=1 or emulate_tpws=1 we will be expect a
486 	 * different page length for Thin Provisioning.
487 	 */
488 	if (dev->dev_attrib.emulate_tpu || dev->dev_attrib.emulate_tpws)
489 		have_tp = 1;
490 
491 	buf[0] = dev->transport->get_device_type(dev);
492 	buf[3] = have_tp ? 0x3c : 0x10;
493 
494 	/* Set WSNZ to 1 */
495 	buf[4] = 0x01;
496 	/*
497 	 * Set MAXIMUM COMPARE AND WRITE LENGTH
498 	 */
499 	if (dev->dev_attrib.emulate_caw)
500 		buf[5] = 0x01;
501 
502 	/*
503 	 * Set OPTIMAL TRANSFER LENGTH GRANULARITY
504 	 */
505 	if (dev->transport->get_io_min && (min = dev->transport->get_io_min(dev)))
506 		put_unaligned_be16(min / dev->dev_attrib.block_size, &buf[6]);
507 	else
508 		put_unaligned_be16(1, &buf[6]);
509 
510 	/*
511 	 * Set MAXIMUM TRANSFER LENGTH
512 	 */
513 	put_unaligned_be32(dev->dev_attrib.hw_max_sectors, &buf[8]);
514 
515 	/*
516 	 * Set OPTIMAL TRANSFER LENGTH
517 	 */
518 	if (dev->transport->get_io_opt && (opt = dev->transport->get_io_opt(dev)))
519 		put_unaligned_be32(opt / dev->dev_attrib.block_size, &buf[12]);
520 	else
521 		put_unaligned_be32(dev->dev_attrib.optimal_sectors, &buf[12]);
522 
523 	/*
524 	 * Exit now if we don't support TP.
525 	 */
526 	if (!have_tp)
527 		goto max_write_same;
528 
529 	/*
530 	 * Set MAXIMUM UNMAP LBA COUNT
531 	 */
532 	put_unaligned_be32(dev->dev_attrib.max_unmap_lba_count, &buf[20]);
533 
534 	/*
535 	 * Set MAXIMUM UNMAP BLOCK DESCRIPTOR COUNT
536 	 */
537 	put_unaligned_be32(dev->dev_attrib.max_unmap_block_desc_count,
538 			   &buf[24]);
539 
540 	/*
541 	 * Set OPTIMAL UNMAP GRANULARITY
542 	 */
543 	put_unaligned_be32(dev->dev_attrib.unmap_granularity, &buf[28]);
544 
545 	/*
546 	 * UNMAP GRANULARITY ALIGNMENT
547 	 */
548 	put_unaligned_be32(dev->dev_attrib.unmap_granularity_alignment,
549 			   &buf[32]);
550 	if (dev->dev_attrib.unmap_granularity_alignment != 0)
551 		buf[32] |= 0x80; /* Set the UGAVALID bit */
552 
553 	/*
554 	 * MAXIMUM WRITE SAME LENGTH
555 	 */
556 max_write_same:
557 	put_unaligned_be64(dev->dev_attrib.max_write_same_len, &buf[36]);
558 
559 	return 0;
560 }
561 
562 /* Block Device Characteristics VPD page */
563 static sense_reason_t
564 spc_emulate_evpd_b1(struct se_cmd *cmd, unsigned char *buf)
565 {
566 	struct se_device *dev = cmd->se_dev;
567 
568 	buf[0] = dev->transport->get_device_type(dev);
569 	buf[3] = 0x3c;
570 	buf[5] = dev->dev_attrib.is_nonrot ? 1 : 0;
571 
572 	return 0;
573 }
574 
575 /* Thin Provisioning VPD */
576 static sense_reason_t
577 spc_emulate_evpd_b2(struct se_cmd *cmd, unsigned char *buf)
578 {
579 	struct se_device *dev = cmd->se_dev;
580 
581 	/*
582 	 * From spc3r22 section 6.5.4 Thin Provisioning VPD page:
583 	 *
584 	 * The PAGE LENGTH field is defined in SPC-4. If the DP bit is set to
585 	 * zero, then the page length shall be set to 0004h.  If the DP bit
586 	 * is set to one, then the page length shall be set to the value
587 	 * defined in table 162.
588 	 */
589 	buf[0] = dev->transport->get_device_type(dev);
590 
591 	/*
592 	 * Set Hardcoded length mentioned above for DP=0
593 	 */
594 	put_unaligned_be16(0x0004, &buf[2]);
595 
596 	/*
597 	 * The THRESHOLD EXPONENT field indicates the threshold set size in
598 	 * LBAs as a power of 2 (i.e., the threshold set size is equal to
599 	 * 2(threshold exponent)).
600 	 *
601 	 * Note that this is currently set to 0x00 as mkp says it will be
602 	 * changing again.  We can enable this once it has settled in T10
603 	 * and is actually used by Linux/SCSI ML code.
604 	 */
605 	buf[4] = 0x00;
606 
607 	/*
608 	 * A TPU bit set to one indicates that the device server supports
609 	 * the UNMAP command (see 5.25). A TPU bit set to zero indicates
610 	 * that the device server does not support the UNMAP command.
611 	 */
612 	if (dev->dev_attrib.emulate_tpu != 0)
613 		buf[5] = 0x80;
614 
615 	/*
616 	 * A TPWS bit set to one indicates that the device server supports
617 	 * the use of the WRITE SAME (16) command (see 5.42) to unmap LBAs.
618 	 * A TPWS bit set to zero indicates that the device server does not
619 	 * support the use of the WRITE SAME (16) command to unmap LBAs.
620 	 */
621 	if (dev->dev_attrib.emulate_tpws != 0)
622 		buf[5] |= 0x40 | 0x20;
623 
624 	return 0;
625 }
626 
627 /* Referrals VPD page */
628 static sense_reason_t
629 spc_emulate_evpd_b3(struct se_cmd *cmd, unsigned char *buf)
630 {
631 	struct se_device *dev = cmd->se_dev;
632 
633 	buf[0] = dev->transport->get_device_type(dev);
634 	buf[3] = 0x0c;
635 	put_unaligned_be32(dev->t10_alua.lba_map_segment_size, &buf[8]);
636 	put_unaligned_be32(dev->t10_alua.lba_map_segment_multiplier, &buf[12]);
637 
638 	return 0;
639 }
640 
641 static sense_reason_t
642 spc_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf);
643 
644 static struct {
645 	uint8_t		page;
646 	sense_reason_t	(*emulate)(struct se_cmd *, unsigned char *);
647 } evpd_handlers[] = {
648 	{ .page = 0x00, .emulate = spc_emulate_evpd_00 },
649 	{ .page = 0x80, .emulate = spc_emulate_evpd_80 },
650 	{ .page = 0x83, .emulate = spc_emulate_evpd_83 },
651 	{ .page = 0x86, .emulate = spc_emulate_evpd_86 },
652 	{ .page = 0xb0, .emulate = spc_emulate_evpd_b0 },
653 	{ .page = 0xb1, .emulate = spc_emulate_evpd_b1 },
654 	{ .page = 0xb2, .emulate = spc_emulate_evpd_b2 },
655 	{ .page = 0xb3, .emulate = spc_emulate_evpd_b3 },
656 };
657 
658 /* supported vital product data pages */
659 static sense_reason_t
660 spc_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf)
661 {
662 	int p;
663 
664 	/*
665 	 * Only report the INQUIRY EVPD=1 pages after a valid NAA
666 	 * Registered Extended LUN WWN has been set via ConfigFS
667 	 * during device creation/restart.
668 	 */
669 	if (cmd->se_dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL) {
670 		buf[3] = ARRAY_SIZE(evpd_handlers);
671 		for (p = 0; p < ARRAY_SIZE(evpd_handlers); ++p)
672 			buf[p + 4] = evpd_handlers[p].page;
673 	}
674 
675 	return 0;
676 }
677 
678 static sense_reason_t
679 spc_emulate_inquiry(struct se_cmd *cmd)
680 {
681 	struct se_device *dev = cmd->se_dev;
682 	struct se_portal_group *tpg = cmd->se_lun->lun_tpg;
683 	unsigned char *rbuf;
684 	unsigned char *cdb = cmd->t_task_cdb;
685 	unsigned char *buf;
686 	sense_reason_t ret;
687 	int p;
688 	int len = 0;
689 
690 	buf = kzalloc(SE_INQUIRY_BUF, GFP_KERNEL);
691 	if (!buf) {
692 		pr_err("Unable to allocate response buffer for INQUIRY\n");
693 		return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
694 	}
695 
696 	if (dev == rcu_access_pointer(tpg->tpg_virt_lun0->lun_se_dev))
697 		buf[0] = 0x3f; /* Not connected */
698 	else
699 		buf[0] = dev->transport->get_device_type(dev);
700 
701 	if (!(cdb[1] & 0x1)) {
702 		if (cdb[2]) {
703 			pr_err("INQUIRY with EVPD==0 but PAGE CODE=%02x\n",
704 			       cdb[2]);
705 			ret = TCM_INVALID_CDB_FIELD;
706 			goto out;
707 		}
708 
709 		ret = spc_emulate_inquiry_std(cmd, buf);
710 		len = buf[4] + 5;
711 		goto out;
712 	}
713 
714 	for (p = 0; p < ARRAY_SIZE(evpd_handlers); ++p) {
715 		if (cdb[2] == evpd_handlers[p].page) {
716 			buf[1] = cdb[2];
717 			ret = evpd_handlers[p].emulate(cmd, buf);
718 			len = get_unaligned_be16(&buf[2]) + 4;
719 			goto out;
720 		}
721 	}
722 
723 	pr_err("Unknown VPD Code: 0x%02x\n", cdb[2]);
724 	ret = TCM_INVALID_CDB_FIELD;
725 
726 out:
727 	rbuf = transport_kmap_data_sg(cmd);
728 	if (rbuf) {
729 		memcpy(rbuf, buf, min_t(u32, SE_INQUIRY_BUF, cmd->data_length));
730 		transport_kunmap_data_sg(cmd);
731 	}
732 	kfree(buf);
733 
734 	if (!ret)
735 		target_complete_cmd_with_length(cmd, GOOD, len);
736 	return ret;
737 }
738 
739 static int spc_modesense_rwrecovery(struct se_cmd *cmd, u8 pc, u8 *p)
740 {
741 	p[0] = 0x01;
742 	p[1] = 0x0a;
743 
744 	/* No changeable values for now */
745 	if (pc == 1)
746 		goto out;
747 
748 out:
749 	return 12;
750 }
751 
752 static int spc_modesense_control(struct se_cmd *cmd, u8 pc, u8 *p)
753 {
754 	struct se_device *dev = cmd->se_dev;
755 	struct se_session *sess = cmd->se_sess;
756 
757 	p[0] = 0x0a;
758 	p[1] = 0x0a;
759 
760 	/* No changeable values for now */
761 	if (pc == 1)
762 		goto out;
763 
764 	p[2] = 2;
765 	/*
766 	 * From spc4r23, 7.4.7 Control mode page
767 	 *
768 	 * The QUEUE ALGORITHM MODIFIER field (see table 368) specifies
769 	 * restrictions on the algorithm used for reordering commands
770 	 * having the SIMPLE task attribute (see SAM-4).
771 	 *
772 	 *                    Table 368 -- QUEUE ALGORITHM MODIFIER field
773 	 *                         Code      Description
774 	 *                          0h       Restricted reordering
775 	 *                          1h       Unrestricted reordering allowed
776 	 *                          2h to 7h    Reserved
777 	 *                          8h to Fh    Vendor specific
778 	 *
779 	 * A value of zero in the QUEUE ALGORITHM MODIFIER field specifies that
780 	 * the device server shall order the processing sequence of commands
781 	 * having the SIMPLE task attribute such that data integrity is maintained
782 	 * for that I_T nexus (i.e., if the transmission of new SCSI transport protocol
783 	 * requests is halted at any time, the final value of all data observable
784 	 * on the medium shall be the same as if all the commands had been processed
785 	 * with the ORDERED task attribute).
786 	 *
787 	 * A value of one in the QUEUE ALGORITHM MODIFIER field specifies that the
788 	 * device server may reorder the processing sequence of commands having the
789 	 * SIMPLE task attribute in any manner. Any data integrity exposures related to
790 	 * command sequence order shall be explicitly handled by the application client
791 	 * through the selection of appropriate ommands and task attributes.
792 	 */
793 	p[3] = (dev->dev_attrib.emulate_rest_reord == 1) ? 0x00 : 0x10;
794 	/*
795 	 * From spc4r17, section 7.4.6 Control mode Page
796 	 *
797 	 * Unit Attention interlocks control (UN_INTLCK_CTRL) to code 00b
798 	 *
799 	 * 00b: The logical unit shall clear any unit attention condition
800 	 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
801 	 * status and shall not establish a unit attention condition when a com-
802 	 * mand is completed with BUSY, TASK SET FULL, or RESERVATION CONFLICT
803 	 * status.
804 	 *
805 	 * 10b: The logical unit shall not clear any unit attention condition
806 	 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
807 	 * status and shall not establish a unit attention condition when
808 	 * a command is completed with BUSY, TASK SET FULL, or RESERVATION
809 	 * CONFLICT status.
810 	 *
811 	 * 11b a The logical unit shall not clear any unit attention condition
812 	 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
813 	 * status and shall establish a unit attention condition for the
814 	 * initiator port associated with the I_T nexus on which the BUSY,
815 	 * TASK SET FULL, or RESERVATION CONFLICT status is being returned.
816 	 * Depending on the status, the additional sense code shall be set to
817 	 * PREVIOUS BUSY STATUS, PREVIOUS TASK SET FULL STATUS, or PREVIOUS
818 	 * RESERVATION CONFLICT STATUS. Until it is cleared by a REQUEST SENSE
819 	 * command, a unit attention condition shall be established only once
820 	 * for a BUSY, TASK SET FULL, or RESERVATION CONFLICT status regardless
821 	 * to the number of commands completed with one of those status codes.
822 	 */
823 	p[4] = (dev->dev_attrib.emulate_ua_intlck_ctrl == 2) ? 0x30 :
824 	       (dev->dev_attrib.emulate_ua_intlck_ctrl == 1) ? 0x20 : 0x00;
825 	/*
826 	 * From spc4r17, section 7.4.6 Control mode Page
827 	 *
828 	 * Task Aborted Status (TAS) bit set to zero.
829 	 *
830 	 * A task aborted status (TAS) bit set to zero specifies that aborted
831 	 * tasks shall be terminated by the device server without any response
832 	 * to the application client. A TAS bit set to one specifies that tasks
833 	 * aborted by the actions of an I_T nexus other than the I_T nexus on
834 	 * which the command was received shall be completed with TASK ABORTED
835 	 * status (see SAM-4).
836 	 */
837 	p[5] = (dev->dev_attrib.emulate_tas) ? 0x40 : 0x00;
838 	/*
839 	 * From spc4r30, section 7.5.7 Control mode page
840 	 *
841 	 * Application Tag Owner (ATO) bit set to one.
842 	 *
843 	 * If the ATO bit is set to one the device server shall not modify the
844 	 * LOGICAL BLOCK APPLICATION TAG field and, depending on the protection
845 	 * type, shall not modify the contents of the LOGICAL BLOCK REFERENCE
846 	 * TAG field.
847 	 */
848 	if (sess->sup_prot_ops & (TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS)) {
849 		if (dev->dev_attrib.pi_prot_type || sess->sess_prot_type)
850 			p[5] |= 0x80;
851 	}
852 
853 	p[8] = 0xff;
854 	p[9] = 0xff;
855 	p[11] = 30;
856 
857 out:
858 	return 12;
859 }
860 
861 static int spc_modesense_caching(struct se_cmd *cmd, u8 pc, u8 *p)
862 {
863 	struct se_device *dev = cmd->se_dev;
864 
865 	p[0] = 0x08;
866 	p[1] = 0x12;
867 
868 	/* No changeable values for now */
869 	if (pc == 1)
870 		goto out;
871 
872 	if (target_check_wce(dev))
873 		p[2] = 0x04; /* Write Cache Enable */
874 	p[12] = 0x20; /* Disabled Read Ahead */
875 
876 out:
877 	return 20;
878 }
879 
880 static int spc_modesense_informational_exceptions(struct se_cmd *cmd, u8 pc, unsigned char *p)
881 {
882 	p[0] = 0x1c;
883 	p[1] = 0x0a;
884 
885 	/* No changeable values for now */
886 	if (pc == 1)
887 		goto out;
888 
889 out:
890 	return 12;
891 }
892 
893 static struct {
894 	uint8_t		page;
895 	uint8_t		subpage;
896 	int		(*emulate)(struct se_cmd *, u8, unsigned char *);
897 } modesense_handlers[] = {
898 	{ .page = 0x01, .subpage = 0x00, .emulate = spc_modesense_rwrecovery },
899 	{ .page = 0x08, .subpage = 0x00, .emulate = spc_modesense_caching },
900 	{ .page = 0x0a, .subpage = 0x00, .emulate = spc_modesense_control },
901 	{ .page = 0x1c, .subpage = 0x00, .emulate = spc_modesense_informational_exceptions },
902 };
903 
904 static void spc_modesense_write_protect(unsigned char *buf, int type)
905 {
906 	/*
907 	 * I believe that the WP bit (bit 7) in the mode header is the same for
908 	 * all device types..
909 	 */
910 	switch (type) {
911 	case TYPE_DISK:
912 	case TYPE_TAPE:
913 	default:
914 		buf[0] |= 0x80; /* WP bit */
915 		break;
916 	}
917 }
918 
919 static void spc_modesense_dpofua(unsigned char *buf, int type)
920 {
921 	switch (type) {
922 	case TYPE_DISK:
923 		buf[0] |= 0x10; /* DPOFUA bit */
924 		break;
925 	default:
926 		break;
927 	}
928 }
929 
930 static int spc_modesense_blockdesc(unsigned char *buf, u64 blocks, u32 block_size)
931 {
932 	*buf++ = 8;
933 	put_unaligned_be32(min(blocks, 0xffffffffull), buf);
934 	buf += 4;
935 	put_unaligned_be32(block_size, buf);
936 	return 9;
937 }
938 
939 static int spc_modesense_long_blockdesc(unsigned char *buf, u64 blocks, u32 block_size)
940 {
941 	if (blocks <= 0xffffffff)
942 		return spc_modesense_blockdesc(buf + 3, blocks, block_size) + 3;
943 
944 	*buf++ = 1;		/* LONGLBA */
945 	buf += 2;
946 	*buf++ = 16;
947 	put_unaligned_be64(blocks, buf);
948 	buf += 12;
949 	put_unaligned_be32(block_size, buf);
950 
951 	return 17;
952 }
953 
954 static sense_reason_t spc_emulate_modesense(struct se_cmd *cmd)
955 {
956 	struct se_device *dev = cmd->se_dev;
957 	char *cdb = cmd->t_task_cdb;
958 	unsigned char buf[SE_MODE_PAGE_BUF], *rbuf;
959 	int type = dev->transport->get_device_type(dev);
960 	int ten = (cmd->t_task_cdb[0] == MODE_SENSE_10);
961 	bool dbd = !!(cdb[1] & 0x08);
962 	bool llba = ten ? !!(cdb[1] & 0x10) : false;
963 	u8 pc = cdb[2] >> 6;
964 	u8 page = cdb[2] & 0x3f;
965 	u8 subpage = cdb[3];
966 	int length = 0;
967 	int ret;
968 	int i;
969 	bool read_only = target_lun_is_rdonly(cmd);;
970 
971 	memset(buf, 0, SE_MODE_PAGE_BUF);
972 
973 	/*
974 	 * Skip over MODE DATA LENGTH + MEDIUM TYPE fields to byte 3 for
975 	 * MODE_SENSE_10 and byte 2 for MODE_SENSE (6).
976 	 */
977 	length = ten ? 3 : 2;
978 
979 	/* DEVICE-SPECIFIC PARAMETER */
980 	if ((cmd->se_lun->lun_access & TRANSPORT_LUNFLAGS_READ_ONLY) || read_only)
981 		spc_modesense_write_protect(&buf[length], type);
982 
983 	/*
984 	 * SBC only allows us to enable FUA and DPO together.  Fortunately
985 	 * DPO is explicitly specified as a hint, so a noop is a perfectly
986 	 * valid implementation.
987 	 */
988 	if (target_check_fua(dev))
989 		spc_modesense_dpofua(&buf[length], type);
990 
991 	++length;
992 
993 	/* BLOCK DESCRIPTOR */
994 
995 	/*
996 	 * For now we only include a block descriptor for disk (SBC)
997 	 * devices; other command sets use a slightly different format.
998 	 */
999 	if (!dbd && type == TYPE_DISK) {
1000 		u64 blocks = dev->transport->get_blocks(dev);
1001 		u32 block_size = dev->dev_attrib.block_size;
1002 
1003 		if (ten) {
1004 			if (llba) {
1005 				length += spc_modesense_long_blockdesc(&buf[length],
1006 								       blocks, block_size);
1007 			} else {
1008 				length += 3;
1009 				length += spc_modesense_blockdesc(&buf[length],
1010 								  blocks, block_size);
1011 			}
1012 		} else {
1013 			length += spc_modesense_blockdesc(&buf[length], blocks,
1014 							  block_size);
1015 		}
1016 	} else {
1017 		if (ten)
1018 			length += 4;
1019 		else
1020 			length += 1;
1021 	}
1022 
1023 	if (page == 0x3f) {
1024 		if (subpage != 0x00 && subpage != 0xff) {
1025 			pr_warn("MODE_SENSE: Invalid subpage code: 0x%02x\n", subpage);
1026 			return TCM_INVALID_CDB_FIELD;
1027 		}
1028 
1029 		for (i = 0; i < ARRAY_SIZE(modesense_handlers); ++i) {
1030 			/*
1031 			 * Tricky way to say all subpage 00h for
1032 			 * subpage==0, all subpages for subpage==0xff
1033 			 * (and we just checked above that those are
1034 			 * the only two possibilities).
1035 			 */
1036 			if ((modesense_handlers[i].subpage & ~subpage) == 0) {
1037 				ret = modesense_handlers[i].emulate(cmd, pc, &buf[length]);
1038 				if (!ten && length + ret >= 255)
1039 					break;
1040 				length += ret;
1041 			}
1042 		}
1043 
1044 		goto set_length;
1045 	}
1046 
1047 	for (i = 0; i < ARRAY_SIZE(modesense_handlers); ++i)
1048 		if (modesense_handlers[i].page == page &&
1049 		    modesense_handlers[i].subpage == subpage) {
1050 			length += modesense_handlers[i].emulate(cmd, pc, &buf[length]);
1051 			goto set_length;
1052 		}
1053 
1054 	/*
1055 	 * We don't intend to implement:
1056 	 *  - obsolete page 03h "format parameters" (checked by Solaris)
1057 	 */
1058 	if (page != 0x03)
1059 		pr_err("MODE SENSE: unimplemented page/subpage: 0x%02x/0x%02x\n",
1060 		       page, subpage);
1061 
1062 	return TCM_UNKNOWN_MODE_PAGE;
1063 
1064 set_length:
1065 	if (ten)
1066 		put_unaligned_be16(length - 2, buf);
1067 	else
1068 		buf[0] = length - 1;
1069 
1070 	rbuf = transport_kmap_data_sg(cmd);
1071 	if (rbuf) {
1072 		memcpy(rbuf, buf, min_t(u32, SE_MODE_PAGE_BUF, cmd->data_length));
1073 		transport_kunmap_data_sg(cmd);
1074 	}
1075 
1076 	target_complete_cmd_with_length(cmd, GOOD, length);
1077 	return 0;
1078 }
1079 
1080 static sense_reason_t spc_emulate_modeselect(struct se_cmd *cmd)
1081 {
1082 	char *cdb = cmd->t_task_cdb;
1083 	bool ten = cdb[0] == MODE_SELECT_10;
1084 	int off = ten ? 8 : 4;
1085 	bool pf = !!(cdb[1] & 0x10);
1086 	u8 page, subpage;
1087 	unsigned char *buf;
1088 	unsigned char tbuf[SE_MODE_PAGE_BUF];
1089 	int length;
1090 	sense_reason_t ret = 0;
1091 	int i;
1092 
1093 	if (!cmd->data_length) {
1094 		target_complete_cmd(cmd, GOOD);
1095 		return 0;
1096 	}
1097 
1098 	if (cmd->data_length < off + 2)
1099 		return TCM_PARAMETER_LIST_LENGTH_ERROR;
1100 
1101 	buf = transport_kmap_data_sg(cmd);
1102 	if (!buf)
1103 		return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1104 
1105 	if (!pf) {
1106 		ret = TCM_INVALID_CDB_FIELD;
1107 		goto out;
1108 	}
1109 
1110 	page = buf[off] & 0x3f;
1111 	subpage = buf[off] & 0x40 ? buf[off + 1] : 0;
1112 
1113 	for (i = 0; i < ARRAY_SIZE(modesense_handlers); ++i)
1114 		if (modesense_handlers[i].page == page &&
1115 		    modesense_handlers[i].subpage == subpage) {
1116 			memset(tbuf, 0, SE_MODE_PAGE_BUF);
1117 			length = modesense_handlers[i].emulate(cmd, 0, tbuf);
1118 			goto check_contents;
1119 		}
1120 
1121 	ret = TCM_UNKNOWN_MODE_PAGE;
1122 	goto out;
1123 
1124 check_contents:
1125 	if (cmd->data_length < off + length) {
1126 		ret = TCM_PARAMETER_LIST_LENGTH_ERROR;
1127 		goto out;
1128 	}
1129 
1130 	if (memcmp(buf + off, tbuf, length))
1131 		ret = TCM_INVALID_PARAMETER_LIST;
1132 
1133 out:
1134 	transport_kunmap_data_sg(cmd);
1135 
1136 	if (!ret)
1137 		target_complete_cmd(cmd, GOOD);
1138 	return ret;
1139 }
1140 
1141 static sense_reason_t spc_emulate_request_sense(struct se_cmd *cmd)
1142 {
1143 	unsigned char *cdb = cmd->t_task_cdb;
1144 	unsigned char *rbuf;
1145 	u8 ua_asc = 0, ua_ascq = 0;
1146 	unsigned char buf[SE_SENSE_BUF];
1147 
1148 	memset(buf, 0, SE_SENSE_BUF);
1149 
1150 	if (cdb[1] & 0x01) {
1151 		pr_err("REQUEST_SENSE description emulation not"
1152 			" supported\n");
1153 		return TCM_INVALID_CDB_FIELD;
1154 	}
1155 
1156 	rbuf = transport_kmap_data_sg(cmd);
1157 	if (!rbuf)
1158 		return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1159 
1160 	if (!core_scsi3_ua_clear_for_request_sense(cmd, &ua_asc, &ua_ascq)) {
1161 		/*
1162 		 * CURRENT ERROR, UNIT ATTENTION
1163 		 */
1164 		buf[0] = 0x70;
1165 		buf[SPC_SENSE_KEY_OFFSET] = UNIT_ATTENTION;
1166 
1167 		/*
1168 		 * The Additional Sense Code (ASC) from the UNIT ATTENTION
1169 		 */
1170 		buf[SPC_ASC_KEY_OFFSET] = ua_asc;
1171 		buf[SPC_ASCQ_KEY_OFFSET] = ua_ascq;
1172 		buf[7] = 0x0A;
1173 	} else {
1174 		/*
1175 		 * CURRENT ERROR, NO SENSE
1176 		 */
1177 		buf[0] = 0x70;
1178 		buf[SPC_SENSE_KEY_OFFSET] = NO_SENSE;
1179 
1180 		/*
1181 		 * NO ADDITIONAL SENSE INFORMATION
1182 		 */
1183 		buf[SPC_ASC_KEY_OFFSET] = 0x00;
1184 		buf[7] = 0x0A;
1185 	}
1186 
1187 	memcpy(rbuf, buf, min_t(u32, sizeof(buf), cmd->data_length));
1188 	transport_kunmap_data_sg(cmd);
1189 
1190 	target_complete_cmd(cmd, GOOD);
1191 	return 0;
1192 }
1193 
1194 sense_reason_t spc_emulate_report_luns(struct se_cmd *cmd)
1195 {
1196 	struct se_dev_entry *deve;
1197 	struct se_session *sess = cmd->se_sess;
1198 	struct se_node_acl *nacl;
1199 	unsigned char *buf;
1200 	u32 lun_count = 0, offset = 8;
1201 
1202 	if (cmd->data_length < 16) {
1203 		pr_warn("REPORT LUNS allocation length %u too small\n",
1204 			cmd->data_length);
1205 		return TCM_INVALID_CDB_FIELD;
1206 	}
1207 
1208 	buf = transport_kmap_data_sg(cmd);
1209 	if (!buf)
1210 		return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1211 
1212 	/*
1213 	 * If no struct se_session pointer is present, this struct se_cmd is
1214 	 * coming via a target_core_mod PASSTHROUGH op, and not through
1215 	 * a $FABRIC_MOD.  In that case, report LUN=0 only.
1216 	 */
1217 	if (!sess) {
1218 		int_to_scsilun(0, (struct scsi_lun *)&buf[offset]);
1219 		lun_count = 1;
1220 		goto done;
1221 	}
1222 	nacl = sess->se_node_acl;
1223 
1224 	rcu_read_lock();
1225 	hlist_for_each_entry_rcu(deve, &nacl->lun_entry_hlist, link) {
1226 		/*
1227 		 * We determine the correct LUN LIST LENGTH even once we
1228 		 * have reached the initial allocation length.
1229 		 * See SPC2-R20 7.19.
1230 		 */
1231 		lun_count++;
1232 		if ((offset + 8) > cmd->data_length)
1233 			continue;
1234 
1235 		int_to_scsilun(deve->mapped_lun, (struct scsi_lun *)&buf[offset]);
1236 		offset += 8;
1237 	}
1238 	rcu_read_unlock();
1239 
1240 	/*
1241 	 * See SPC3 r07, page 159.
1242 	 */
1243 done:
1244 	lun_count *= 8;
1245 	buf[0] = ((lun_count >> 24) & 0xff);
1246 	buf[1] = ((lun_count >> 16) & 0xff);
1247 	buf[2] = ((lun_count >> 8) & 0xff);
1248 	buf[3] = (lun_count & 0xff);
1249 	transport_kunmap_data_sg(cmd);
1250 
1251 	target_complete_cmd_with_length(cmd, GOOD, 8 + lun_count * 8);
1252 	return 0;
1253 }
1254 EXPORT_SYMBOL(spc_emulate_report_luns);
1255 
1256 static sense_reason_t
1257 spc_emulate_testunitready(struct se_cmd *cmd)
1258 {
1259 	target_complete_cmd(cmd, GOOD);
1260 	return 0;
1261 }
1262 
1263 sense_reason_t
1264 spc_parse_cdb(struct se_cmd *cmd, unsigned int *size)
1265 {
1266 	struct se_device *dev = cmd->se_dev;
1267 	unsigned char *cdb = cmd->t_task_cdb;
1268 
1269 	switch (cdb[0]) {
1270 	case MODE_SELECT:
1271 		*size = cdb[4];
1272 		cmd->execute_cmd = spc_emulate_modeselect;
1273 		break;
1274 	case MODE_SELECT_10:
1275 		*size = (cdb[7] << 8) + cdb[8];
1276 		cmd->execute_cmd = spc_emulate_modeselect;
1277 		break;
1278 	case MODE_SENSE:
1279 		*size = cdb[4];
1280 		cmd->execute_cmd = spc_emulate_modesense;
1281 		break;
1282 	case MODE_SENSE_10:
1283 		*size = (cdb[7] << 8) + cdb[8];
1284 		cmd->execute_cmd = spc_emulate_modesense;
1285 		break;
1286 	case LOG_SELECT:
1287 	case LOG_SENSE:
1288 		*size = (cdb[7] << 8) + cdb[8];
1289 		break;
1290 	case PERSISTENT_RESERVE_IN:
1291 		*size = (cdb[7] << 8) + cdb[8];
1292 		cmd->execute_cmd = target_scsi3_emulate_pr_in;
1293 		break;
1294 	case PERSISTENT_RESERVE_OUT:
1295 		*size = (cdb[7] << 8) + cdb[8];
1296 		cmd->execute_cmd = target_scsi3_emulate_pr_out;
1297 		break;
1298 	case RELEASE:
1299 	case RELEASE_10:
1300 		if (cdb[0] == RELEASE_10)
1301 			*size = (cdb[7] << 8) | cdb[8];
1302 		else
1303 			*size = cmd->data_length;
1304 
1305 		cmd->execute_cmd = target_scsi2_reservation_release;
1306 		break;
1307 	case RESERVE:
1308 	case RESERVE_10:
1309 		/*
1310 		 * The SPC-2 RESERVE does not contain a size in the SCSI CDB.
1311 		 * Assume the passthrough or $FABRIC_MOD will tell us about it.
1312 		 */
1313 		if (cdb[0] == RESERVE_10)
1314 			*size = (cdb[7] << 8) | cdb[8];
1315 		else
1316 			*size = cmd->data_length;
1317 
1318 		cmd->execute_cmd = target_scsi2_reservation_reserve;
1319 		break;
1320 	case REQUEST_SENSE:
1321 		*size = cdb[4];
1322 		cmd->execute_cmd = spc_emulate_request_sense;
1323 		break;
1324 	case INQUIRY:
1325 		*size = (cdb[3] << 8) + cdb[4];
1326 
1327 		/*
1328 		 * Do implicit HEAD_OF_QUEUE processing for INQUIRY.
1329 		 * See spc4r17 section 5.3
1330 		 */
1331 		cmd->sam_task_attr = TCM_HEAD_TAG;
1332 		cmd->execute_cmd = spc_emulate_inquiry;
1333 		break;
1334 	case SECURITY_PROTOCOL_IN:
1335 	case SECURITY_PROTOCOL_OUT:
1336 		*size = (cdb[6] << 24) | (cdb[7] << 16) | (cdb[8] << 8) | cdb[9];
1337 		break;
1338 	case EXTENDED_COPY:
1339 		*size = get_unaligned_be32(&cdb[10]);
1340 		cmd->execute_cmd = target_do_xcopy;
1341 		break;
1342 	case RECEIVE_COPY_RESULTS:
1343 		*size = get_unaligned_be32(&cdb[10]);
1344 		cmd->execute_cmd = target_do_receive_copy_results;
1345 		break;
1346 	case READ_ATTRIBUTE:
1347 	case WRITE_ATTRIBUTE:
1348 		*size = (cdb[10] << 24) | (cdb[11] << 16) |
1349 		       (cdb[12] << 8) | cdb[13];
1350 		break;
1351 	case RECEIVE_DIAGNOSTIC:
1352 	case SEND_DIAGNOSTIC:
1353 		*size = (cdb[3] << 8) | cdb[4];
1354 		break;
1355 	case WRITE_BUFFER:
1356 		*size = (cdb[6] << 16) + (cdb[7] << 8) + cdb[8];
1357 		break;
1358 	case REPORT_LUNS:
1359 		cmd->execute_cmd = spc_emulate_report_luns;
1360 		*size = (cdb[6] << 24) | (cdb[7] << 16) | (cdb[8] << 8) | cdb[9];
1361 		/*
1362 		 * Do implicit HEAD_OF_QUEUE processing for REPORT_LUNS
1363 		 * See spc4r17 section 5.3
1364 		 */
1365 		cmd->sam_task_attr = TCM_HEAD_TAG;
1366 		break;
1367 	case TEST_UNIT_READY:
1368 		cmd->execute_cmd = spc_emulate_testunitready;
1369 		*size = 0;
1370 		break;
1371 	case MAINTENANCE_IN:
1372 		if (dev->transport->get_device_type(dev) != TYPE_ROM) {
1373 			/*
1374 			 * MAINTENANCE_IN from SCC-2
1375 			 * Check for emulated MI_REPORT_TARGET_PGS
1376 			 */
1377 			if ((cdb[1] & 0x1f) == MI_REPORT_TARGET_PGS) {
1378 				cmd->execute_cmd =
1379 					target_emulate_report_target_port_groups;
1380 			}
1381 			*size = get_unaligned_be32(&cdb[6]);
1382 		} else {
1383 			/*
1384 			 * GPCMD_SEND_KEY from multi media commands
1385 			 */
1386 			*size = get_unaligned_be16(&cdb[8]);
1387 		}
1388 		break;
1389 	case MAINTENANCE_OUT:
1390 		if (dev->transport->get_device_type(dev) != TYPE_ROM) {
1391 			/*
1392 			 * MAINTENANCE_OUT from SCC-2
1393 			 * Check for emulated MO_SET_TARGET_PGS.
1394 			 */
1395 			if (cdb[1] == MO_SET_TARGET_PGS) {
1396 				cmd->execute_cmd =
1397 					target_emulate_set_target_port_groups;
1398 			}
1399 			*size = get_unaligned_be32(&cdb[6]);
1400 		} else {
1401 			/*
1402 			 * GPCMD_SEND_KEY from multi media commands
1403 			 */
1404 			*size = get_unaligned_be16(&cdb[8]);
1405 		}
1406 		break;
1407 	default:
1408 		pr_warn("TARGET_CORE[%s]: Unsupported SCSI Opcode"
1409 			" 0x%02x, sending CHECK_CONDITION.\n",
1410 			cmd->se_tfo->get_fabric_name(), cdb[0]);
1411 		return TCM_UNSUPPORTED_SCSI_OPCODE;
1412 	}
1413 
1414 	return 0;
1415 }
1416 EXPORT_SYMBOL(spc_parse_cdb);
1417