1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * SCSI Primary Commands (SPC) parsing and emulation.
5 * (c) Copyright 2002-2013 Datera, Inc.
7 * Nicholas A. Bellinger <nab@kernel.org>
10 #include <linux/kernel.h>
11 #include <linux/module.h>
12 #include <asm/unaligned.h>
14 #include <scsi/scsi_proto.h>
15 #include <scsi/scsi_common.h>
16 #include <scsi/scsi_tcq.h>
18 #include <target/target_core_base.h>
19 #include <target/target_core_backend.h>
20 #include <target/target_core_fabric.h>
22 #include "target_core_internal.h"
23 #include "target_core_alua.h"
24 #include "target_core_pr.h"
25 #include "target_core_ua.h"
26 #include "target_core_xcopy.h"
28 static void spc_fill_alua_data(struct se_lun *lun, unsigned char *buf)
30 struct t10_alua_tg_pt_gp *tg_pt_gp;
33 * Set SCCS for MAINTENANCE_IN + REPORT_TARGET_PORT_GROUPS.
38 * Set TPGS field for explicit and/or implicit ALUA access type
41 * See spc4r17 section 6.4.2 Table 135
43 spin_lock(&lun->lun_tg_pt_gp_lock);
44 tg_pt_gp = lun->lun_tg_pt_gp;
46 buf[5] |= tg_pt_gp->tg_pt_gp_alua_access_type;
47 spin_unlock(&lun->lun_tg_pt_gp_lock);
51 spc_emulate_inquiry_std(struct se_cmd *cmd, unsigned char *buf)
53 struct se_lun *lun = cmd->se_lun;
54 struct se_device *dev = cmd->se_dev;
55 struct se_session *sess = cmd->se_sess;
57 /* Set RMB (removable media) for tape devices */
58 if (dev->transport->get_device_type(dev) == TYPE_TAPE)
61 buf[2] = 0x05; /* SPC-3 */
64 * NORMACA and HISUP = 0, RESPONSE DATA FORMAT = 2
67 * A RESPONSE DATA FORMAT field set to 2h indicates that the
68 * standard INQUIRY data is in the format defined in this
69 * standard. Response data format values less than 2h are
70 * obsolete. Response data format values greater than 2h are
76 * Enable SCCS and TPGS fields for Emulated ALUA
78 spc_fill_alua_data(lun, buf);
81 * Set Third-Party Copy (3PC) bit to indicate support for EXTENDED_COPY
83 if (dev->dev_attrib.emulate_3pc)
86 * Set Protection (PROTECT) bit when DIF has been enabled on the
87 * device, and the fabric supports VERIFY + PASS. Also report
88 * PROTECT=1 if sess_prot_type has been configured to allow T10-PI
89 * to unprotected devices.
91 if (sess->sup_prot_ops & (TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS)) {
92 if (dev->dev_attrib.pi_prot_type || cmd->se_sess->sess_prot_type)
96 buf[7] = 0x2; /* CmdQue=1 */
99 * ASCII data fields described as being left-aligned shall have any
100 * unused bytes at the end of the field (i.e., highest offset) and the
101 * unused bytes shall be filled with ASCII space characters (20h).
103 memset(&buf[8], 0x20,
104 INQUIRY_VENDOR_LEN + INQUIRY_MODEL_LEN + INQUIRY_REVISION_LEN);
105 memcpy(&buf[8], dev->t10_wwn.vendor,
106 strnlen(dev->t10_wwn.vendor, INQUIRY_VENDOR_LEN));
107 memcpy(&buf[16], dev->t10_wwn.model,
108 strnlen(dev->t10_wwn.model, INQUIRY_MODEL_LEN));
109 memcpy(&buf[32], dev->t10_wwn.revision,
110 strnlen(dev->t10_wwn.revision, INQUIRY_REVISION_LEN));
111 buf[4] = 31; /* Set additional length to 31 */
115 EXPORT_SYMBOL(spc_emulate_inquiry_std);
117 /* unit serial number */
118 static sense_reason_t
119 spc_emulate_evpd_80(struct se_cmd *cmd, unsigned char *buf)
121 struct se_device *dev = cmd->se_dev;
124 if (dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL) {
125 len = sprintf(&buf[4], "%s", dev->t10_wwn.unit_serial);
126 len++; /* Extra Byte for NULL Terminator */
132 void spc_parse_naa_6h_vendor_specific(struct se_device *dev,
135 unsigned char *p = &dev->t10_wwn.unit_serial[0];
140 * Generate up to 36 bits of VENDOR SPECIFIC IDENTIFIER starting on
141 * byte 3 bit 3-0 for NAA IEEE Registered Extended DESIGNATOR field
142 * format, followed by 64 bits of VENDOR SPECIFIC IDENTIFIER EXTENSION
143 * to complete the payload. These are based from VPD=0x80 PRODUCT SERIAL
144 * NUMBER set via vpd_unit_serial in target_core_configfs.c to ensure
145 * per device uniqeness.
147 for (cnt = 0; *p && cnt < 13; p++) {
148 int val = hex_to_bin(*p);
164 * Device identification VPD, for a complete list of
165 * DESIGNATOR TYPEs see spc4r17 Table 459.
168 spc_emulate_evpd_83(struct se_cmd *cmd, unsigned char *buf)
170 struct se_device *dev = cmd->se_dev;
171 struct se_lun *lun = cmd->se_lun;
172 struct se_portal_group *tpg = NULL;
173 struct t10_alua_lu_gp_member *lu_gp_mem;
174 struct t10_alua_tg_pt_gp *tg_pt_gp;
175 unsigned char *prod = &dev->t10_wwn.model[0];
177 u32 unit_serial_len, off = 0;
183 * NAA IEEE Registered Extended Assigned designator format, see
184 * spc4r17 section 7.7.3.6.5
186 * We depend upon a target_core_mod/ConfigFS provided
187 * /sys/kernel/config/target/core/$HBA/$DEV/wwn/vpd_unit_serial
188 * value in order to return the NAA id.
190 if (!(dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL))
191 goto check_t10_vend_desc;
193 /* CODE SET == Binary */
196 /* Set ASSOCIATION == addressed logical unit: 0)b */
199 /* Identifier/Designator type == NAA identifier */
203 /* Identifier/Designator length */
207 * Start NAA IEEE Registered Extended Identifier/Designator
209 buf[off++] = (0x6 << 4);
212 * Use OpenFabrics IEEE Company ID: 00 14 05
216 buf[off] = (0x5 << 4);
219 * Return ConfigFS Unit Serial Number information for
220 * VENDOR_SPECIFIC_IDENTIFIER and
221 * VENDOR_SPECIFIC_IDENTIFIER_EXTENTION
223 spc_parse_naa_6h_vendor_specific(dev, &buf[off]);
230 * T10 Vendor Identifier Page, see spc4r17 section 7.7.3.4
232 id_len = 8; /* For Vendor field */
233 prod_len = 4; /* For VPD Header */
234 prod_len += 8; /* For Vendor field */
235 prod_len += strlen(prod);
236 prod_len++; /* For : */
238 if (dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL) {
239 unit_serial_len = strlen(&dev->t10_wwn.unit_serial[0]);
240 unit_serial_len++; /* For NULL Terminator */
242 id_len += sprintf(&buf[off+12], "%s:%s", prod,
243 &dev->t10_wwn.unit_serial[0]);
245 buf[off] = 0x2; /* ASCII */
246 buf[off+1] = 0x1; /* T10 Vendor ID */
248 /* left align Vendor ID and pad with spaces */
249 memset(&buf[off+4], 0x20, INQUIRY_VENDOR_LEN);
250 memcpy(&buf[off+4], dev->t10_wwn.vendor,
251 strnlen(dev->t10_wwn.vendor, INQUIRY_VENDOR_LEN));
252 /* Extra Byte for NULL Terminator */
254 /* Identifier Length */
256 /* Header size for Designation descriptor */
261 struct t10_alua_lu_gp *lu_gp;
262 u32 padding, scsi_name_len, scsi_target_len;
269 * Relative target port identifer, see spc4r17
272 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
273 * section 7.5.1 Table 362
275 buf[off] = tpg->proto_id << 4;
276 buf[off++] |= 0x1; /* CODE SET == Binary */
277 buf[off] = 0x80; /* Set PIV=1 */
278 /* Set ASSOCIATION == target port: 01b */
280 /* DESIGNATOR TYPE == Relative target port identifer */
282 off++; /* Skip over Reserved */
283 buf[off++] = 4; /* DESIGNATOR LENGTH */
284 /* Skip over Obsolete field in RTPI payload
287 put_unaligned_be16(lun->lun_rtpi, &buf[off]);
289 len += 8; /* Header size + Designation descriptor */
291 * Target port group identifier, see spc4r17
294 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
295 * section 7.5.1 Table 362
297 spin_lock(&lun->lun_tg_pt_gp_lock);
298 tg_pt_gp = lun->lun_tg_pt_gp;
300 spin_unlock(&lun->lun_tg_pt_gp_lock);
303 tg_pt_gp_id = tg_pt_gp->tg_pt_gp_id;
304 spin_unlock(&lun->lun_tg_pt_gp_lock);
306 buf[off] = tpg->proto_id << 4;
307 buf[off++] |= 0x1; /* CODE SET == Binary */
308 buf[off] = 0x80; /* Set PIV=1 */
309 /* Set ASSOCIATION == target port: 01b */
311 /* DESIGNATOR TYPE == Target port group identifier */
313 off++; /* Skip over Reserved */
314 buf[off++] = 4; /* DESIGNATOR LENGTH */
315 off += 2; /* Skip over Reserved Field */
316 put_unaligned_be16(tg_pt_gp_id, &buf[off]);
318 len += 8; /* Header size + Designation descriptor */
320 * Logical Unit Group identifier, see spc4r17
324 lu_gp_mem = dev->dev_alua_lu_gp_mem;
326 goto check_scsi_name;
328 spin_lock(&lu_gp_mem->lu_gp_mem_lock);
329 lu_gp = lu_gp_mem->lu_gp;
331 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
332 goto check_scsi_name;
334 lu_gp_id = lu_gp->lu_gp_id;
335 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
337 buf[off++] |= 0x1; /* CODE SET == Binary */
338 /* DESIGNATOR TYPE == Logical Unit Group identifier */
340 off++; /* Skip over Reserved */
341 buf[off++] = 4; /* DESIGNATOR LENGTH */
342 off += 2; /* Skip over Reserved Field */
343 put_unaligned_be16(lu_gp_id, &buf[off]);
345 len += 8; /* Header size + Designation descriptor */
347 * SCSI name string designator, see spc4r17
350 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
351 * section 7.5.1 Table 362
354 buf[off] = tpg->proto_id << 4;
355 buf[off++] |= 0x3; /* CODE SET == UTF-8 */
356 buf[off] = 0x80; /* Set PIV=1 */
357 /* Set ASSOCIATION == target port: 01b */
359 /* DESIGNATOR TYPE == SCSI name string */
361 off += 2; /* Skip over Reserved and length */
363 * SCSI name string identifer containing, $FABRIC_MOD
364 * dependent information. For LIO-Target and iSCSI
365 * Target Port, this means "<iSCSI name>,t,0x<TPGT> in
368 tpgt = tpg->se_tpg_tfo->tpg_get_tag(tpg);
369 scsi_name_len = sprintf(&buf[off], "%s,t,0x%04x",
370 tpg->se_tpg_tfo->tpg_get_wwn(tpg), tpgt);
371 scsi_name_len += 1 /* Include NULL terminator */;
373 * The null-terminated, null-padded (see 4.4.2) SCSI
374 * NAME STRING field contains a UTF-8 format string.
375 * The number of bytes in the SCSI NAME STRING field
376 * (i.e., the value in the DESIGNATOR LENGTH field)
377 * shall be no larger than 256 and shall be a multiple
380 padding = ((-scsi_name_len) & 3);
382 scsi_name_len += padding;
383 if (scsi_name_len > 256)
386 buf[off-1] = scsi_name_len;
387 off += scsi_name_len;
388 /* Header size + Designation descriptor */
389 len += (scsi_name_len + 4);
392 * Target device designator
394 buf[off] = tpg->proto_id << 4;
395 buf[off++] |= 0x3; /* CODE SET == UTF-8 */
396 buf[off] = 0x80; /* Set PIV=1 */
397 /* Set ASSOCIATION == target device: 10b */
399 /* DESIGNATOR TYPE == SCSI name string */
401 off += 2; /* Skip over Reserved and length */
403 * SCSI name string identifer containing, $FABRIC_MOD
404 * dependent information. For LIO-Target and iSCSI
405 * Target Port, this means "<iSCSI name>" in
408 scsi_target_len = sprintf(&buf[off], "%s",
409 tpg->se_tpg_tfo->tpg_get_wwn(tpg));
410 scsi_target_len += 1 /* Include NULL terminator */;
412 * The null-terminated, null-padded (see 4.4.2) SCSI
413 * NAME STRING field contains a UTF-8 format string.
414 * The number of bytes in the SCSI NAME STRING field
415 * (i.e., the value in the DESIGNATOR LENGTH field)
416 * shall be no larger than 256 and shall be a multiple
419 padding = ((-scsi_target_len) & 3);
421 scsi_target_len += padding;
422 if (scsi_target_len > 256)
423 scsi_target_len = 256;
425 buf[off-1] = scsi_target_len;
426 off += scsi_target_len;
428 /* Header size + Designation descriptor */
429 len += (scsi_target_len + 4);
431 put_unaligned_be16(len, &buf[2]); /* Page Length for VPD 0x83 */
434 EXPORT_SYMBOL(spc_emulate_evpd_83);
436 /* Extended INQUIRY Data VPD Page */
437 static sense_reason_t
438 spc_emulate_evpd_86(struct se_cmd *cmd, unsigned char *buf)
440 struct se_device *dev = cmd->se_dev;
441 struct se_session *sess = cmd->se_sess;
445 * Set GRD_CHK + REF_CHK for TYPE1 protection, or GRD_CHK
446 * only for TYPE3 protection.
448 if (sess->sup_prot_ops & (TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS)) {
449 if (dev->dev_attrib.pi_prot_type == TARGET_DIF_TYPE1_PROT ||
450 cmd->se_sess->sess_prot_type == TARGET_DIF_TYPE1_PROT)
452 else if (dev->dev_attrib.pi_prot_type == TARGET_DIF_TYPE3_PROT ||
453 cmd->se_sess->sess_prot_type == TARGET_DIF_TYPE3_PROT)
457 /* logical unit supports type 1 and type 3 protection */
458 if ((dev->transport->get_device_type(dev) == TYPE_DISK) &&
459 (sess->sup_prot_ops & (TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS)) &&
460 (dev->dev_attrib.pi_prot_type || cmd->se_sess->sess_prot_type)) {
461 buf[4] |= (0x3 << 3);
464 /* Set HEADSUP, ORDSUP, SIMPSUP */
467 /* If WriteCache emulation is enabled, set V_SUP */
468 if (target_check_wce(dev))
470 /* If an LBA map is present set R_SUP */
471 spin_lock(&cmd->se_dev->t10_alua.lba_map_lock);
472 if (!list_empty(&dev->t10_alua.lba_map_list))
474 spin_unlock(&cmd->se_dev->t10_alua.lba_map_lock);
478 /* Block Limits VPD page */
479 static sense_reason_t
480 spc_emulate_evpd_b0(struct se_cmd *cmd, unsigned char *buf)
482 struct se_device *dev = cmd->se_dev;
484 int have_tp = 0, opt, min;
487 * Following spc3r22 section 6.5.3 Block Limits VPD page, when
488 * emulate_tpu=1 or emulate_tpws=1 we will be expect a
489 * different page length for Thin Provisioning.
491 if (dev->dev_attrib.emulate_tpu || dev->dev_attrib.emulate_tpws)
494 buf[0] = dev->transport->get_device_type(dev);
495 buf[3] = have_tp ? 0x3c : 0x10;
500 * Set MAXIMUM COMPARE AND WRITE LENGTH
502 if (dev->dev_attrib.emulate_caw)
506 * Set OPTIMAL TRANSFER LENGTH GRANULARITY
508 if (dev->transport->get_io_min && (min = dev->transport->get_io_min(dev)))
509 put_unaligned_be16(min / dev->dev_attrib.block_size, &buf[6]);
511 put_unaligned_be16(1, &buf[6]);
514 * Set MAXIMUM TRANSFER LENGTH
516 * XXX: Currently assumes single PAGE_SIZE per scatterlist for fabrics
517 * enforcing maximum HW scatter-gather-list entry limit
519 if (cmd->se_tfo->max_data_sg_nents) {
520 mtl = (cmd->se_tfo->max_data_sg_nents * PAGE_SIZE) /
521 dev->dev_attrib.block_size;
523 put_unaligned_be32(min_not_zero(mtl, dev->dev_attrib.hw_max_sectors), &buf[8]);
526 * Set OPTIMAL TRANSFER LENGTH
528 if (dev->transport->get_io_opt && (opt = dev->transport->get_io_opt(dev)))
529 put_unaligned_be32(opt / dev->dev_attrib.block_size, &buf[12]);
531 put_unaligned_be32(dev->dev_attrib.optimal_sectors, &buf[12]);
534 * Exit now if we don't support TP.
540 * Set MAXIMUM UNMAP LBA COUNT
542 put_unaligned_be32(dev->dev_attrib.max_unmap_lba_count, &buf[20]);
545 * Set MAXIMUM UNMAP BLOCK DESCRIPTOR COUNT
547 put_unaligned_be32(dev->dev_attrib.max_unmap_block_desc_count,
551 * Set OPTIMAL UNMAP GRANULARITY
553 put_unaligned_be32(dev->dev_attrib.unmap_granularity, &buf[28]);
556 * UNMAP GRANULARITY ALIGNMENT
558 put_unaligned_be32(dev->dev_attrib.unmap_granularity_alignment,
560 if (dev->dev_attrib.unmap_granularity_alignment != 0)
561 buf[32] |= 0x80; /* Set the UGAVALID bit */
564 * MAXIMUM WRITE SAME LENGTH
567 put_unaligned_be64(dev->dev_attrib.max_write_same_len, &buf[36]);
572 /* Block Device Characteristics VPD page */
573 static sense_reason_t
574 spc_emulate_evpd_b1(struct se_cmd *cmd, unsigned char *buf)
576 struct se_device *dev = cmd->se_dev;
578 buf[0] = dev->transport->get_device_type(dev);
580 buf[5] = dev->dev_attrib.is_nonrot ? 1 : 0;
585 /* Thin Provisioning VPD */
586 static sense_reason_t
587 spc_emulate_evpd_b2(struct se_cmd *cmd, unsigned char *buf)
589 struct se_device *dev = cmd->se_dev;
592 * From spc3r22 section 6.5.4 Thin Provisioning VPD page:
594 * The PAGE LENGTH field is defined in SPC-4. If the DP bit is set to
595 * zero, then the page length shall be set to 0004h. If the DP bit
596 * is set to one, then the page length shall be set to the value
597 * defined in table 162.
599 buf[0] = dev->transport->get_device_type(dev);
602 * Set Hardcoded length mentioned above for DP=0
604 put_unaligned_be16(0x0004, &buf[2]);
607 * The THRESHOLD EXPONENT field indicates the threshold set size in
608 * LBAs as a power of 2 (i.e., the threshold set size is equal to
609 * 2(threshold exponent)).
611 * Note that this is currently set to 0x00 as mkp says it will be
612 * changing again. We can enable this once it has settled in T10
613 * and is actually used by Linux/SCSI ML code.
618 * A TPU bit set to one indicates that the device server supports
619 * the UNMAP command (see 5.25). A TPU bit set to zero indicates
620 * that the device server does not support the UNMAP command.
622 if (dev->dev_attrib.emulate_tpu != 0)
626 * A TPWS bit set to one indicates that the device server supports
627 * the use of the WRITE SAME (16) command (see 5.42) to unmap LBAs.
628 * A TPWS bit set to zero indicates that the device server does not
629 * support the use of the WRITE SAME (16) command to unmap LBAs.
631 if (dev->dev_attrib.emulate_tpws != 0)
632 buf[5] |= 0x40 | 0x20;
635 * The unmap_zeroes_data set means that the underlying device supports
636 * REQ_OP_DISCARD and has the discard_zeroes_data bit set. This
637 * satisfies the SBC requirements for LBPRZ, meaning that a subsequent
638 * read will return zeroes after an UNMAP or WRITE SAME (16) to an LBA
641 if (((dev->dev_attrib.emulate_tpu != 0) ||
642 (dev->dev_attrib.emulate_tpws != 0)) &&
643 (dev->dev_attrib.unmap_zeroes_data != 0))
649 /* Referrals VPD page */
650 static sense_reason_t
651 spc_emulate_evpd_b3(struct se_cmd *cmd, unsigned char *buf)
653 struct se_device *dev = cmd->se_dev;
655 buf[0] = dev->transport->get_device_type(dev);
657 put_unaligned_be32(dev->t10_alua.lba_map_segment_size, &buf[8]);
658 put_unaligned_be32(dev->t10_alua.lba_map_segment_multiplier, &buf[12]);
663 static sense_reason_t
664 spc_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf);
668 sense_reason_t (*emulate)(struct se_cmd *, unsigned char *);
669 } evpd_handlers[] = {
670 { .page = 0x00, .emulate = spc_emulate_evpd_00 },
671 { .page = 0x80, .emulate = spc_emulate_evpd_80 },
672 { .page = 0x83, .emulate = spc_emulate_evpd_83 },
673 { .page = 0x86, .emulate = spc_emulate_evpd_86 },
674 { .page = 0xb0, .emulate = spc_emulate_evpd_b0 },
675 { .page = 0xb1, .emulate = spc_emulate_evpd_b1 },
676 { .page = 0xb2, .emulate = spc_emulate_evpd_b2 },
677 { .page = 0xb3, .emulate = spc_emulate_evpd_b3 },
680 /* supported vital product data pages */
681 static sense_reason_t
682 spc_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf)
687 * Only report the INQUIRY EVPD=1 pages after a valid NAA
688 * Registered Extended LUN WWN has been set via ConfigFS
689 * during device creation/restart.
691 if (cmd->se_dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL) {
692 buf[3] = ARRAY_SIZE(evpd_handlers);
693 for (p = 0; p < ARRAY_SIZE(evpd_handlers); ++p)
694 buf[p + 4] = evpd_handlers[p].page;
700 static sense_reason_t
701 spc_emulate_inquiry(struct se_cmd *cmd)
703 struct se_device *dev = cmd->se_dev;
705 unsigned char *cdb = cmd->t_task_cdb;
711 buf = kzalloc(SE_INQUIRY_BUF, GFP_KERNEL);
713 pr_err("Unable to allocate response buffer for INQUIRY\n");
714 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
717 buf[0] = dev->transport->get_device_type(dev);
719 if (!(cdb[1] & 0x1)) {
721 pr_err("INQUIRY with EVPD==0 but PAGE CODE=%02x\n",
723 ret = TCM_INVALID_CDB_FIELD;
727 ret = spc_emulate_inquiry_std(cmd, buf);
732 for (p = 0; p < ARRAY_SIZE(evpd_handlers); ++p) {
733 if (cdb[2] == evpd_handlers[p].page) {
735 ret = evpd_handlers[p].emulate(cmd, buf);
736 len = get_unaligned_be16(&buf[2]) + 4;
741 pr_err("Unknown VPD Code: 0x%02x\n", cdb[2]);
742 ret = TCM_INVALID_CDB_FIELD;
745 rbuf = transport_kmap_data_sg(cmd);
747 memcpy(rbuf, buf, min_t(u32, SE_INQUIRY_BUF, cmd->data_length));
748 transport_kunmap_data_sg(cmd);
753 target_complete_cmd_with_length(cmd, GOOD, len);
757 static int spc_modesense_rwrecovery(struct se_cmd *cmd, u8 pc, u8 *p)
762 /* No changeable values for now */
770 static int spc_modesense_control(struct se_cmd *cmd, u8 pc, u8 *p)
772 struct se_device *dev = cmd->se_dev;
773 struct se_session *sess = cmd->se_sess;
778 /* No changeable values for now */
782 /* GLTSD: No implicit save of log parameters */
784 if (target_sense_desc_format(dev))
785 /* D_SENSE: Descriptor format sense data for 64bit sectors */
789 * From spc4r23, 7.4.7 Control mode page
791 * The QUEUE ALGORITHM MODIFIER field (see table 368) specifies
792 * restrictions on the algorithm used for reordering commands
793 * having the SIMPLE task attribute (see SAM-4).
795 * Table 368 -- QUEUE ALGORITHM MODIFIER field
797 * 0h Restricted reordering
798 * 1h Unrestricted reordering allowed
800 * 8h to Fh Vendor specific
802 * A value of zero in the QUEUE ALGORITHM MODIFIER field specifies that
803 * the device server shall order the processing sequence of commands
804 * having the SIMPLE task attribute such that data integrity is maintained
805 * for that I_T nexus (i.e., if the transmission of new SCSI transport protocol
806 * requests is halted at any time, the final value of all data observable
807 * on the medium shall be the same as if all the commands had been processed
808 * with the ORDERED task attribute).
810 * A value of one in the QUEUE ALGORITHM MODIFIER field specifies that the
811 * device server may reorder the processing sequence of commands having the
812 * SIMPLE task attribute in any manner. Any data integrity exposures related to
813 * command sequence order shall be explicitly handled by the application client
814 * through the selection of appropriate ommands and task attributes.
816 p[3] = (dev->dev_attrib.emulate_rest_reord == 1) ? 0x00 : 0x10;
818 * From spc4r17, section 7.4.6 Control mode Page
820 * Unit Attention interlocks control (UN_INTLCK_CTRL) to code 00b
822 * 00b: The logical unit shall clear any unit attention condition
823 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
824 * status and shall not establish a unit attention condition when a com-
825 * mand is completed with BUSY, TASK SET FULL, or RESERVATION CONFLICT
828 * 10b: The logical unit shall not clear any unit attention condition
829 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
830 * status and shall not establish a unit attention condition when
831 * a command is completed with BUSY, TASK SET FULL, or RESERVATION
834 * 11b a The logical unit shall not clear any unit attention condition
835 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
836 * status and shall establish a unit attention condition for the
837 * initiator port associated with the I_T nexus on which the BUSY,
838 * TASK SET FULL, or RESERVATION CONFLICT status is being returned.
839 * Depending on the status, the additional sense code shall be set to
840 * PREVIOUS BUSY STATUS, PREVIOUS TASK SET FULL STATUS, or PREVIOUS
841 * RESERVATION CONFLICT STATUS. Until it is cleared by a REQUEST SENSE
842 * command, a unit attention condition shall be established only once
843 * for a BUSY, TASK SET FULL, or RESERVATION CONFLICT status regardless
844 * to the number of commands completed with one of those status codes.
846 switch (dev->dev_attrib.emulate_ua_intlck_ctrl) {
847 case TARGET_UA_INTLCK_CTRL_ESTABLISH_UA:
850 case TARGET_UA_INTLCK_CTRL_NO_CLEAR:
853 default: /* TARGET_UA_INTLCK_CTRL_CLEAR */
858 * From spc4r17, section 7.4.6 Control mode Page
860 * Task Aborted Status (TAS) bit set to zero.
862 * A task aborted status (TAS) bit set to zero specifies that aborted
863 * tasks shall be terminated by the device server without any response
864 * to the application client. A TAS bit set to one specifies that tasks
865 * aborted by the actions of an I_T nexus other than the I_T nexus on
866 * which the command was received shall be completed with TASK ABORTED
867 * status (see SAM-4).
869 p[5] = (dev->dev_attrib.emulate_tas) ? 0x40 : 0x00;
871 * From spc4r30, section 7.5.7 Control mode page
873 * Application Tag Owner (ATO) bit set to one.
875 * If the ATO bit is set to one the device server shall not modify the
876 * LOGICAL BLOCK APPLICATION TAG field and, depending on the protection
877 * type, shall not modify the contents of the LOGICAL BLOCK REFERENCE
880 if (sess->sup_prot_ops & (TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS)) {
881 if (dev->dev_attrib.pi_prot_type || sess->sess_prot_type)
893 static int spc_modesense_caching(struct se_cmd *cmd, u8 pc, u8 *p)
895 struct se_device *dev = cmd->se_dev;
900 /* No changeable values for now */
904 if (target_check_wce(dev))
905 p[2] = 0x04; /* Write Cache Enable */
906 p[12] = 0x20; /* Disabled Read Ahead */
912 static int spc_modesense_informational_exceptions(struct se_cmd *cmd, u8 pc, unsigned char *p)
917 /* No changeable values for now */
928 int (*emulate)(struct se_cmd *, u8, unsigned char *);
929 } modesense_handlers[] = {
930 { .page = 0x01, .subpage = 0x00, .emulate = spc_modesense_rwrecovery },
931 { .page = 0x08, .subpage = 0x00, .emulate = spc_modesense_caching },
932 { .page = 0x0a, .subpage = 0x00, .emulate = spc_modesense_control },
933 { .page = 0x1c, .subpage = 0x00, .emulate = spc_modesense_informational_exceptions },
936 static void spc_modesense_write_protect(unsigned char *buf, int type)
939 * I believe that the WP bit (bit 7) in the mode header is the same for
946 buf[0] |= 0x80; /* WP bit */
951 static void spc_modesense_dpofua(unsigned char *buf, int type)
955 buf[0] |= 0x10; /* DPOFUA bit */
962 static int spc_modesense_blockdesc(unsigned char *buf, u64 blocks, u32 block_size)
965 put_unaligned_be32(min(blocks, 0xffffffffull), buf);
967 put_unaligned_be32(block_size, buf);
971 static int spc_modesense_long_blockdesc(unsigned char *buf, u64 blocks, u32 block_size)
973 if (blocks <= 0xffffffff)
974 return spc_modesense_blockdesc(buf + 3, blocks, block_size) + 3;
976 *buf++ = 1; /* LONGLBA */
979 put_unaligned_be64(blocks, buf);
981 put_unaligned_be32(block_size, buf);
986 static sense_reason_t spc_emulate_modesense(struct se_cmd *cmd)
988 struct se_device *dev = cmd->se_dev;
989 char *cdb = cmd->t_task_cdb;
990 unsigned char buf[SE_MODE_PAGE_BUF], *rbuf;
991 int type = dev->transport->get_device_type(dev);
992 int ten = (cmd->t_task_cdb[0] == MODE_SENSE_10);
993 bool dbd = !!(cdb[1] & 0x08);
994 bool llba = ten ? !!(cdb[1] & 0x10) : false;
996 u8 page = cdb[2] & 0x3f;
1002 memset(buf, 0, SE_MODE_PAGE_BUF);
1005 * Skip over MODE DATA LENGTH + MEDIUM TYPE fields to byte 3 for
1006 * MODE_SENSE_10 and byte 2 for MODE_SENSE (6).
1008 length = ten ? 3 : 2;
1010 /* DEVICE-SPECIFIC PARAMETER */
1011 if (cmd->se_lun->lun_access_ro || target_lun_is_rdonly(cmd))
1012 spc_modesense_write_protect(&buf[length], type);
1015 * SBC only allows us to enable FUA and DPO together. Fortunately
1016 * DPO is explicitly specified as a hint, so a noop is a perfectly
1017 * valid implementation.
1019 if (target_check_fua(dev))
1020 spc_modesense_dpofua(&buf[length], type);
1024 /* BLOCK DESCRIPTOR */
1027 * For now we only include a block descriptor for disk (SBC)
1028 * devices; other command sets use a slightly different format.
1030 if (!dbd && type == TYPE_DISK) {
1031 u64 blocks = dev->transport->get_blocks(dev);
1032 u32 block_size = dev->dev_attrib.block_size;
1036 length += spc_modesense_long_blockdesc(&buf[length],
1037 blocks, block_size);
1040 length += spc_modesense_blockdesc(&buf[length],
1041 blocks, block_size);
1044 length += spc_modesense_blockdesc(&buf[length], blocks,
1055 if (subpage != 0x00 && subpage != 0xff) {
1056 pr_warn("MODE_SENSE: Invalid subpage code: 0x%02x\n", subpage);
1057 return TCM_INVALID_CDB_FIELD;
1060 for (i = 0; i < ARRAY_SIZE(modesense_handlers); ++i) {
1062 * Tricky way to say all subpage 00h for
1063 * subpage==0, all subpages for subpage==0xff
1064 * (and we just checked above that those are
1065 * the only two possibilities).
1067 if ((modesense_handlers[i].subpage & ~subpage) == 0) {
1068 ret = modesense_handlers[i].emulate(cmd, pc, &buf[length]);
1069 if (!ten && length + ret >= 255)
1078 for (i = 0; i < ARRAY_SIZE(modesense_handlers); ++i)
1079 if (modesense_handlers[i].page == page &&
1080 modesense_handlers[i].subpage == subpage) {
1081 length += modesense_handlers[i].emulate(cmd, pc, &buf[length]);
1086 * We don't intend to implement:
1087 * - obsolete page 03h "format parameters" (checked by Solaris)
1090 pr_err("MODE SENSE: unimplemented page/subpage: 0x%02x/0x%02x\n",
1093 return TCM_UNKNOWN_MODE_PAGE;
1097 put_unaligned_be16(length - 2, buf);
1099 buf[0] = length - 1;
1101 rbuf = transport_kmap_data_sg(cmd);
1103 memcpy(rbuf, buf, min_t(u32, SE_MODE_PAGE_BUF, cmd->data_length));
1104 transport_kunmap_data_sg(cmd);
1107 target_complete_cmd_with_length(cmd, GOOD, length);
1111 static sense_reason_t spc_emulate_modeselect(struct se_cmd *cmd)
1113 char *cdb = cmd->t_task_cdb;
1114 bool ten = cdb[0] == MODE_SELECT_10;
1115 int off = ten ? 8 : 4;
1116 bool pf = !!(cdb[1] & 0x10);
1119 unsigned char tbuf[SE_MODE_PAGE_BUF];
1121 sense_reason_t ret = 0;
1124 if (!cmd->data_length) {
1125 target_complete_cmd(cmd, GOOD);
1129 if (cmd->data_length < off + 2)
1130 return TCM_PARAMETER_LIST_LENGTH_ERROR;
1132 buf = transport_kmap_data_sg(cmd);
1134 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1137 ret = TCM_INVALID_CDB_FIELD;
1141 page = buf[off] & 0x3f;
1142 subpage = buf[off] & 0x40 ? buf[off + 1] : 0;
1144 for (i = 0; i < ARRAY_SIZE(modesense_handlers); ++i)
1145 if (modesense_handlers[i].page == page &&
1146 modesense_handlers[i].subpage == subpage) {
1147 memset(tbuf, 0, SE_MODE_PAGE_BUF);
1148 length = modesense_handlers[i].emulate(cmd, 0, tbuf);
1149 goto check_contents;
1152 ret = TCM_UNKNOWN_MODE_PAGE;
1156 if (cmd->data_length < off + length) {
1157 ret = TCM_PARAMETER_LIST_LENGTH_ERROR;
1161 if (memcmp(buf + off, tbuf, length))
1162 ret = TCM_INVALID_PARAMETER_LIST;
1165 transport_kunmap_data_sg(cmd);
1168 target_complete_cmd(cmd, GOOD);
1172 static sense_reason_t spc_emulate_request_sense(struct se_cmd *cmd)
1174 unsigned char *cdb = cmd->t_task_cdb;
1175 unsigned char *rbuf;
1176 u8 ua_asc = 0, ua_ascq = 0;
1177 unsigned char buf[SE_SENSE_BUF];
1178 bool desc_format = target_sense_desc_format(cmd->se_dev);
1180 memset(buf, 0, SE_SENSE_BUF);
1182 if (cdb[1] & 0x01) {
1183 pr_err("REQUEST_SENSE description emulation not"
1185 return TCM_INVALID_CDB_FIELD;
1188 rbuf = transport_kmap_data_sg(cmd);
1190 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1192 if (!core_scsi3_ua_clear_for_request_sense(cmd, &ua_asc, &ua_ascq))
1193 scsi_build_sense_buffer(desc_format, buf, UNIT_ATTENTION,
1196 scsi_build_sense_buffer(desc_format, buf, NO_SENSE, 0x0, 0x0);
1198 memcpy(rbuf, buf, min_t(u32, sizeof(buf), cmd->data_length));
1199 transport_kunmap_data_sg(cmd);
1201 target_complete_cmd(cmd, GOOD);
1205 sense_reason_t spc_emulate_report_luns(struct se_cmd *cmd)
1207 struct se_dev_entry *deve;
1208 struct se_session *sess = cmd->se_sess;
1209 struct se_node_acl *nacl;
1210 struct scsi_lun slun;
1212 u32 lun_count = 0, offset = 8;
1215 buf = transport_kmap_data_sg(cmd);
1216 if (cmd->data_length && !buf)
1217 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1220 * If no struct se_session pointer is present, this struct se_cmd is
1221 * coming via a target_core_mod PASSTHROUGH op, and not through
1222 * a $FABRIC_MOD. In that case, report LUN=0 only.
1227 nacl = sess->se_node_acl;
1230 hlist_for_each_entry_rcu(deve, &nacl->lun_entry_hlist, link) {
1232 * We determine the correct LUN LIST LENGTH even once we
1233 * have reached the initial allocation length.
1234 * See SPC2-R20 7.19.
1237 if (offset >= cmd->data_length)
1240 int_to_scsilun(deve->mapped_lun, &slun);
1241 memcpy(buf + offset, &slun,
1242 min(8u, cmd->data_length - offset));
1248 * See SPC3 r07, page 159.
1252 * If no LUNs are accessible, report virtual LUN 0.
1254 if (lun_count == 0) {
1255 int_to_scsilun(0, &slun);
1256 if (cmd->data_length > 8)
1257 memcpy(buf + offset, &slun,
1258 min(8u, cmd->data_length - offset));
1263 len = cpu_to_be32(lun_count * 8);
1264 memcpy(buf, &len, min_t(int, sizeof len, cmd->data_length));
1265 transport_kunmap_data_sg(cmd);
1268 target_complete_cmd_with_length(cmd, GOOD, 8 + lun_count * 8);
1271 EXPORT_SYMBOL(spc_emulate_report_luns);
1273 static sense_reason_t
1274 spc_emulate_testunitready(struct se_cmd *cmd)
1276 target_complete_cmd(cmd, GOOD);
1281 spc_parse_cdb(struct se_cmd *cmd, unsigned int *size)
1283 struct se_device *dev = cmd->se_dev;
1284 unsigned char *cdb = cmd->t_task_cdb;
1286 if (!dev->dev_attrib.emulate_pr &&
1287 ((cdb[0] == PERSISTENT_RESERVE_IN) ||
1288 (cdb[0] == PERSISTENT_RESERVE_OUT) ||
1289 (cdb[0] == RELEASE || cdb[0] == RELEASE_10) ||
1290 (cdb[0] == RESERVE || cdb[0] == RESERVE_10))) {
1291 return TCM_UNSUPPORTED_SCSI_OPCODE;
1297 cmd->execute_cmd = spc_emulate_modeselect;
1299 case MODE_SELECT_10:
1300 *size = get_unaligned_be16(&cdb[7]);
1301 cmd->execute_cmd = spc_emulate_modeselect;
1305 cmd->execute_cmd = spc_emulate_modesense;
1308 *size = get_unaligned_be16(&cdb[7]);
1309 cmd->execute_cmd = spc_emulate_modesense;
1313 *size = get_unaligned_be16(&cdb[7]);
1315 case PERSISTENT_RESERVE_IN:
1316 *size = get_unaligned_be16(&cdb[7]);
1317 cmd->execute_cmd = target_scsi3_emulate_pr_in;
1319 case PERSISTENT_RESERVE_OUT:
1320 *size = get_unaligned_be32(&cdb[5]);
1321 cmd->execute_cmd = target_scsi3_emulate_pr_out;
1325 if (cdb[0] == RELEASE_10)
1326 *size = get_unaligned_be16(&cdb[7]);
1328 *size = cmd->data_length;
1330 cmd->execute_cmd = target_scsi2_reservation_release;
1335 * The SPC-2 RESERVE does not contain a size in the SCSI CDB.
1336 * Assume the passthrough or $FABRIC_MOD will tell us about it.
1338 if (cdb[0] == RESERVE_10)
1339 *size = get_unaligned_be16(&cdb[7]);
1341 *size = cmd->data_length;
1343 cmd->execute_cmd = target_scsi2_reservation_reserve;
1347 cmd->execute_cmd = spc_emulate_request_sense;
1350 *size = get_unaligned_be16(&cdb[3]);
1353 * Do implicit HEAD_OF_QUEUE processing for INQUIRY.
1354 * See spc4r17 section 5.3
1356 cmd->sam_task_attr = TCM_HEAD_TAG;
1357 cmd->execute_cmd = spc_emulate_inquiry;
1359 case SECURITY_PROTOCOL_IN:
1360 case SECURITY_PROTOCOL_OUT:
1361 *size = get_unaligned_be32(&cdb[6]);
1364 *size = get_unaligned_be32(&cdb[10]);
1365 cmd->execute_cmd = target_do_xcopy;
1367 case RECEIVE_COPY_RESULTS:
1368 *size = get_unaligned_be32(&cdb[10]);
1369 cmd->execute_cmd = target_do_receive_copy_results;
1371 case READ_ATTRIBUTE:
1372 case WRITE_ATTRIBUTE:
1373 *size = get_unaligned_be32(&cdb[10]);
1375 case RECEIVE_DIAGNOSTIC:
1376 case SEND_DIAGNOSTIC:
1377 *size = get_unaligned_be16(&cdb[3]);
1380 *size = get_unaligned_be24(&cdb[6]);
1383 cmd->execute_cmd = spc_emulate_report_luns;
1384 *size = get_unaligned_be32(&cdb[6]);
1386 * Do implicit HEAD_OF_QUEUE processing for REPORT_LUNS
1387 * See spc4r17 section 5.3
1389 cmd->sam_task_attr = TCM_HEAD_TAG;
1391 case TEST_UNIT_READY:
1392 cmd->execute_cmd = spc_emulate_testunitready;
1395 case MAINTENANCE_IN:
1396 if (dev->transport->get_device_type(dev) != TYPE_ROM) {
1398 * MAINTENANCE_IN from SCC-2
1399 * Check for emulated MI_REPORT_TARGET_PGS
1401 if ((cdb[1] & 0x1f) == MI_REPORT_TARGET_PGS) {
1403 target_emulate_report_target_port_groups;
1405 *size = get_unaligned_be32(&cdb[6]);
1408 * GPCMD_SEND_KEY from multi media commands
1410 *size = get_unaligned_be16(&cdb[8]);
1413 case MAINTENANCE_OUT:
1414 if (dev->transport->get_device_type(dev) != TYPE_ROM) {
1416 * MAINTENANCE_OUT from SCC-2
1417 * Check for emulated MO_SET_TARGET_PGS.
1419 if (cdb[1] == MO_SET_TARGET_PGS) {
1421 target_emulate_set_target_port_groups;
1423 *size = get_unaligned_be32(&cdb[6]);
1426 * GPCMD_SEND_KEY from multi media commands
1428 *size = get_unaligned_be16(&cdb[8]);
1432 return TCM_UNSUPPORTED_SCSI_OPCODE;
1437 EXPORT_SYMBOL(spc_parse_cdb);