2 * CDB emulation for non-READ/WRITE commands.
4 * Copyright (c) 2002, 2003, 2004, 2005 PyX Technologies, Inc.
5 * Copyright (c) 2005, 2006, 2007 SBE, Inc.
6 * Copyright (c) 2007-2010 Rising Tide Systems
7 * Copyright (c) 2008-2010 Linux-iSCSI.org
9 * Nicholas A. Bellinger <nab@kernel.org>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
26 #include <linux/kernel.h>
27 #include <linux/module.h>
28 #include <asm/unaligned.h>
29 #include <scsi/scsi.h>
31 #include <target/target_core_base.h>
32 #include <target/target_core_transport.h>
33 #include <target/target_core_fabric_ops.h>
34 #include "target_core_ua.h"
35 #include "target_core_cdb.h"
38 target_fill_alua_data(struct se_port *port, unsigned char *buf)
40 struct t10_alua_tg_pt_gp *tg_pt_gp;
41 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
44 * Set SCCS for MAINTENANCE_IN + REPORT_TARGET_PORT_GROUPS.
49 * Set TPGS field for explict and/or implict ALUA access type
52 * See spc4r17 section 6.4.2 Table 135
56 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
60 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
61 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
63 buf[5] |= tg_pt_gp->tg_pt_gp_alua_access_type;
64 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
68 target_emulate_inquiry_std(struct se_cmd *cmd)
70 struct se_lun *lun = cmd->se_lun;
71 struct se_device *dev = cmd->se_dev;
72 struct se_portal_group *tpg = lun->lun_sep->sep_tpg;
76 * Make sure we at least have 6 bytes of INQUIRY response
77 * payload going back for EVPD=0
79 if (cmd->data_length < 6) {
80 pr_err("SCSI Inquiry payload length: %u"
81 " too small for EVPD=0\n", cmd->data_length);
85 buf = transport_kmap_data_sg(cmd);
87 if (dev == tpg->tpg_virt_lun0.lun_se_dev) {
88 buf[0] = 0x3f; /* Not connected */
90 buf[0] = dev->transport->get_device_type(dev);
91 if (buf[0] == TYPE_TAPE)
94 buf[2] = dev->transport->get_device_rev(dev);
97 * NORMACA and HISUP = 0, RESPONSE DATA FORMAT = 2
100 * A RESPONSE DATA FORMAT field set to 2h indicates that the
101 * standard INQUIRY data is in the format defined in this
102 * standard. Response data format values less than 2h are
103 * obsolete. Response data format values greater than 2h are
109 * Enable SCCS and TPGS fields for Emulated ALUA
111 if (dev->se_sub_dev->t10_alua.alua_type == SPC3_ALUA_EMULATED)
112 target_fill_alua_data(lun->lun_sep, buf);
114 if (cmd->data_length < 8) {
115 buf[4] = 1; /* Set additional length to 1 */
119 buf[7] = 0x2; /* CmdQue=1 */
122 * Do not include vendor, product, reversion info in INQUIRY
123 * response payload for cdbs with a small allocation length.
125 if (cmd->data_length < 36) {
126 buf[4] = 3; /* Set additional length to 3 */
130 memcpy(&buf[8], "LIO-ORG ", 8);
131 memset(&buf[16], 0x20, 16);
132 memcpy(&buf[16], dev->se_sub_dev->t10_wwn.model,
133 min_t(size_t, strlen(dev->se_sub_dev->t10_wwn.model), 16));
134 memcpy(&buf[32], dev->se_sub_dev->t10_wwn.revision,
135 min_t(size_t, strlen(dev->se_sub_dev->t10_wwn.revision), 4));
136 buf[4] = 31; /* Set additional length to 31 */
139 transport_kunmap_data_sg(cmd);
143 /* unit serial number */
145 target_emulate_evpd_80(struct se_cmd *cmd, unsigned char *buf)
147 struct se_device *dev = cmd->se_dev;
150 if (dev->se_sub_dev->su_dev_flags &
151 SDF_EMULATED_VPD_UNIT_SERIAL) {
155 strlen(&dev->se_sub_dev->t10_wwn.unit_serial[0]);
156 unit_serial_len++; /* For NULL Terminator */
158 if (((len + 4) + unit_serial_len) > cmd->data_length) {
159 len += unit_serial_len;
160 buf[2] = ((len >> 8) & 0xff);
161 buf[3] = (len & 0xff);
164 len += sprintf((unsigned char *)&buf[4], "%s",
165 &dev->se_sub_dev->t10_wwn.unit_serial[0]);
166 len++; /* Extra Byte for NULL Terminator */
173 target_parse_naa_6h_vendor_specific(struct se_device *dev, unsigned char *buf)
175 unsigned char *p = &dev->se_sub_dev->t10_wwn.unit_serial[0];
180 * Generate up to 36 bits of VENDOR SPECIFIC IDENTIFIER starting on
181 * byte 3 bit 3-0 for NAA IEEE Registered Extended DESIGNATOR field
182 * format, followed by 64 bits of VENDOR SPECIFIC IDENTIFIER EXTENSION
183 * to complete the payload. These are based from VPD=0x80 PRODUCT SERIAL
184 * NUMBER set via vpd_unit_serial in target_core_configfs.c to ensure
185 * per device uniqeness.
187 for (cnt = 0; *p && cnt < 13; p++) {
188 int val = hex_to_bin(*p);
204 * Device identification VPD, for a complete list of
205 * DESIGNATOR TYPEs see spc4r17 Table 459.
208 target_emulate_evpd_83(struct se_cmd *cmd, unsigned char *buf)
210 struct se_device *dev = cmd->se_dev;
211 struct se_lun *lun = cmd->se_lun;
212 struct se_port *port = NULL;
213 struct se_portal_group *tpg = NULL;
214 struct t10_alua_lu_gp_member *lu_gp_mem;
215 struct t10_alua_tg_pt_gp *tg_pt_gp;
216 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
217 unsigned char *prod = &dev->se_sub_dev->t10_wwn.model[0];
219 u32 unit_serial_len, off = 0;
225 * NAA IEEE Registered Extended Assigned designator format, see
226 * spc4r17 section 7.7.3.6.5
228 * We depend upon a target_core_mod/ConfigFS provided
229 * /sys/kernel/config/target/core/$HBA/$DEV/wwn/vpd_unit_serial
230 * value in order to return the NAA id.
232 if (!(dev->se_sub_dev->su_dev_flags & SDF_EMULATED_VPD_UNIT_SERIAL))
233 goto check_t10_vend_desc;
235 if (off + 20 > cmd->data_length)
236 goto check_t10_vend_desc;
238 /* CODE SET == Binary */
241 /* Set ASSOCIATION == addressed logical unit: 0)b */
244 /* Identifier/Designator type == NAA identifier */
248 /* Identifier/Designator length */
252 * Start NAA IEEE Registered Extended Identifier/Designator
254 buf[off++] = (0x6 << 4);
257 * Use OpenFabrics IEEE Company ID: 00 14 05
261 buf[off] = (0x5 << 4);
264 * Return ConfigFS Unit Serial Number information for
265 * VENDOR_SPECIFIC_IDENTIFIER and
266 * VENDOR_SPECIFIC_IDENTIFIER_EXTENTION
268 target_parse_naa_6h_vendor_specific(dev, &buf[off]);
275 * T10 Vendor Identifier Page, see spc4r17 section 7.7.3.4
277 id_len = 8; /* For Vendor field */
278 prod_len = 4; /* For VPD Header */
279 prod_len += 8; /* For Vendor field */
280 prod_len += strlen(prod);
281 prod_len++; /* For : */
283 if (dev->se_sub_dev->su_dev_flags &
284 SDF_EMULATED_VPD_UNIT_SERIAL) {
286 strlen(&dev->se_sub_dev->t10_wwn.unit_serial[0]);
287 unit_serial_len++; /* For NULL Terminator */
289 if ((len + (id_len + 4) +
290 (prod_len + unit_serial_len)) >
292 len += (prod_len + unit_serial_len);
295 id_len += sprintf((unsigned char *)&buf[off+12],
297 &dev->se_sub_dev->t10_wwn.unit_serial[0]);
299 buf[off] = 0x2; /* ASCII */
300 buf[off+1] = 0x1; /* T10 Vendor ID */
302 memcpy((unsigned char *)&buf[off+4], "LIO-ORG", 8);
303 /* Extra Byte for NULL Terminator */
305 /* Identifier Length */
307 /* Header size for Designation descriptor */
311 * struct se_port is only set for INQUIRY VPD=1 through $FABRIC_MOD
316 struct t10_alua_lu_gp *lu_gp;
317 u32 padding, scsi_name_len;
324 * Relative target port identifer, see spc4r17
327 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
328 * section 7.5.1 Table 362
330 if (((len + 4) + 8) > cmd->data_length) {
335 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
336 buf[off++] |= 0x1; /* CODE SET == Binary */
337 buf[off] = 0x80; /* Set PIV=1 */
338 /* Set ASSOCIATION == target port: 01b */
340 /* DESIGNATOR TYPE == Relative target port identifer */
342 off++; /* Skip over Reserved */
343 buf[off++] = 4; /* DESIGNATOR LENGTH */
344 /* Skip over Obsolete field in RTPI payload
347 buf[off++] = ((port->sep_rtpi >> 8) & 0xff);
348 buf[off++] = (port->sep_rtpi & 0xff);
349 len += 8; /* Header size + Designation descriptor */
351 * Target port group identifier, see spc4r17
354 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
355 * section 7.5.1 Table 362
358 if (dev->se_sub_dev->t10_alua.alua_type !=
360 goto check_scsi_name;
362 if (((len + 4) + 8) > cmd->data_length) {
366 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
370 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
371 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
373 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
376 tg_pt_gp_id = tg_pt_gp->tg_pt_gp_id;
377 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
380 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
381 buf[off++] |= 0x1; /* CODE SET == Binary */
382 buf[off] = 0x80; /* Set PIV=1 */
383 /* Set ASSOCIATION == target port: 01b */
385 /* DESIGNATOR TYPE == Target port group identifier */
387 off++; /* Skip over Reserved */
388 buf[off++] = 4; /* DESIGNATOR LENGTH */
389 off += 2; /* Skip over Reserved Field */
390 buf[off++] = ((tg_pt_gp_id >> 8) & 0xff);
391 buf[off++] = (tg_pt_gp_id & 0xff);
392 len += 8; /* Header size + Designation descriptor */
394 * Logical Unit Group identifier, see spc4r17
398 if (((len + 4) + 8) > cmd->data_length) {
400 goto check_scsi_name;
402 lu_gp_mem = dev->dev_alua_lu_gp_mem;
404 goto check_scsi_name;
406 spin_lock(&lu_gp_mem->lu_gp_mem_lock);
407 lu_gp = lu_gp_mem->lu_gp;
409 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
410 goto check_scsi_name;
412 lu_gp_id = lu_gp->lu_gp_id;
413 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
415 buf[off++] |= 0x1; /* CODE SET == Binary */
416 /* DESIGNATOR TYPE == Logical Unit Group identifier */
418 off++; /* Skip over Reserved */
419 buf[off++] = 4; /* DESIGNATOR LENGTH */
420 off += 2; /* Skip over Reserved Field */
421 buf[off++] = ((lu_gp_id >> 8) & 0xff);
422 buf[off++] = (lu_gp_id & 0xff);
423 len += 8; /* Header size + Designation descriptor */
425 * SCSI name string designator, see spc4r17
428 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
429 * section 7.5.1 Table 362
432 scsi_name_len = strlen(tpg->se_tpg_tfo->tpg_get_wwn(tpg));
433 /* UTF-8 ",t,0x<16-bit TPGT>" + NULL Terminator */
435 /* Check for 4-byte padding */
436 padding = ((-scsi_name_len) & 3);
438 scsi_name_len += padding;
439 /* Header size + Designation descriptor */
442 if (((len + 4) + scsi_name_len) > cmd->data_length) {
443 len += scsi_name_len;
447 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
448 buf[off++] |= 0x3; /* CODE SET == UTF-8 */
449 buf[off] = 0x80; /* Set PIV=1 */
450 /* Set ASSOCIATION == target port: 01b */
452 /* DESIGNATOR TYPE == SCSI name string */
454 off += 2; /* Skip over Reserved and length */
456 * SCSI name string identifer containing, $FABRIC_MOD
457 * dependent information. For LIO-Target and iSCSI
458 * Target Port, this means "<iSCSI name>,t,0x<TPGT> in
461 tpgt = tpg->se_tpg_tfo->tpg_get_tag(tpg);
462 scsi_name_len = sprintf(&buf[off], "%s,t,0x%04x",
463 tpg->se_tpg_tfo->tpg_get_wwn(tpg), tpgt);
464 scsi_name_len += 1 /* Include NULL terminator */;
466 * The null-terminated, null-padded (see 4.4.2) SCSI
467 * NAME STRING field contains a UTF-8 format string.
468 * The number of bytes in the SCSI NAME STRING field
469 * (i.e., the value in the DESIGNATOR LENGTH field)
470 * shall be no larger than 256 and shall be a multiple
474 scsi_name_len += padding;
476 buf[off-1] = scsi_name_len;
477 off += scsi_name_len;
478 /* Header size + Designation descriptor */
479 len += (scsi_name_len + 4);
482 buf[2] = ((len >> 8) & 0xff);
483 buf[3] = (len & 0xff); /* Page Length for VPD 0x83 */
487 /* Extended INQUIRY Data VPD Page */
489 target_emulate_evpd_86(struct se_cmd *cmd, unsigned char *buf)
491 if (cmd->data_length < 60)
495 /* Set HEADSUP, ORDSUP, SIMPSUP */
498 /* If WriteCache emulation is enabled, set V_SUP */
499 if (cmd->se_dev->se_sub_dev->se_dev_attrib.emulate_write_cache > 0)
504 /* Block Limits VPD page */
506 target_emulate_evpd_b0(struct se_cmd *cmd, unsigned char *buf)
508 struct se_device *dev = cmd->se_dev;
512 * Following sbc3r22 section 6.5.3 Block Limits VPD page, when
513 * emulate_tpu=1 or emulate_tpws=1 we will be expect a
514 * different page length for Thin Provisioning.
516 if (dev->se_sub_dev->se_dev_attrib.emulate_tpu || dev->se_sub_dev->se_dev_attrib.emulate_tpws)
519 if (cmd->data_length < (0x10 + 4)) {
520 pr_debug("Received data_length: %u"
521 " too small for EVPD 0xb0\n",
526 if (have_tp && cmd->data_length < (0x3c + 4)) {
527 pr_debug("Received data_length: %u"
528 " too small for TPE=1 EVPD 0xb0\n",
533 buf[0] = dev->transport->get_device_type(dev);
534 buf[3] = have_tp ? 0x3c : 0x10;
540 * Set OPTIMAL TRANSFER LENGTH GRANULARITY
542 put_unaligned_be16(1, &buf[6]);
545 * Set MAXIMUM TRANSFER LENGTH
547 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.max_sectors, &buf[8]);
550 * Set OPTIMAL TRANSFER LENGTH
552 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.optimal_sectors, &buf[12]);
555 * Exit now if we don't support TP or the initiator sent a too
558 if (!have_tp || cmd->data_length < (0x3c + 4))
562 * Set MAXIMUM UNMAP LBA COUNT
564 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.max_unmap_lba_count, &buf[20]);
567 * Set MAXIMUM UNMAP BLOCK DESCRIPTOR COUNT
569 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.max_unmap_block_desc_count,
573 * Set OPTIMAL UNMAP GRANULARITY
575 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.unmap_granularity, &buf[28]);
578 * UNMAP GRANULARITY ALIGNMENT
580 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.unmap_granularity_alignment,
582 if (dev->se_sub_dev->se_dev_attrib.unmap_granularity_alignment != 0)
583 buf[32] |= 0x80; /* Set the UGAVALID bit */
588 /* Block Device Characteristics VPD page */
590 target_emulate_evpd_b1(struct se_cmd *cmd, unsigned char *buf)
592 struct se_device *dev = cmd->se_dev;
594 buf[0] = dev->transport->get_device_type(dev);
597 if (cmd->data_length >= 5 &&
598 dev->se_sub_dev->se_dev_attrib.is_nonrot)
604 /* Thin Provisioning VPD */
606 target_emulate_evpd_b2(struct se_cmd *cmd, unsigned char *buf)
608 struct se_device *dev = cmd->se_dev;
611 * From sbc3r22 section 6.5.4 Thin Provisioning VPD page:
613 * The PAGE LENGTH field is defined in SPC-4. If the DP bit is set to
614 * zero, then the page length shall be set to 0004h. If the DP bit
615 * is set to one, then the page length shall be set to the value
616 * defined in table 162.
618 buf[0] = dev->transport->get_device_type(dev);
621 * Set Hardcoded length mentioned above for DP=0
623 put_unaligned_be16(0x0004, &buf[2]);
626 * The THRESHOLD EXPONENT field indicates the threshold set size in
627 * LBAs as a power of 2 (i.e., the threshold set size is equal to
628 * 2(threshold exponent)).
630 * Note that this is currently set to 0x00 as mkp says it will be
631 * changing again. We can enable this once it has settled in T10
632 * and is actually used by Linux/SCSI ML code.
637 * A TPU bit set to one indicates that the device server supports
638 * the UNMAP command (see 5.25). A TPU bit set to zero indicates
639 * that the device server does not support the UNMAP command.
641 if (dev->se_sub_dev->se_dev_attrib.emulate_tpu != 0)
645 * A TPWS bit set to one indicates that the device server supports
646 * the use of the WRITE SAME (16) command (see 5.42) to unmap LBAs.
647 * A TPWS bit set to zero indicates that the device server does not
648 * support the use of the WRITE SAME (16) command to unmap LBAs.
650 if (dev->se_sub_dev->se_dev_attrib.emulate_tpws != 0)
657 target_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf);
661 int (*emulate)(struct se_cmd *, unsigned char *);
662 } evpd_handlers[] = {
663 { .page = 0x00, .emulate = target_emulate_evpd_00 },
664 { .page = 0x80, .emulate = target_emulate_evpd_80 },
665 { .page = 0x83, .emulate = target_emulate_evpd_83 },
666 { .page = 0x86, .emulate = target_emulate_evpd_86 },
667 { .page = 0xb0, .emulate = target_emulate_evpd_b0 },
668 { .page = 0xb1, .emulate = target_emulate_evpd_b1 },
669 { .page = 0xb2, .emulate = target_emulate_evpd_b2 },
672 /* supported vital product data pages */
674 target_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf)
678 if (cmd->data_length < 8)
681 * Only report the INQUIRY EVPD=1 pages after a valid NAA
682 * Registered Extended LUN WWN has been set via ConfigFS
683 * during device creation/restart.
685 if (cmd->se_dev->se_sub_dev->su_dev_flags &
686 SDF_EMULATED_VPD_UNIT_SERIAL) {
687 buf[3] = ARRAY_SIZE(evpd_handlers);
688 for (p = 0; p < min_t(int, ARRAY_SIZE(evpd_handlers),
689 cmd->data_length - 4); ++p)
690 buf[p + 4] = evpd_handlers[p].page;
696 int target_emulate_inquiry(struct se_task *task)
698 struct se_cmd *cmd = task->task_se_cmd;
699 struct se_device *dev = cmd->se_dev;
701 unsigned char *cdb = cmd->t_task_cdb;
704 if (!(cdb[1] & 0x1)) {
706 pr_err("INQUIRY with EVPD==0 but PAGE CODE=%02x\n",
708 cmd->scsi_sense_reason = TCM_INVALID_CDB_FIELD;
712 ret = target_emulate_inquiry_std(cmd);
717 * Make sure we at least have 4 bytes of INQUIRY response
718 * payload for 0x00 going back for EVPD=1. Note that 0x80
719 * and 0x83 will check for enough payload data length and
720 * jump to set_len: label when there is not enough inquiry EVPD
721 * payload length left for the next outgoing EVPD metadata
723 if (cmd->data_length < 4) {
724 pr_err("SCSI Inquiry payload length: %u"
725 " too small for EVPD=1\n", cmd->data_length);
726 cmd->scsi_sense_reason = TCM_INVALID_CDB_FIELD;
730 buf = transport_kmap_data_sg(cmd);
732 buf[0] = dev->transport->get_device_type(dev);
734 for (p = 0; p < ARRAY_SIZE(evpd_handlers); ++p) {
735 if (cdb[2] == evpd_handlers[p].page) {
737 ret = evpd_handlers[p].emulate(cmd, buf);
742 pr_err("Unknown VPD Code: 0x%02x\n", cdb[2]);
743 cmd->scsi_sense_reason = TCM_INVALID_CDB_FIELD;
747 transport_kunmap_data_sg(cmd);
750 task->task_scsi_status = GOOD;
751 transport_complete_task(task, 1);
756 int target_emulate_readcapacity(struct se_task *task)
758 struct se_cmd *cmd = task->task_se_cmd;
759 struct se_device *dev = cmd->se_dev;
761 unsigned long long blocks_long = dev->transport->get_blocks(dev);
764 if (blocks_long >= 0x00000000ffffffff)
767 blocks = (u32)blocks_long;
769 buf = transport_kmap_data_sg(cmd);
771 buf[0] = (blocks >> 24) & 0xff;
772 buf[1] = (blocks >> 16) & 0xff;
773 buf[2] = (blocks >> 8) & 0xff;
774 buf[3] = blocks & 0xff;
775 buf[4] = (dev->se_sub_dev->se_dev_attrib.block_size >> 24) & 0xff;
776 buf[5] = (dev->se_sub_dev->se_dev_attrib.block_size >> 16) & 0xff;
777 buf[6] = (dev->se_sub_dev->se_dev_attrib.block_size >> 8) & 0xff;
778 buf[7] = dev->se_sub_dev->se_dev_attrib.block_size & 0xff;
780 * Set max 32-bit blocks to signal SERVICE ACTION READ_CAPACITY_16
782 if (dev->se_sub_dev->se_dev_attrib.emulate_tpu || dev->se_sub_dev->se_dev_attrib.emulate_tpws)
783 put_unaligned_be32(0xFFFFFFFF, &buf[0]);
785 transport_kunmap_data_sg(cmd);
787 task->task_scsi_status = GOOD;
788 transport_complete_task(task, 1);
792 int target_emulate_readcapacity_16(struct se_task *task)
794 struct se_cmd *cmd = task->task_se_cmd;
795 struct se_device *dev = cmd->se_dev;
797 unsigned long long blocks = dev->transport->get_blocks(dev);
799 buf = transport_kmap_data_sg(cmd);
801 buf[0] = (blocks >> 56) & 0xff;
802 buf[1] = (blocks >> 48) & 0xff;
803 buf[2] = (blocks >> 40) & 0xff;
804 buf[3] = (blocks >> 32) & 0xff;
805 buf[4] = (blocks >> 24) & 0xff;
806 buf[5] = (blocks >> 16) & 0xff;
807 buf[6] = (blocks >> 8) & 0xff;
808 buf[7] = blocks & 0xff;
809 buf[8] = (dev->se_sub_dev->se_dev_attrib.block_size >> 24) & 0xff;
810 buf[9] = (dev->se_sub_dev->se_dev_attrib.block_size >> 16) & 0xff;
811 buf[10] = (dev->se_sub_dev->se_dev_attrib.block_size >> 8) & 0xff;
812 buf[11] = dev->se_sub_dev->se_dev_attrib.block_size & 0xff;
814 * Set Thin Provisioning Enable bit following sbc3r22 in section
815 * READ CAPACITY (16) byte 14 if emulate_tpu or emulate_tpws is enabled.
817 if (dev->se_sub_dev->se_dev_attrib.emulate_tpu || dev->se_sub_dev->se_dev_attrib.emulate_tpws)
820 transport_kunmap_data_sg(cmd);
822 task->task_scsi_status = GOOD;
823 transport_complete_task(task, 1);
828 target_modesense_rwrecovery(unsigned char *p)
837 target_modesense_control(struct se_device *dev, unsigned char *p)
843 * From spc4r23, 7.4.7 Control mode page
845 * The QUEUE ALGORITHM MODIFIER field (see table 368) specifies
846 * restrictions on the algorithm used for reordering commands
847 * having the SIMPLE task attribute (see SAM-4).
849 * Table 368 -- QUEUE ALGORITHM MODIFIER field
851 * 0h Restricted reordering
852 * 1h Unrestricted reordering allowed
854 * 8h to Fh Vendor specific
856 * A value of zero in the QUEUE ALGORITHM MODIFIER field specifies that
857 * the device server shall order the processing sequence of commands
858 * having the SIMPLE task attribute such that data integrity is maintained
859 * for that I_T nexus (i.e., if the transmission of new SCSI transport protocol
860 * requests is halted at any time, the final value of all data observable
861 * on the medium shall be the same as if all the commands had been processed
862 * with the ORDERED task attribute).
864 * A value of one in the QUEUE ALGORITHM MODIFIER field specifies that the
865 * device server may reorder the processing sequence of commands having the
866 * SIMPLE task attribute in any manner. Any data integrity exposures related to
867 * command sequence order shall be explicitly handled by the application client
868 * through the selection of appropriate ommands and task attributes.
870 p[3] = (dev->se_sub_dev->se_dev_attrib.emulate_rest_reord == 1) ? 0x00 : 0x10;
872 * From spc4r17, section 7.4.6 Control mode Page
874 * Unit Attention interlocks control (UN_INTLCK_CTRL) to code 00b
876 * 00b: The logical unit shall clear any unit attention condition
877 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
878 * status and shall not establish a unit attention condition when a com-
879 * mand is completed with BUSY, TASK SET FULL, or RESERVATION CONFLICT
882 * 10b: The logical unit shall not clear any unit attention condition
883 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
884 * status and shall not establish a unit attention condition when
885 * a command is completed with BUSY, TASK SET FULL, or RESERVATION
888 * 11b a The logical unit shall not clear any unit attention condition
889 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
890 * status and shall establish a unit attention condition for the
891 * initiator port associated with the I_T nexus on which the BUSY,
892 * TASK SET FULL, or RESERVATION CONFLICT status is being returned.
893 * Depending on the status, the additional sense code shall be set to
894 * PREVIOUS BUSY STATUS, PREVIOUS TASK SET FULL STATUS, or PREVIOUS
895 * RESERVATION CONFLICT STATUS. Until it is cleared by a REQUEST SENSE
896 * command, a unit attention condition shall be established only once
897 * for a BUSY, TASK SET FULL, or RESERVATION CONFLICT status regardless
898 * to the number of commands completed with one of those status codes.
900 p[4] = (dev->se_sub_dev->se_dev_attrib.emulate_ua_intlck_ctrl == 2) ? 0x30 :
901 (dev->se_sub_dev->se_dev_attrib.emulate_ua_intlck_ctrl == 1) ? 0x20 : 0x00;
903 * From spc4r17, section 7.4.6 Control mode Page
905 * Task Aborted Status (TAS) bit set to zero.
907 * A task aborted status (TAS) bit set to zero specifies that aborted
908 * tasks shall be terminated by the device server without any response
909 * to the application client. A TAS bit set to one specifies that tasks
910 * aborted by the actions of an I_T nexus other than the I_T nexus on
911 * which the command was received shall be completed with TASK ABORTED
912 * status (see SAM-4).
914 p[5] = (dev->se_sub_dev->se_dev_attrib.emulate_tas) ? 0x40 : 0x00;
923 target_modesense_caching(struct se_device *dev, unsigned char *p)
927 if (dev->se_sub_dev->se_dev_attrib.emulate_write_cache > 0)
928 p[2] = 0x04; /* Write Cache Enable */
929 p[12] = 0x20; /* Disabled Read Ahead */
935 target_modesense_write_protect(unsigned char *buf, int type)
938 * I believe that the WP bit (bit 7) in the mode header is the same for
945 buf[0] |= 0x80; /* WP bit */
951 target_modesense_dpofua(unsigned char *buf, int type)
955 buf[0] |= 0x10; /* DPOFUA bit */
962 int target_emulate_modesense(struct se_task *task)
964 struct se_cmd *cmd = task->task_se_cmd;
965 struct se_device *dev = cmd->se_dev;
966 char *cdb = cmd->t_task_cdb;
968 int type = dev->transport->get_device_type(dev);
969 int ten = (cmd->t_task_cdb[0] == MODE_SENSE_10);
970 int offset = ten ? 8 : 4;
972 unsigned char buf[SE_MODE_PAGE_BUF];
974 memset(buf, 0, SE_MODE_PAGE_BUF);
976 switch (cdb[2] & 0x3f) {
978 length = target_modesense_rwrecovery(&buf[offset]);
981 length = target_modesense_caching(dev, &buf[offset]);
984 length = target_modesense_control(dev, &buf[offset]);
987 length = target_modesense_rwrecovery(&buf[offset]);
988 length += target_modesense_caching(dev, &buf[offset+length]);
989 length += target_modesense_control(dev, &buf[offset+length]);
992 pr_err("MODE SENSE: unimplemented page/subpage: 0x%02x/0x%02x\n",
993 cdb[2] & 0x3f, cdb[3]);
994 cmd->scsi_sense_reason = TCM_UNKNOWN_MODE_PAGE;
1001 buf[0] = (offset >> 8) & 0xff;
1002 buf[1] = offset & 0xff;
1004 if ((cmd->se_lun->lun_access & TRANSPORT_LUNFLAGS_READ_ONLY) ||
1006 (cmd->se_deve->lun_flags & TRANSPORT_LUNFLAGS_READ_ONLY)))
1007 target_modesense_write_protect(&buf[3], type);
1009 if ((dev->se_sub_dev->se_dev_attrib.emulate_write_cache > 0) &&
1010 (dev->se_sub_dev->se_dev_attrib.emulate_fua_write > 0))
1011 target_modesense_dpofua(&buf[3], type);
1013 if ((offset + 2) > cmd->data_length)
1014 offset = cmd->data_length;
1018 buf[0] = offset & 0xff;
1020 if ((cmd->se_lun->lun_access & TRANSPORT_LUNFLAGS_READ_ONLY) ||
1022 (cmd->se_deve->lun_flags & TRANSPORT_LUNFLAGS_READ_ONLY)))
1023 target_modesense_write_protect(&buf[2], type);
1025 if ((dev->se_sub_dev->se_dev_attrib.emulate_write_cache > 0) &&
1026 (dev->se_sub_dev->se_dev_attrib.emulate_fua_write > 0))
1027 target_modesense_dpofua(&buf[2], type);
1029 if ((offset + 1) > cmd->data_length)
1030 offset = cmd->data_length;
1033 rbuf = transport_kmap_data_sg(cmd);
1034 memcpy(rbuf, buf, offset);
1035 transport_kunmap_data_sg(cmd);
1037 task->task_scsi_status = GOOD;
1038 transport_complete_task(task, 1);
1042 int target_emulate_request_sense(struct se_task *task)
1044 struct se_cmd *cmd = task->task_se_cmd;
1045 unsigned char *cdb = cmd->t_task_cdb;
1047 u8 ua_asc = 0, ua_ascq = 0;
1050 if (cdb[1] & 0x01) {
1051 pr_err("REQUEST_SENSE description emulation not"
1053 cmd->scsi_sense_reason = TCM_INVALID_CDB_FIELD;
1057 buf = transport_kmap_data_sg(cmd);
1059 if (!core_scsi3_ua_clear_for_request_sense(cmd, &ua_asc, &ua_ascq)) {
1061 * CURRENT ERROR, UNIT ATTENTION
1064 buf[SPC_SENSE_KEY_OFFSET] = UNIT_ATTENTION;
1066 * Make sure request data length is enough for additional
1069 if (cmd->data_length <= 18) {
1075 * The Additional Sense Code (ASC) from the UNIT ATTENTION
1077 buf[SPC_ASC_KEY_OFFSET] = ua_asc;
1078 buf[SPC_ASCQ_KEY_OFFSET] = ua_ascq;
1082 * CURRENT ERROR, NO SENSE
1085 buf[SPC_SENSE_KEY_OFFSET] = NO_SENSE;
1087 * Make sure request data length is enough for additional
1090 if (cmd->data_length <= 18) {
1096 * NO ADDITIONAL SENSE INFORMATION
1098 buf[SPC_ASC_KEY_OFFSET] = 0x00;
1103 transport_kunmap_data_sg(cmd);
1104 task->task_scsi_status = GOOD;
1105 transport_complete_task(task, 1);
1110 * Used for TCM/IBLOCK and TCM/FILEIO for block/blk-lib.c level discard support.
1111 * Note this is not used for TCM/pSCSI passthrough
1113 int target_emulate_unmap(struct se_task *task)
1115 struct se_cmd *cmd = task->task_se_cmd;
1116 struct se_device *dev = cmd->se_dev;
1117 unsigned char *buf, *ptr = NULL;
1119 int size = cmd->data_length;
1124 if (!dev->transport->do_discard) {
1125 pr_err("UNMAP emulation not supported for: %s\n",
1126 dev->transport->name);
1127 cmd->scsi_sense_reason = TCM_UNSUPPORTED_SCSI_OPCODE;
1131 buf = transport_kmap_data_sg(cmd);
1133 dl = get_unaligned_be16(&buf[0]);
1134 bd_dl = get_unaligned_be16(&buf[2]);
1136 size = min(size - 8, bd_dl);
1137 if (size / 16 > dev->se_sub_dev->se_dev_attrib.max_unmap_block_desc_count) {
1138 cmd->scsi_sense_reason = TCM_INVALID_PARAMETER_LIST;
1143 /* First UNMAP block descriptor starts at 8 byte offset */
1145 pr_debug("UNMAP: Sub: %s Using dl: %u bd_dl: %u size: %u"
1146 " ptr: %p\n", dev->transport->name, dl, bd_dl, size, ptr);
1148 while (size >= 16) {
1149 lba = get_unaligned_be64(&ptr[0]);
1150 range = get_unaligned_be32(&ptr[8]);
1151 pr_debug("UNMAP: Using lba: %llu and range: %u\n",
1152 (unsigned long long)lba, range);
1154 if (range > dev->se_sub_dev->se_dev_attrib.max_unmap_lba_count) {
1155 cmd->scsi_sense_reason = TCM_INVALID_PARAMETER_LIST;
1160 if (lba + range > dev->transport->get_blocks(dev) + 1) {
1161 cmd->scsi_sense_reason = TCM_ADDRESS_OUT_OF_RANGE;
1166 ret = dev->transport->do_discard(dev, lba, range);
1168 pr_err("blkdev_issue_discard() failed: %d\n",
1178 transport_kunmap_data_sg(cmd);
1180 task->task_scsi_status = GOOD;
1181 transport_complete_task(task, 1);
1187 * Used for TCM/IBLOCK and TCM/FILEIO for block/blk-lib.c level discard support.
1188 * Note this is not used for TCM/pSCSI passthrough
1190 int target_emulate_write_same(struct se_task *task)
1192 struct se_cmd *cmd = task->task_se_cmd;
1193 struct se_device *dev = cmd->se_dev;
1195 sector_t lba = cmd->t_task_lba;
1199 if (!dev->transport->do_discard) {
1200 pr_err("WRITE_SAME emulation not supported"
1201 " for: %s\n", dev->transport->name);
1202 cmd->scsi_sense_reason = TCM_UNSUPPORTED_SCSI_OPCODE;
1206 if (cmd->t_task_cdb[0] == WRITE_SAME)
1207 num_blocks = get_unaligned_be16(&cmd->t_task_cdb[7]);
1208 else if (cmd->t_task_cdb[0] == WRITE_SAME_16)
1209 num_blocks = get_unaligned_be32(&cmd->t_task_cdb[10]);
1210 else /* WRITE_SAME_32 via VARIABLE_LENGTH_CMD */
1211 num_blocks = get_unaligned_be32(&cmd->t_task_cdb[28]);
1214 * Use the explicit range when non zero is supplied, otherwise calculate
1215 * the remaining range based on ->get_blocks() - starting LBA.
1217 if (num_blocks != 0)
1220 range = (dev->transport->get_blocks(dev) - lba) + 1;
1222 pr_debug("WRITE_SAME UNMAP: LBA: %llu Range: %llu\n",
1223 (unsigned long long)lba, (unsigned long long)range);
1225 ret = dev->transport->do_discard(dev, lba, range);
1227 pr_debug("blkdev_issue_discard() failed for WRITE_SAME\n");
1231 task->task_scsi_status = GOOD;
1232 transport_complete_task(task, 1);
1236 int target_emulate_synchronize_cache(struct se_task *task)
1238 struct se_device *dev = task->task_se_cmd->se_dev;
1239 struct se_cmd *cmd = task->task_se_cmd;
1241 if (!dev->transport->do_sync_cache) {
1242 pr_err("SYNCHRONIZE_CACHE emulation not supported"
1243 " for: %s\n", dev->transport->name);
1244 cmd->scsi_sense_reason = TCM_UNSUPPORTED_SCSI_OPCODE;
1248 dev->transport->do_sync_cache(task);
1252 int target_emulate_noop(struct se_task *task)
1254 task->task_scsi_status = GOOD;
1255 transport_complete_task(task, 1);
1260 * Write a CDB into @cdb that is based on the one the intiator sent us,
1261 * but updated to only cover the sectors that the current task handles.
1263 void target_get_task_cdb(struct se_task *task, unsigned char *cdb)
1265 struct se_cmd *cmd = task->task_se_cmd;
1266 unsigned int cdb_len = scsi_command_size(cmd->t_task_cdb);
1268 memcpy(cdb, cmd->t_task_cdb, cdb_len);
1269 if (cmd->se_cmd_flags & SCF_SCSI_DATA_SG_IO_CDB) {
1270 unsigned long long lba = task->task_lba;
1271 u32 sectors = task->task_sectors;
1275 /* 21-bit LBA and 8-bit sectors */
1276 cdb[1] = (lba >> 16) & 0x1f;
1277 cdb[2] = (lba >> 8) & 0xff;
1278 cdb[3] = lba & 0xff;
1279 cdb[4] = sectors & 0xff;
1282 /* 32-bit LBA and 16-bit sectors */
1283 put_unaligned_be32(lba, &cdb[2]);
1284 put_unaligned_be16(sectors, &cdb[7]);
1287 /* 32-bit LBA and 32-bit sectors */
1288 put_unaligned_be32(lba, &cdb[2]);
1289 put_unaligned_be32(sectors, &cdb[6]);
1292 /* 64-bit LBA and 32-bit sectors */
1293 put_unaligned_be64(lba, &cdb[2]);
1294 put_unaligned_be32(sectors, &cdb[10]);
1297 /* 64-bit LBA and 32-bit sectors, extended CDB */
1298 put_unaligned_be64(lba, &cdb[12]);
1299 put_unaligned_be32(sectors, &cdb[28]);
1306 EXPORT_SYMBOL(target_get_task_cdb);