2 * SCSI Primary Commands (SPC) parsing and emulation.
4 * (c) Copyright 2002-2013 Datera, Inc.
6 * Nicholas A. Bellinger <nab@kernel.org>
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.
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.
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.
23 #include <linux/kernel.h>
24 #include <linux/module.h>
25 #include <asm/unaligned.h>
27 #include <scsi/scsi_proto.h>
28 #include <scsi/scsi_common.h>
29 #include <scsi/scsi_tcq.h>
31 #include <target/target_core_base.h>
32 #include <target/target_core_backend.h>
33 #include <target/target_core_fabric.h>
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"
41 static void spc_fill_alua_data(struct se_lun *lun, unsigned char *buf)
43 struct t10_alua_tg_pt_gp *tg_pt_gp;
46 * Set SCCS for MAINTENANCE_IN + REPORT_TARGET_PORT_GROUPS.
51 * Set TPGS field for explicit and/or implicit ALUA access type
54 * See spc4r17 section 6.4.2 Table 135
56 spin_lock(&lun->lun_tg_pt_gp_lock);
57 tg_pt_gp = lun->lun_tg_pt_gp;
59 buf[5] |= tg_pt_gp->tg_pt_gp_alua_access_type;
60 spin_unlock(&lun->lun_tg_pt_gp_lock);
64 spc_emulate_inquiry_std(struct se_cmd *cmd, unsigned char *buf)
66 struct se_lun *lun = cmd->se_lun;
67 struct se_device *dev = cmd->se_dev;
68 struct se_session *sess = cmd->se_sess;
70 /* Set RMB (removable media) for tape devices */
71 if (dev->transport->get_device_type(dev) == TYPE_TAPE)
74 buf[2] = 0x05; /* SPC-3 */
77 * NORMACA and HISUP = 0, RESPONSE DATA FORMAT = 2
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
89 * Enable SCCS and TPGS fields for Emulated ALUA
91 spc_fill_alua_data(lun, buf);
94 * Set Third-Party Copy (3PC) bit to indicate support for EXTENDED_COPY
96 if (dev->dev_attrib.emulate_3pc)
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.
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)
109 buf[7] = 0x2; /* CmdQue=1 */
112 * ASCII data fields described as being left-aligned shall have any
113 * unused bytes at the end of the field (i.e., highest offset) and the
114 * unused bytes shall be filled with ASCII space characters (20h).
116 memset(&buf[8], 0x20, 8 + 16 + 4);
117 memcpy(&buf[8], "LIO-ORG", sizeof("LIO-ORG") - 1);
118 memcpy(&buf[16], dev->t10_wwn.model,
119 strnlen(dev->t10_wwn.model, 16));
120 memcpy(&buf[32], dev->t10_wwn.revision,
121 strnlen(dev->t10_wwn.revision, 4));
122 buf[4] = 31; /* Set additional length to 31 */
126 EXPORT_SYMBOL(spc_emulate_inquiry_std);
128 /* unit serial number */
129 static sense_reason_t
130 spc_emulate_evpd_80(struct se_cmd *cmd, unsigned char *buf)
132 struct se_device *dev = cmd->se_dev;
135 if (dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL) {
136 len = sprintf(&buf[4], "%s", dev->t10_wwn.unit_serial);
137 len++; /* Extra Byte for NULL Terminator */
143 void spc_parse_naa_6h_vendor_specific(struct se_device *dev,
146 unsigned char *p = &dev->t10_wwn.unit_serial[0];
151 * Generate up to 36 bits of VENDOR SPECIFIC IDENTIFIER starting on
152 * byte 3 bit 3-0 for NAA IEEE Registered Extended DESIGNATOR field
153 * format, followed by 64 bits of VENDOR SPECIFIC IDENTIFIER EXTENSION
154 * to complete the payload. These are based from VPD=0x80 PRODUCT SERIAL
155 * NUMBER set via vpd_unit_serial in target_core_configfs.c to ensure
156 * per device uniqeness.
158 for (cnt = 0; *p && cnt < 13; p++) {
159 int val = hex_to_bin(*p);
175 * Device identification VPD, for a complete list of
176 * DESIGNATOR TYPEs see spc4r17 Table 459.
179 spc_emulate_evpd_83(struct se_cmd *cmd, unsigned char *buf)
181 struct se_device *dev = cmd->se_dev;
182 struct se_lun *lun = cmd->se_lun;
183 struct se_portal_group *tpg = NULL;
184 struct t10_alua_lu_gp_member *lu_gp_mem;
185 struct t10_alua_tg_pt_gp *tg_pt_gp;
186 unsigned char *prod = &dev->t10_wwn.model[0];
188 u32 unit_serial_len, off = 0;
194 * NAA IEEE Registered Extended Assigned designator format, see
195 * spc4r17 section 7.7.3.6.5
197 * We depend upon a target_core_mod/ConfigFS provided
198 * /sys/kernel/config/target/core/$HBA/$DEV/wwn/vpd_unit_serial
199 * value in order to return the NAA id.
201 if (!(dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL))
202 goto check_t10_vend_desc;
204 /* CODE SET == Binary */
207 /* Set ASSOCIATION == addressed logical unit: 0)b */
210 /* Identifier/Designator type == NAA identifier */
214 /* Identifier/Designator length */
218 * Start NAA IEEE Registered Extended Identifier/Designator
220 buf[off++] = (0x6 << 4);
223 * Use OpenFabrics IEEE Company ID: 00 14 05
227 buf[off] = (0x5 << 4);
230 * Return ConfigFS Unit Serial Number information for
231 * VENDOR_SPECIFIC_IDENTIFIER and
232 * VENDOR_SPECIFIC_IDENTIFIER_EXTENTION
234 spc_parse_naa_6h_vendor_specific(dev, &buf[off]);
241 * T10 Vendor Identifier Page, see spc4r17 section 7.7.3.4
243 id_len = 8; /* For Vendor field */
244 prod_len = 4; /* For VPD Header */
245 prod_len += 8; /* For Vendor field */
246 prod_len += strlen(prod);
247 prod_len++; /* For : */
249 if (dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL) {
250 unit_serial_len = strlen(&dev->t10_wwn.unit_serial[0]);
251 unit_serial_len++; /* For NULL Terminator */
253 id_len += sprintf(&buf[off+12], "%s:%s", prod,
254 &dev->t10_wwn.unit_serial[0]);
256 buf[off] = 0x2; /* ASCII */
257 buf[off+1] = 0x1; /* T10 Vendor ID */
259 /* left align Vendor ID and pad with spaces */
260 memset(&buf[off+4], 0x20, 8);
261 memcpy(&buf[off+4], "LIO-ORG", sizeof("LIO-ORG") - 1);
262 /* Extra Byte for NULL Terminator */
264 /* Identifier Length */
266 /* Header size for Designation descriptor */
271 struct t10_alua_lu_gp *lu_gp;
272 u32 padding, scsi_name_len, scsi_target_len;
279 * Relative target port identifer, see spc4r17
282 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
283 * section 7.5.1 Table 362
285 buf[off] = tpg->proto_id << 4;
286 buf[off++] |= 0x1; /* CODE SET == Binary */
287 buf[off] = 0x80; /* Set PIV=1 */
288 /* Set ASSOCIATION == target port: 01b */
290 /* DESIGNATOR TYPE == Relative target port identifer */
292 off++; /* Skip over Reserved */
293 buf[off++] = 4; /* DESIGNATOR LENGTH */
294 /* Skip over Obsolete field in RTPI payload
297 put_unaligned_be16(lun->lun_rtpi, &buf[off]);
299 len += 8; /* Header size + Designation descriptor */
301 * Target port group identifier, see spc4r17
304 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
305 * section 7.5.1 Table 362
307 spin_lock(&lun->lun_tg_pt_gp_lock);
308 tg_pt_gp = lun->lun_tg_pt_gp;
310 spin_unlock(&lun->lun_tg_pt_gp_lock);
313 tg_pt_gp_id = tg_pt_gp->tg_pt_gp_id;
314 spin_unlock(&lun->lun_tg_pt_gp_lock);
316 buf[off] = tpg->proto_id << 4;
317 buf[off++] |= 0x1; /* CODE SET == Binary */
318 buf[off] = 0x80; /* Set PIV=1 */
319 /* Set ASSOCIATION == target port: 01b */
321 /* DESIGNATOR TYPE == Target port group identifier */
323 off++; /* Skip over Reserved */
324 buf[off++] = 4; /* DESIGNATOR LENGTH */
325 off += 2; /* Skip over Reserved Field */
326 put_unaligned_be16(tg_pt_gp_id, &buf[off]);
328 len += 8; /* Header size + Designation descriptor */
330 * Logical Unit Group identifier, see spc4r17
334 lu_gp_mem = dev->dev_alua_lu_gp_mem;
336 goto check_scsi_name;
338 spin_lock(&lu_gp_mem->lu_gp_mem_lock);
339 lu_gp = lu_gp_mem->lu_gp;
341 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
342 goto check_scsi_name;
344 lu_gp_id = lu_gp->lu_gp_id;
345 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
347 buf[off++] |= 0x1; /* CODE SET == Binary */
348 /* DESIGNATOR TYPE == Logical Unit Group identifier */
350 off++; /* Skip over Reserved */
351 buf[off++] = 4; /* DESIGNATOR LENGTH */
352 off += 2; /* Skip over Reserved Field */
353 put_unaligned_be16(lu_gp_id, &buf[off]);
355 len += 8; /* Header size + Designation descriptor */
357 * SCSI name string designator, see spc4r17
360 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
361 * section 7.5.1 Table 362
364 buf[off] = tpg->proto_id << 4;
365 buf[off++] |= 0x3; /* CODE SET == UTF-8 */
366 buf[off] = 0x80; /* Set PIV=1 */
367 /* Set ASSOCIATION == target port: 01b */
369 /* DESIGNATOR TYPE == SCSI name string */
371 off += 2; /* Skip over Reserved and length */
373 * SCSI name string identifer containing, $FABRIC_MOD
374 * dependent information. For LIO-Target and iSCSI
375 * Target Port, this means "<iSCSI name>,t,0x<TPGT> in
378 tpgt = tpg->se_tpg_tfo->tpg_get_tag(tpg);
379 scsi_name_len = sprintf(&buf[off], "%s,t,0x%04x",
380 tpg->se_tpg_tfo->tpg_get_wwn(tpg), tpgt);
381 scsi_name_len += 1 /* Include NULL terminator */;
383 * The null-terminated, null-padded (see 4.4.2) SCSI
384 * NAME STRING field contains a UTF-8 format string.
385 * The number of bytes in the SCSI NAME STRING field
386 * (i.e., the value in the DESIGNATOR LENGTH field)
387 * shall be no larger than 256 and shall be a multiple
390 padding = ((-scsi_name_len) & 3);
392 scsi_name_len += padding;
393 if (scsi_name_len > 256)
396 buf[off-1] = scsi_name_len;
397 off += scsi_name_len;
398 /* Header size + Designation descriptor */
399 len += (scsi_name_len + 4);
402 * Target device designator
404 buf[off] = tpg->proto_id << 4;
405 buf[off++] |= 0x3; /* CODE SET == UTF-8 */
406 buf[off] = 0x80; /* Set PIV=1 */
407 /* Set ASSOCIATION == target device: 10b */
409 /* DESIGNATOR TYPE == SCSI name string */
411 off += 2; /* Skip over Reserved and length */
413 * SCSI name string identifer containing, $FABRIC_MOD
414 * dependent information. For LIO-Target and iSCSI
415 * Target Port, this means "<iSCSI name>" in
418 scsi_target_len = sprintf(&buf[off], "%s",
419 tpg->se_tpg_tfo->tpg_get_wwn(tpg));
420 scsi_target_len += 1 /* Include NULL terminator */;
422 * The null-terminated, null-padded (see 4.4.2) SCSI
423 * NAME STRING field contains a UTF-8 format string.
424 * The number of bytes in the SCSI NAME STRING field
425 * (i.e., the value in the DESIGNATOR LENGTH field)
426 * shall be no larger than 256 and shall be a multiple
429 padding = ((-scsi_target_len) & 3);
431 scsi_target_len += padding;
432 if (scsi_target_len > 256)
433 scsi_target_len = 256;
435 buf[off-1] = scsi_target_len;
436 off += scsi_target_len;
438 /* Header size + Designation descriptor */
439 len += (scsi_target_len + 4);
441 put_unaligned_be16(len, &buf[2]); /* Page Length for VPD 0x83 */
444 EXPORT_SYMBOL(spc_emulate_evpd_83);
446 /* Extended INQUIRY Data VPD Page */
447 static sense_reason_t
448 spc_emulate_evpd_86(struct se_cmd *cmd, unsigned char *buf)
450 struct se_device *dev = cmd->se_dev;
451 struct se_session *sess = cmd->se_sess;
455 * Set GRD_CHK + REF_CHK for TYPE1 protection, or GRD_CHK
456 * only for TYPE3 protection.
458 if (sess->sup_prot_ops & (TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS)) {
459 if (dev->dev_attrib.pi_prot_type == TARGET_DIF_TYPE1_PROT ||
460 cmd->se_sess->sess_prot_type == TARGET_DIF_TYPE1_PROT)
462 else if (dev->dev_attrib.pi_prot_type == TARGET_DIF_TYPE3_PROT ||
463 cmd->se_sess->sess_prot_type == TARGET_DIF_TYPE3_PROT)
467 /* logical unit supports type 1 and type 3 protection */
468 if ((dev->transport->get_device_type(dev) == TYPE_DISK) &&
469 (sess->sup_prot_ops & (TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS)) &&
470 (dev->dev_attrib.pi_prot_type || cmd->se_sess->sess_prot_type)) {
471 buf[4] |= (0x3 << 3);
474 /* Set HEADSUP, ORDSUP, SIMPSUP */
477 /* If WriteCache emulation is enabled, set V_SUP */
478 if (target_check_wce(dev))
480 /* If an LBA map is present set R_SUP */
481 spin_lock(&cmd->se_dev->t10_alua.lba_map_lock);
482 if (!list_empty(&dev->t10_alua.lba_map_list))
484 spin_unlock(&cmd->se_dev->t10_alua.lba_map_lock);
488 /* Block Limits VPD page */
489 static sense_reason_t
490 spc_emulate_evpd_b0(struct se_cmd *cmd, unsigned char *buf)
492 struct se_device *dev = cmd->se_dev;
494 int have_tp = 0, opt, min;
497 * Following spc3r22 section 6.5.3 Block Limits VPD page, when
498 * emulate_tpu=1 or emulate_tpws=1 we will be expect a
499 * different page length for Thin Provisioning.
501 if (dev->dev_attrib.emulate_tpu || dev->dev_attrib.emulate_tpws)
504 buf[0] = dev->transport->get_device_type(dev);
505 buf[3] = have_tp ? 0x3c : 0x10;
510 * Set MAXIMUM COMPARE AND WRITE LENGTH
512 if (dev->dev_attrib.emulate_caw)
516 * Set OPTIMAL TRANSFER LENGTH GRANULARITY
518 if (dev->transport->get_io_min && (min = dev->transport->get_io_min(dev)))
519 put_unaligned_be16(min / dev->dev_attrib.block_size, &buf[6]);
521 put_unaligned_be16(1, &buf[6]);
524 * Set MAXIMUM TRANSFER LENGTH
526 * XXX: Currently assumes single PAGE_SIZE per scatterlist for fabrics
527 * enforcing maximum HW scatter-gather-list entry limit
529 if (cmd->se_tfo->max_data_sg_nents) {
530 mtl = (cmd->se_tfo->max_data_sg_nents * PAGE_SIZE) /
531 dev->dev_attrib.block_size;
533 put_unaligned_be32(min_not_zero(mtl, dev->dev_attrib.hw_max_sectors), &buf[8]);
536 * Set OPTIMAL TRANSFER LENGTH
538 if (dev->transport->get_io_opt && (opt = dev->transport->get_io_opt(dev)))
539 put_unaligned_be32(opt / dev->dev_attrib.block_size, &buf[12]);
541 put_unaligned_be32(dev->dev_attrib.optimal_sectors, &buf[12]);
544 * Exit now if we don't support TP.
550 * Set MAXIMUM UNMAP LBA COUNT
552 put_unaligned_be32(dev->dev_attrib.max_unmap_lba_count, &buf[20]);
555 * Set MAXIMUM UNMAP BLOCK DESCRIPTOR COUNT
557 put_unaligned_be32(dev->dev_attrib.max_unmap_block_desc_count,
561 * Set OPTIMAL UNMAP GRANULARITY
563 put_unaligned_be32(dev->dev_attrib.unmap_granularity, &buf[28]);
566 * UNMAP GRANULARITY ALIGNMENT
568 put_unaligned_be32(dev->dev_attrib.unmap_granularity_alignment,
570 if (dev->dev_attrib.unmap_granularity_alignment != 0)
571 buf[32] |= 0x80; /* Set the UGAVALID bit */
574 * MAXIMUM WRITE SAME LENGTH
577 put_unaligned_be64(dev->dev_attrib.max_write_same_len, &buf[36]);
582 /* Block Device Characteristics VPD page */
583 static sense_reason_t
584 spc_emulate_evpd_b1(struct se_cmd *cmd, unsigned char *buf)
586 struct se_device *dev = cmd->se_dev;
588 buf[0] = dev->transport->get_device_type(dev);
590 buf[5] = dev->dev_attrib.is_nonrot ? 1 : 0;
595 /* Thin Provisioning VPD */
596 static sense_reason_t
597 spc_emulate_evpd_b2(struct se_cmd *cmd, unsigned char *buf)
599 struct se_device *dev = cmd->se_dev;
602 * From spc3r22 section 6.5.4 Thin Provisioning VPD page:
604 * The PAGE LENGTH field is defined in SPC-4. If the DP bit is set to
605 * zero, then the page length shall be set to 0004h. If the DP bit
606 * is set to one, then the page length shall be set to the value
607 * defined in table 162.
609 buf[0] = dev->transport->get_device_type(dev);
612 * Set Hardcoded length mentioned above for DP=0
614 put_unaligned_be16(0x0004, &buf[2]);
617 * The THRESHOLD EXPONENT field indicates the threshold set size in
618 * LBAs as a power of 2 (i.e., the threshold set size is equal to
619 * 2(threshold exponent)).
621 * Note that this is currently set to 0x00 as mkp says it will be
622 * changing again. We can enable this once it has settled in T10
623 * and is actually used by Linux/SCSI ML code.
628 * A TPU bit set to one indicates that the device server supports
629 * the UNMAP command (see 5.25). A TPU bit set to zero indicates
630 * that the device server does not support the UNMAP command.
632 if (dev->dev_attrib.emulate_tpu != 0)
636 * A TPWS bit set to one indicates that the device server supports
637 * the use of the WRITE SAME (16) command (see 5.42) to unmap LBAs.
638 * A TPWS bit set to zero indicates that the device server does not
639 * support the use of the WRITE SAME (16) command to unmap LBAs.
641 if (dev->dev_attrib.emulate_tpws != 0)
642 buf[5] |= 0x40 | 0x20;
645 * The unmap_zeroes_data set means that the underlying device supports
646 * REQ_DISCARD and has the discard_zeroes_data bit set. This satisfies
647 * the SBC requirements for LBPRZ, meaning that a subsequent read
648 * will return zeroes after an UNMAP or WRITE SAME (16) to an LBA
651 if (((dev->dev_attrib.emulate_tpu != 0) ||
652 (dev->dev_attrib.emulate_tpws != 0)) &&
653 (dev->dev_attrib.unmap_zeroes_data != 0))
659 /* Referrals VPD page */
660 static sense_reason_t
661 spc_emulate_evpd_b3(struct se_cmd *cmd, unsigned char *buf)
663 struct se_device *dev = cmd->se_dev;
665 buf[0] = dev->transport->get_device_type(dev);
667 put_unaligned_be32(dev->t10_alua.lba_map_segment_size, &buf[8]);
668 put_unaligned_be32(dev->t10_alua.lba_map_segment_multiplier, &buf[12]);
673 static sense_reason_t
674 spc_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf);
678 sense_reason_t (*emulate)(struct se_cmd *, unsigned char *);
679 } evpd_handlers[] = {
680 { .page = 0x00, .emulate = spc_emulate_evpd_00 },
681 { .page = 0x80, .emulate = spc_emulate_evpd_80 },
682 { .page = 0x83, .emulate = spc_emulate_evpd_83 },
683 { .page = 0x86, .emulate = spc_emulate_evpd_86 },
684 { .page = 0xb0, .emulate = spc_emulate_evpd_b0 },
685 { .page = 0xb1, .emulate = spc_emulate_evpd_b1 },
686 { .page = 0xb2, .emulate = spc_emulate_evpd_b2 },
687 { .page = 0xb3, .emulate = spc_emulate_evpd_b3 },
690 /* supported vital product data pages */
691 static sense_reason_t
692 spc_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf)
697 * Only report the INQUIRY EVPD=1 pages after a valid NAA
698 * Registered Extended LUN WWN has been set via ConfigFS
699 * during device creation/restart.
701 if (cmd->se_dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL) {
702 buf[3] = ARRAY_SIZE(evpd_handlers);
703 for (p = 0; p < ARRAY_SIZE(evpd_handlers); ++p)
704 buf[p + 4] = evpd_handlers[p].page;
710 static sense_reason_t
711 spc_emulate_inquiry(struct se_cmd *cmd)
713 struct se_device *dev = cmd->se_dev;
714 struct se_portal_group *tpg = cmd->se_lun->lun_tpg;
716 unsigned char *cdb = cmd->t_task_cdb;
722 buf = kzalloc(SE_INQUIRY_BUF, GFP_KERNEL);
724 pr_err("Unable to allocate response buffer for INQUIRY\n");
725 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
728 if (dev == rcu_access_pointer(tpg->tpg_virt_lun0->lun_se_dev))
729 buf[0] = 0x3f; /* Not connected */
731 buf[0] = dev->transport->get_device_type(dev);
733 if (!(cdb[1] & 0x1)) {
735 pr_err("INQUIRY with EVPD==0 but PAGE CODE=%02x\n",
737 ret = TCM_INVALID_CDB_FIELD;
741 ret = spc_emulate_inquiry_std(cmd, buf);
746 for (p = 0; p < ARRAY_SIZE(evpd_handlers); ++p) {
747 if (cdb[2] == evpd_handlers[p].page) {
749 ret = evpd_handlers[p].emulate(cmd, buf);
750 len = get_unaligned_be16(&buf[2]) + 4;
755 pr_err("Unknown VPD Code: 0x%02x\n", cdb[2]);
756 ret = TCM_INVALID_CDB_FIELD;
759 rbuf = transport_kmap_data_sg(cmd);
761 memcpy(rbuf, buf, min_t(u32, SE_INQUIRY_BUF, cmd->data_length));
762 transport_kunmap_data_sg(cmd);
767 target_complete_cmd_with_length(cmd, GOOD, len);
771 static int spc_modesense_rwrecovery(struct se_cmd *cmd, u8 pc, u8 *p)
776 /* No changeable values for now */
784 static int spc_modesense_control(struct se_cmd *cmd, u8 pc, u8 *p)
786 struct se_device *dev = cmd->se_dev;
787 struct se_session *sess = cmd->se_sess;
792 /* No changeable values for now */
796 /* GLTSD: No implicit save of log parameters */
798 if (target_sense_desc_format(dev))
799 /* D_SENSE: Descriptor format sense data for 64bit sectors */
803 * From spc4r23, 7.4.7 Control mode page
805 * The QUEUE ALGORITHM MODIFIER field (see table 368) specifies
806 * restrictions on the algorithm used for reordering commands
807 * having the SIMPLE task attribute (see SAM-4).
809 * Table 368 -- QUEUE ALGORITHM MODIFIER field
811 * 0h Restricted reordering
812 * 1h Unrestricted reordering allowed
814 * 8h to Fh Vendor specific
816 * A value of zero in the QUEUE ALGORITHM MODIFIER field specifies that
817 * the device server shall order the processing sequence of commands
818 * having the SIMPLE task attribute such that data integrity is maintained
819 * for that I_T nexus (i.e., if the transmission of new SCSI transport protocol
820 * requests is halted at any time, the final value of all data observable
821 * on the medium shall be the same as if all the commands had been processed
822 * with the ORDERED task attribute).
824 * A value of one in the QUEUE ALGORITHM MODIFIER field specifies that the
825 * device server may reorder the processing sequence of commands having the
826 * SIMPLE task attribute in any manner. Any data integrity exposures related to
827 * command sequence order shall be explicitly handled by the application client
828 * through the selection of appropriate ommands and task attributes.
830 p[3] = (dev->dev_attrib.emulate_rest_reord == 1) ? 0x00 : 0x10;
832 * From spc4r17, section 7.4.6 Control mode Page
834 * Unit Attention interlocks control (UN_INTLCK_CTRL) to code 00b
836 * 00b: The logical unit shall clear any unit attention condition
837 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
838 * status and shall not establish a unit attention condition when a com-
839 * mand is completed with BUSY, TASK SET FULL, or RESERVATION CONFLICT
842 * 10b: The logical unit shall not clear any unit attention condition
843 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
844 * status and shall not establish a unit attention condition when
845 * a command is completed with BUSY, TASK SET FULL, or RESERVATION
848 * 11b a The logical unit shall not clear any unit attention condition
849 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
850 * status and shall establish a unit attention condition for the
851 * initiator port associated with the I_T nexus on which the BUSY,
852 * TASK SET FULL, or RESERVATION CONFLICT status is being returned.
853 * Depending on the status, the additional sense code shall be set to
854 * PREVIOUS BUSY STATUS, PREVIOUS TASK SET FULL STATUS, or PREVIOUS
855 * RESERVATION CONFLICT STATUS. Until it is cleared by a REQUEST SENSE
856 * command, a unit attention condition shall be established only once
857 * for a BUSY, TASK SET FULL, or RESERVATION CONFLICT status regardless
858 * to the number of commands completed with one of those status codes.
860 p[4] = (dev->dev_attrib.emulate_ua_intlck_ctrl == 2) ? 0x30 :
861 (dev->dev_attrib.emulate_ua_intlck_ctrl == 1) ? 0x20 : 0x00;
863 * From spc4r17, section 7.4.6 Control mode Page
865 * Task Aborted Status (TAS) bit set to zero.
867 * A task aborted status (TAS) bit set to zero specifies that aborted
868 * tasks shall be terminated by the device server without any response
869 * to the application client. A TAS bit set to one specifies that tasks
870 * aborted by the actions of an I_T nexus other than the I_T nexus on
871 * which the command was received shall be completed with TASK ABORTED
872 * status (see SAM-4).
874 p[5] = (dev->dev_attrib.emulate_tas) ? 0x40 : 0x00;
876 * From spc4r30, section 7.5.7 Control mode page
878 * Application Tag Owner (ATO) bit set to one.
880 * If the ATO bit is set to one the device server shall not modify the
881 * LOGICAL BLOCK APPLICATION TAG field and, depending on the protection
882 * type, shall not modify the contents of the LOGICAL BLOCK REFERENCE
885 if (sess->sup_prot_ops & (TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS)) {
886 if (dev->dev_attrib.pi_prot_type || sess->sess_prot_type)
898 static int spc_modesense_caching(struct se_cmd *cmd, u8 pc, u8 *p)
900 struct se_device *dev = cmd->se_dev;
905 /* No changeable values for now */
909 if (target_check_wce(dev))
910 p[2] = 0x04; /* Write Cache Enable */
911 p[12] = 0x20; /* Disabled Read Ahead */
917 static int spc_modesense_informational_exceptions(struct se_cmd *cmd, u8 pc, unsigned char *p)
922 /* No changeable values for now */
933 int (*emulate)(struct se_cmd *, u8, unsigned char *);
934 } modesense_handlers[] = {
935 { .page = 0x01, .subpage = 0x00, .emulate = spc_modesense_rwrecovery },
936 { .page = 0x08, .subpage = 0x00, .emulate = spc_modesense_caching },
937 { .page = 0x0a, .subpage = 0x00, .emulate = spc_modesense_control },
938 { .page = 0x1c, .subpage = 0x00, .emulate = spc_modesense_informational_exceptions },
941 static void spc_modesense_write_protect(unsigned char *buf, int type)
944 * I believe that the WP bit (bit 7) in the mode header is the same for
951 buf[0] |= 0x80; /* WP bit */
956 static void spc_modesense_dpofua(unsigned char *buf, int type)
960 buf[0] |= 0x10; /* DPOFUA bit */
967 static int spc_modesense_blockdesc(unsigned char *buf, u64 blocks, u32 block_size)
970 put_unaligned_be32(min(blocks, 0xffffffffull), buf);
972 put_unaligned_be32(block_size, buf);
976 static int spc_modesense_long_blockdesc(unsigned char *buf, u64 blocks, u32 block_size)
978 if (blocks <= 0xffffffff)
979 return spc_modesense_blockdesc(buf + 3, blocks, block_size) + 3;
981 *buf++ = 1; /* LONGLBA */
984 put_unaligned_be64(blocks, buf);
986 put_unaligned_be32(block_size, buf);
991 static sense_reason_t spc_emulate_modesense(struct se_cmd *cmd)
993 struct se_device *dev = cmd->se_dev;
994 char *cdb = cmd->t_task_cdb;
995 unsigned char buf[SE_MODE_PAGE_BUF], *rbuf;
996 int type = dev->transport->get_device_type(dev);
997 int ten = (cmd->t_task_cdb[0] == MODE_SENSE_10);
998 bool dbd = !!(cdb[1] & 0x08);
999 bool llba = ten ? !!(cdb[1] & 0x10) : false;
1000 u8 pc = cdb[2] >> 6;
1001 u8 page = cdb[2] & 0x3f;
1002 u8 subpage = cdb[3];
1007 memset(buf, 0, SE_MODE_PAGE_BUF);
1010 * Skip over MODE DATA LENGTH + MEDIUM TYPE fields to byte 3 for
1011 * MODE_SENSE_10 and byte 2 for MODE_SENSE (6).
1013 length = ten ? 3 : 2;
1015 /* DEVICE-SPECIFIC PARAMETER */
1016 if (cmd->se_lun->lun_access_ro || target_lun_is_rdonly(cmd))
1017 spc_modesense_write_protect(&buf[length], type);
1020 * SBC only allows us to enable FUA and DPO together. Fortunately
1021 * DPO is explicitly specified as a hint, so a noop is a perfectly
1022 * valid implementation.
1024 if (target_check_fua(dev))
1025 spc_modesense_dpofua(&buf[length], type);
1029 /* BLOCK DESCRIPTOR */
1032 * For now we only include a block descriptor for disk (SBC)
1033 * devices; other command sets use a slightly different format.
1035 if (!dbd && type == TYPE_DISK) {
1036 u64 blocks = dev->transport->get_blocks(dev);
1037 u32 block_size = dev->dev_attrib.block_size;
1041 length += spc_modesense_long_blockdesc(&buf[length],
1042 blocks, block_size);
1045 length += spc_modesense_blockdesc(&buf[length],
1046 blocks, block_size);
1049 length += spc_modesense_blockdesc(&buf[length], blocks,
1060 if (subpage != 0x00 && subpage != 0xff) {
1061 pr_warn("MODE_SENSE: Invalid subpage code: 0x%02x\n", subpage);
1062 return TCM_INVALID_CDB_FIELD;
1065 for (i = 0; i < ARRAY_SIZE(modesense_handlers); ++i) {
1067 * Tricky way to say all subpage 00h for
1068 * subpage==0, all subpages for subpage==0xff
1069 * (and we just checked above that those are
1070 * the only two possibilities).
1072 if ((modesense_handlers[i].subpage & ~subpage) == 0) {
1073 ret = modesense_handlers[i].emulate(cmd, pc, &buf[length]);
1074 if (!ten && length + ret >= 255)
1083 for (i = 0; i < ARRAY_SIZE(modesense_handlers); ++i)
1084 if (modesense_handlers[i].page == page &&
1085 modesense_handlers[i].subpage == subpage) {
1086 length += modesense_handlers[i].emulate(cmd, pc, &buf[length]);
1091 * We don't intend to implement:
1092 * - obsolete page 03h "format parameters" (checked by Solaris)
1095 pr_err("MODE SENSE: unimplemented page/subpage: 0x%02x/0x%02x\n",
1098 return TCM_UNKNOWN_MODE_PAGE;
1102 put_unaligned_be16(length - 2, buf);
1104 buf[0] = length - 1;
1106 rbuf = transport_kmap_data_sg(cmd);
1108 memcpy(rbuf, buf, min_t(u32, SE_MODE_PAGE_BUF, cmd->data_length));
1109 transport_kunmap_data_sg(cmd);
1112 target_complete_cmd_with_length(cmd, GOOD, length);
1116 static sense_reason_t spc_emulate_modeselect(struct se_cmd *cmd)
1118 char *cdb = cmd->t_task_cdb;
1119 bool ten = cdb[0] == MODE_SELECT_10;
1120 int off = ten ? 8 : 4;
1121 bool pf = !!(cdb[1] & 0x10);
1124 unsigned char tbuf[SE_MODE_PAGE_BUF];
1126 sense_reason_t ret = 0;
1129 if (!cmd->data_length) {
1130 target_complete_cmd(cmd, GOOD);
1134 if (cmd->data_length < off + 2)
1135 return TCM_PARAMETER_LIST_LENGTH_ERROR;
1137 buf = transport_kmap_data_sg(cmd);
1139 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1142 ret = TCM_INVALID_CDB_FIELD;
1146 page = buf[off] & 0x3f;
1147 subpage = buf[off] & 0x40 ? buf[off + 1] : 0;
1149 for (i = 0; i < ARRAY_SIZE(modesense_handlers); ++i)
1150 if (modesense_handlers[i].page == page &&
1151 modesense_handlers[i].subpage == subpage) {
1152 memset(tbuf, 0, SE_MODE_PAGE_BUF);
1153 length = modesense_handlers[i].emulate(cmd, 0, tbuf);
1154 goto check_contents;
1157 ret = TCM_UNKNOWN_MODE_PAGE;
1161 if (cmd->data_length < off + length) {
1162 ret = TCM_PARAMETER_LIST_LENGTH_ERROR;
1166 if (memcmp(buf + off, tbuf, length))
1167 ret = TCM_INVALID_PARAMETER_LIST;
1170 transport_kunmap_data_sg(cmd);
1173 target_complete_cmd(cmd, GOOD);
1177 static sense_reason_t spc_emulate_request_sense(struct se_cmd *cmd)
1179 unsigned char *cdb = cmd->t_task_cdb;
1180 unsigned char *rbuf;
1181 u8 ua_asc = 0, ua_ascq = 0;
1182 unsigned char buf[SE_SENSE_BUF];
1183 bool desc_format = target_sense_desc_format(cmd->se_dev);
1185 memset(buf, 0, SE_SENSE_BUF);
1187 if (cdb[1] & 0x01) {
1188 pr_err("REQUEST_SENSE description emulation not"
1190 return TCM_INVALID_CDB_FIELD;
1193 rbuf = transport_kmap_data_sg(cmd);
1195 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1197 if (!core_scsi3_ua_clear_for_request_sense(cmd, &ua_asc, &ua_ascq))
1198 scsi_build_sense_buffer(desc_format, buf, UNIT_ATTENTION,
1201 scsi_build_sense_buffer(desc_format, buf, NO_SENSE, 0x0, 0x0);
1203 memcpy(rbuf, buf, min_t(u32, sizeof(buf), cmd->data_length));
1204 transport_kunmap_data_sg(cmd);
1206 target_complete_cmd(cmd, GOOD);
1210 sense_reason_t spc_emulate_report_luns(struct se_cmd *cmd)
1212 struct se_dev_entry *deve;
1213 struct se_session *sess = cmd->se_sess;
1214 struct se_node_acl *nacl;
1215 struct scsi_lun slun;
1217 u32 lun_count = 0, offset = 8;
1220 buf = transport_kmap_data_sg(cmd);
1221 if (cmd->data_length && !buf)
1222 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1225 * If no struct se_session pointer is present, this struct se_cmd is
1226 * coming via a target_core_mod PASSTHROUGH op, and not through
1227 * a $FABRIC_MOD. In that case, report LUN=0 only.
1232 nacl = sess->se_node_acl;
1235 hlist_for_each_entry_rcu(deve, &nacl->lun_entry_hlist, link) {
1237 * We determine the correct LUN LIST LENGTH even once we
1238 * have reached the initial allocation length.
1239 * See SPC2-R20 7.19.
1242 if (offset >= cmd->data_length)
1245 int_to_scsilun(deve->mapped_lun, &slun);
1246 memcpy(buf + offset, &slun,
1247 min(8u, cmd->data_length - offset));
1253 * See SPC3 r07, page 159.
1257 * If no LUNs are accessible, report virtual LUN 0.
1259 if (lun_count == 0) {
1260 int_to_scsilun(0, &slun);
1261 if (cmd->data_length > 8)
1262 memcpy(buf + offset, &slun,
1263 min(8u, cmd->data_length - offset));
1268 len = cpu_to_be32(lun_count * 8);
1269 memcpy(buf, &len, min_t(int, sizeof len, cmd->data_length));
1270 transport_kunmap_data_sg(cmd);
1273 target_complete_cmd_with_length(cmd, GOOD, 8 + lun_count * 8);
1276 EXPORT_SYMBOL(spc_emulate_report_luns);
1278 static sense_reason_t
1279 spc_emulate_testunitready(struct se_cmd *cmd)
1281 target_complete_cmd(cmd, GOOD);
1286 spc_parse_cdb(struct se_cmd *cmd, unsigned int *size)
1288 struct se_device *dev = cmd->se_dev;
1289 unsigned char *cdb = cmd->t_task_cdb;
1294 cmd->execute_cmd = spc_emulate_modeselect;
1296 case MODE_SELECT_10:
1297 *size = get_unaligned_be16(&cdb[7]);
1298 cmd->execute_cmd = spc_emulate_modeselect;
1302 cmd->execute_cmd = spc_emulate_modesense;
1305 *size = get_unaligned_be16(&cdb[7]);
1306 cmd->execute_cmd = spc_emulate_modesense;
1310 *size = get_unaligned_be16(&cdb[7]);
1312 case PERSISTENT_RESERVE_IN:
1313 *size = get_unaligned_be16(&cdb[7]);
1314 cmd->execute_cmd = target_scsi3_emulate_pr_in;
1316 case PERSISTENT_RESERVE_OUT:
1317 *size = get_unaligned_be32(&cdb[5]);
1318 cmd->execute_cmd = target_scsi3_emulate_pr_out;
1322 if (cdb[0] == RELEASE_10)
1323 *size = get_unaligned_be16(&cdb[7]);
1325 *size = cmd->data_length;
1327 cmd->execute_cmd = target_scsi2_reservation_release;
1332 * The SPC-2 RESERVE does not contain a size in the SCSI CDB.
1333 * Assume the passthrough or $FABRIC_MOD will tell us about it.
1335 if (cdb[0] == RESERVE_10)
1336 *size = get_unaligned_be16(&cdb[7]);
1338 *size = cmd->data_length;
1340 cmd->execute_cmd = target_scsi2_reservation_reserve;
1344 cmd->execute_cmd = spc_emulate_request_sense;
1347 *size = get_unaligned_be16(&cdb[3]);
1350 * Do implicit HEAD_OF_QUEUE processing for INQUIRY.
1351 * See spc4r17 section 5.3
1353 cmd->sam_task_attr = TCM_HEAD_TAG;
1354 cmd->execute_cmd = spc_emulate_inquiry;
1356 case SECURITY_PROTOCOL_IN:
1357 case SECURITY_PROTOCOL_OUT:
1358 *size = get_unaligned_be32(&cdb[6]);
1361 *size = get_unaligned_be32(&cdb[10]);
1362 cmd->execute_cmd = target_do_xcopy;
1364 case RECEIVE_COPY_RESULTS:
1365 *size = get_unaligned_be32(&cdb[10]);
1366 cmd->execute_cmd = target_do_receive_copy_results;
1368 case READ_ATTRIBUTE:
1369 case WRITE_ATTRIBUTE:
1370 *size = get_unaligned_be32(&cdb[10]);
1372 case RECEIVE_DIAGNOSTIC:
1373 case SEND_DIAGNOSTIC:
1374 *size = get_unaligned_be16(&cdb[3]);
1377 *size = get_unaligned_be24(&cdb[6]);
1380 cmd->execute_cmd = spc_emulate_report_luns;
1381 *size = get_unaligned_be32(&cdb[6]);
1383 * Do implicit HEAD_OF_QUEUE processing for REPORT_LUNS
1384 * See spc4r17 section 5.3
1386 cmd->sam_task_attr = TCM_HEAD_TAG;
1388 case TEST_UNIT_READY:
1389 cmd->execute_cmd = spc_emulate_testunitready;
1392 case MAINTENANCE_IN:
1393 if (dev->transport->get_device_type(dev) != TYPE_ROM) {
1395 * MAINTENANCE_IN from SCC-2
1396 * Check for emulated MI_REPORT_TARGET_PGS
1398 if ((cdb[1] & 0x1f) == MI_REPORT_TARGET_PGS) {
1400 target_emulate_report_target_port_groups;
1402 *size = get_unaligned_be32(&cdb[6]);
1405 * GPCMD_SEND_KEY from multi media commands
1407 *size = get_unaligned_be16(&cdb[8]);
1410 case MAINTENANCE_OUT:
1411 if (dev->transport->get_device_type(dev) != TYPE_ROM) {
1413 * MAINTENANCE_OUT from SCC-2
1414 * Check for emulated MO_SET_TARGET_PGS.
1416 if (cdb[1] == MO_SET_TARGET_PGS) {
1418 target_emulate_set_target_port_groups;
1420 *size = get_unaligned_be32(&cdb[6]);
1423 * GPCMD_SEND_KEY from multi media commands
1425 *size = get_unaligned_be16(&cdb[8]);
1429 return TCM_UNSUPPORTED_SCSI_OPCODE;
1434 EXPORT_SYMBOL(spc_parse_cdb);