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_backend.h>
33 #include <target/target_core_fabric.h>
35 #include "target_core_internal.h"
36 #include "target_core_ua.h"
39 target_fill_alua_data(struct se_port *port, unsigned char *buf)
41 struct t10_alua_tg_pt_gp *tg_pt_gp;
42 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
45 * Set SCCS for MAINTENANCE_IN + REPORT_TARGET_PORT_GROUPS.
50 * Set TPGS field for explict and/or implict ALUA access type
53 * See spc4r17 section 6.4.2 Table 135
57 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
61 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
62 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
64 buf[5] |= tg_pt_gp->tg_pt_gp_alua_access_type;
65 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
69 target_emulate_inquiry_std(struct se_cmd *cmd)
71 struct se_lun *lun = cmd->se_lun;
72 struct se_device *dev = cmd->se_dev;
73 struct se_portal_group *tpg = lun->lun_sep->sep_tpg;
77 * Make sure we at least have 6 bytes of INQUIRY response
78 * payload going back for EVPD=0
80 if (cmd->data_length < 6) {
81 pr_err("SCSI Inquiry payload length: %u"
82 " too small for EVPD=0\n", cmd->data_length);
86 buf = transport_kmap_first_data_page(cmd);
88 if (dev == tpg->tpg_virt_lun0.lun_se_dev) {
89 buf[0] = 0x3f; /* Not connected */
91 buf[0] = dev->transport->get_device_type(dev);
92 if (buf[0] == TYPE_TAPE)
95 buf[2] = dev->transport->get_device_rev(dev);
98 * NORMACA and HISUP = 0, RESPONSE DATA FORMAT = 2
101 * A RESPONSE DATA FORMAT field set to 2h indicates that the
102 * standard INQUIRY data is in the format defined in this
103 * standard. Response data format values less than 2h are
104 * obsolete. Response data format values greater than 2h are
110 * Enable SCCS and TPGS fields for Emulated ALUA
112 if (dev->se_sub_dev->t10_alua.alua_type == SPC3_ALUA_EMULATED)
113 target_fill_alua_data(lun->lun_sep, buf);
115 if (cmd->data_length < 8) {
116 buf[4] = 1; /* Set additional length to 1 */
120 buf[7] = 0x32; /* Sync=1 and CmdQue=1 */
123 * Do not include vendor, product, reversion info in INQUIRY
124 * response payload for cdbs with a small allocation length.
126 if (cmd->data_length < 36) {
127 buf[4] = 3; /* Set additional length to 3 */
131 snprintf(&buf[8], 8, "LIO-ORG");
132 snprintf(&buf[16], 16, "%s", dev->se_sub_dev->t10_wwn.model);
133 snprintf(&buf[32], 4, "%s", dev->se_sub_dev->t10_wwn.revision);
134 buf[4] = 31; /* Set additional length to 31 */
137 transport_kunmap_first_data_page(cmd);
141 /* unit serial number */
143 target_emulate_evpd_80(struct se_cmd *cmd, unsigned char *buf)
145 struct se_device *dev = cmd->se_dev;
148 if (dev->se_sub_dev->su_dev_flags &
149 SDF_EMULATED_VPD_UNIT_SERIAL) {
152 unit_serial_len = strlen(dev->se_sub_dev->t10_wwn.unit_serial);
153 unit_serial_len++; /* For NULL Terminator */
155 if (((len + 4) + unit_serial_len) > cmd->data_length) {
156 len += unit_serial_len;
157 buf[2] = ((len >> 8) & 0xff);
158 buf[3] = (len & 0xff);
161 len += sprintf(&buf[4], "%s",
162 dev->se_sub_dev->t10_wwn.unit_serial);
163 len++; /* Extra Byte for NULL Terminator */
170 target_parse_naa_6h_vendor_specific(struct se_device *dev, unsigned char *buf)
172 unsigned char *p = &dev->se_sub_dev->t10_wwn.unit_serial[0];
177 * Generate up to 36 bits of VENDOR SPECIFIC IDENTIFIER starting on
178 * byte 3 bit 3-0 for NAA IEEE Registered Extended DESIGNATOR field
179 * format, followed by 64 bits of VENDOR SPECIFIC IDENTIFIER EXTENSION
180 * to complete the payload. These are based from VPD=0x80 PRODUCT SERIAL
181 * NUMBER set via vpd_unit_serial in target_core_configfs.c to ensure
182 * per device uniqeness.
184 for (cnt = 0; *p && cnt < 13; p++) {
185 int val = hex_to_bin(*p);
201 * Device identification VPD, for a complete list of
202 * DESIGNATOR TYPEs see spc4r17 Table 459.
205 target_emulate_evpd_83(struct se_cmd *cmd, unsigned char *buf)
207 struct se_device *dev = cmd->se_dev;
208 struct se_lun *lun = cmd->se_lun;
209 struct se_port *port = NULL;
210 struct se_portal_group *tpg = NULL;
211 struct t10_alua_lu_gp_member *lu_gp_mem;
212 struct t10_alua_tg_pt_gp *tg_pt_gp;
213 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
214 unsigned char *prod = &dev->se_sub_dev->t10_wwn.model[0];
216 u32 unit_serial_len, off = 0;
222 * NAA IEEE Registered Extended Assigned designator format, see
223 * spc4r17 section 7.7.3.6.5
225 * We depend upon a target_core_mod/ConfigFS provided
226 * /sys/kernel/config/target/core/$HBA/$DEV/wwn/vpd_unit_serial
227 * value in order to return the NAA id.
229 if (!(dev->se_sub_dev->su_dev_flags & SDF_EMULATED_VPD_UNIT_SERIAL))
230 goto check_t10_vend_desc;
232 if (off + 20 > cmd->data_length)
233 goto check_t10_vend_desc;
235 /* CODE SET == Binary */
238 /* Set ASSOCIATION == addressed logical unit: 0)b */
241 /* Identifier/Designator type == NAA identifier */
245 /* Identifier/Designator length */
249 * Start NAA IEEE Registered Extended Identifier/Designator
251 buf[off++] = (0x6 << 4);
254 * Use OpenFabrics IEEE Company ID: 00 14 05
258 buf[off] = (0x5 << 4);
261 * Return ConfigFS Unit Serial Number information for
262 * VENDOR_SPECIFIC_IDENTIFIER and
263 * VENDOR_SPECIFIC_IDENTIFIER_EXTENTION
265 target_parse_naa_6h_vendor_specific(dev, &buf[off]);
272 * T10 Vendor Identifier Page, see spc4r17 section 7.7.3.4
274 id_len = 8; /* For Vendor field */
275 prod_len = 4; /* For VPD Header */
276 prod_len += 8; /* For Vendor field */
277 prod_len += strlen(prod);
278 prod_len++; /* For : */
280 if (dev->se_sub_dev->su_dev_flags &
281 SDF_EMULATED_VPD_UNIT_SERIAL) {
283 strlen(&dev->se_sub_dev->t10_wwn.unit_serial[0]);
284 unit_serial_len++; /* For NULL Terminator */
286 if ((len + (id_len + 4) +
287 (prod_len + unit_serial_len)) >
289 len += (prod_len + unit_serial_len);
292 id_len += sprintf(&buf[off+12], "%s:%s", prod,
293 &dev->se_sub_dev->t10_wwn.unit_serial[0]);
295 buf[off] = 0x2; /* ASCII */
296 buf[off+1] = 0x1; /* T10 Vendor ID */
298 memcpy(&buf[off+4], "LIO-ORG", 8);
299 /* Extra Byte for NULL Terminator */
301 /* Identifier Length */
303 /* Header size for Designation descriptor */
307 * struct se_port is only set for INQUIRY VPD=1 through $FABRIC_MOD
312 struct t10_alua_lu_gp *lu_gp;
313 u32 padding, scsi_name_len;
320 * Relative target port identifer, see spc4r17
323 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
324 * section 7.5.1 Table 362
326 if (((len + 4) + 8) > cmd->data_length) {
331 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
332 buf[off++] |= 0x1; /* CODE SET == Binary */
333 buf[off] = 0x80; /* Set PIV=1 */
334 /* Set ASSOCIATION == target port: 01b */
336 /* DESIGNATOR TYPE == Relative target port identifer */
338 off++; /* Skip over Reserved */
339 buf[off++] = 4; /* DESIGNATOR LENGTH */
340 /* Skip over Obsolete field in RTPI payload
343 buf[off++] = ((port->sep_rtpi >> 8) & 0xff);
344 buf[off++] = (port->sep_rtpi & 0xff);
345 len += 8; /* Header size + Designation descriptor */
347 * Target port group identifier, see spc4r17
350 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
351 * section 7.5.1 Table 362
354 if (dev->se_sub_dev->t10_alua.alua_type !=
356 goto check_scsi_name;
358 if (((len + 4) + 8) > cmd->data_length) {
362 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
366 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
367 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
369 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
372 tg_pt_gp_id = tg_pt_gp->tg_pt_gp_id;
373 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
376 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
377 buf[off++] |= 0x1; /* CODE SET == Binary */
378 buf[off] = 0x80; /* Set PIV=1 */
379 /* Set ASSOCIATION == target port: 01b */
381 /* DESIGNATOR TYPE == Target port group identifier */
383 off++; /* Skip over Reserved */
384 buf[off++] = 4; /* DESIGNATOR LENGTH */
385 off += 2; /* Skip over Reserved Field */
386 buf[off++] = ((tg_pt_gp_id >> 8) & 0xff);
387 buf[off++] = (tg_pt_gp_id & 0xff);
388 len += 8; /* Header size + Designation descriptor */
390 * Logical Unit Group identifier, see spc4r17
394 if (((len + 4) + 8) > cmd->data_length) {
396 goto check_scsi_name;
398 lu_gp_mem = dev->dev_alua_lu_gp_mem;
400 goto check_scsi_name;
402 spin_lock(&lu_gp_mem->lu_gp_mem_lock);
403 lu_gp = lu_gp_mem->lu_gp;
405 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
406 goto check_scsi_name;
408 lu_gp_id = lu_gp->lu_gp_id;
409 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
411 buf[off++] |= 0x1; /* CODE SET == Binary */
412 /* DESIGNATOR TYPE == Logical Unit Group identifier */
414 off++; /* Skip over Reserved */
415 buf[off++] = 4; /* DESIGNATOR LENGTH */
416 off += 2; /* Skip over Reserved Field */
417 buf[off++] = ((lu_gp_id >> 8) & 0xff);
418 buf[off++] = (lu_gp_id & 0xff);
419 len += 8; /* Header size + Designation descriptor */
421 * SCSI name string designator, see spc4r17
424 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
425 * section 7.5.1 Table 362
428 scsi_name_len = strlen(tpg->se_tpg_tfo->tpg_get_wwn(tpg));
429 /* UTF-8 ",t,0x<16-bit TPGT>" + NULL Terminator */
431 /* Check for 4-byte padding */
432 padding = ((-scsi_name_len) & 3);
434 scsi_name_len += padding;
435 /* Header size + Designation descriptor */
438 if (((len + 4) + scsi_name_len) > cmd->data_length) {
439 len += scsi_name_len;
443 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
444 buf[off++] |= 0x3; /* CODE SET == UTF-8 */
445 buf[off] = 0x80; /* Set PIV=1 */
446 /* Set ASSOCIATION == target port: 01b */
448 /* DESIGNATOR TYPE == SCSI name string */
450 off += 2; /* Skip over Reserved and length */
452 * SCSI name string identifer containing, $FABRIC_MOD
453 * dependent information. For LIO-Target and iSCSI
454 * Target Port, this means "<iSCSI name>,t,0x<TPGT> in
457 tpgt = tpg->se_tpg_tfo->tpg_get_tag(tpg);
458 scsi_name_len = sprintf(&buf[off], "%s,t,0x%04x",
459 tpg->se_tpg_tfo->tpg_get_wwn(tpg), tpgt);
460 scsi_name_len += 1 /* Include NULL terminator */;
462 * The null-terminated, null-padded (see 4.4.2) SCSI
463 * NAME STRING field contains a UTF-8 format string.
464 * The number of bytes in the SCSI NAME STRING field
465 * (i.e., the value in the DESIGNATOR LENGTH field)
466 * shall be no larger than 256 and shall be a multiple
470 scsi_name_len += padding;
472 buf[off-1] = scsi_name_len;
473 off += scsi_name_len;
474 /* Header size + Designation descriptor */
475 len += (scsi_name_len + 4);
478 buf[2] = ((len >> 8) & 0xff);
479 buf[3] = (len & 0xff); /* Page Length for VPD 0x83 */
483 /* Extended INQUIRY Data VPD Page */
485 target_emulate_evpd_86(struct se_cmd *cmd, unsigned char *buf)
487 if (cmd->data_length < 60)
491 /* Set HEADSUP, ORDSUP, SIMPSUP */
494 /* If WriteCache emulation is enabled, set V_SUP */
495 if (cmd->se_dev->se_sub_dev->se_dev_attrib.emulate_write_cache > 0)
500 /* Block Limits VPD page */
502 target_emulate_evpd_b0(struct se_cmd *cmd, unsigned char *buf)
504 struct se_device *dev = cmd->se_dev;
508 * Following sbc3r22 section 6.5.3 Block Limits VPD page, when
509 * emulate_tpu=1 or emulate_tpws=1 we will be expect a
510 * different page length for Thin Provisioning.
512 if (dev->se_sub_dev->se_dev_attrib.emulate_tpu || dev->se_sub_dev->se_dev_attrib.emulate_tpws)
515 if (cmd->data_length < (0x10 + 4)) {
516 pr_debug("Received data_length: %u"
517 " too small for EVPD 0xb0\n",
522 if (have_tp && cmd->data_length < (0x3c + 4)) {
523 pr_debug("Received data_length: %u"
524 " too small for TPE=1 EVPD 0xb0\n",
529 buf[0] = dev->transport->get_device_type(dev);
530 buf[3] = have_tp ? 0x3c : 0x10;
536 * Set OPTIMAL TRANSFER LENGTH GRANULARITY
538 put_unaligned_be16(1, &buf[6]);
541 * Set MAXIMUM TRANSFER LENGTH
543 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.max_sectors, &buf[8]);
546 * Set OPTIMAL TRANSFER LENGTH
548 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.optimal_sectors, &buf[12]);
551 * Exit now if we don't support TP or the initiator sent a too
554 if (!have_tp || cmd->data_length < (0x3c + 4))
558 * Set MAXIMUM UNMAP LBA COUNT
560 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.max_unmap_lba_count, &buf[20]);
563 * Set MAXIMUM UNMAP BLOCK DESCRIPTOR COUNT
565 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.max_unmap_block_desc_count,
569 * Set OPTIMAL UNMAP GRANULARITY
571 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.unmap_granularity, &buf[28]);
574 * UNMAP GRANULARITY ALIGNMENT
576 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.unmap_granularity_alignment,
578 if (dev->se_sub_dev->se_dev_attrib.unmap_granularity_alignment != 0)
579 buf[32] |= 0x80; /* Set the UGAVALID bit */
584 /* Block Device Characteristics VPD page */
586 target_emulate_evpd_b1(struct se_cmd *cmd, unsigned char *buf)
588 struct se_device *dev = cmd->se_dev;
590 buf[0] = dev->transport->get_device_type(dev);
593 if (cmd->data_length >= 5 &&
594 dev->se_sub_dev->se_dev_attrib.is_nonrot)
600 /* Thin Provisioning VPD */
602 target_emulate_evpd_b2(struct se_cmd *cmd, unsigned char *buf)
604 struct se_device *dev = cmd->se_dev;
607 * From sbc3r22 section 6.5.4 Thin Provisioning VPD page:
609 * The PAGE LENGTH field is defined in SPC-4. If the DP bit is set to
610 * zero, then the page length shall be set to 0004h. If the DP bit
611 * is set to one, then the page length shall be set to the value
612 * defined in table 162.
614 buf[0] = dev->transport->get_device_type(dev);
617 * Set Hardcoded length mentioned above for DP=0
619 put_unaligned_be16(0x0004, &buf[2]);
622 * The THRESHOLD EXPONENT field indicates the threshold set size in
623 * LBAs as a power of 2 (i.e., the threshold set size is equal to
624 * 2(threshold exponent)).
626 * Note that this is currently set to 0x00 as mkp says it will be
627 * changing again. We can enable this once it has settled in T10
628 * and is actually used by Linux/SCSI ML code.
633 * A TPU bit set to one indicates that the device server supports
634 * the UNMAP command (see 5.25). A TPU bit set to zero indicates
635 * that the device server does not support the UNMAP command.
637 if (dev->se_sub_dev->se_dev_attrib.emulate_tpu != 0)
641 * A TPWS bit set to one indicates that the device server supports
642 * the use of the WRITE SAME (16) command (see 5.42) to unmap LBAs.
643 * A TPWS bit set to zero indicates that the device server does not
644 * support the use of the WRITE SAME (16) command to unmap LBAs.
646 if (dev->se_sub_dev->se_dev_attrib.emulate_tpws != 0)
653 target_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf);
657 int (*emulate)(struct se_cmd *, unsigned char *);
658 } evpd_handlers[] = {
659 { .page = 0x00, .emulate = target_emulate_evpd_00 },
660 { .page = 0x80, .emulate = target_emulate_evpd_80 },
661 { .page = 0x83, .emulate = target_emulate_evpd_83 },
662 { .page = 0x86, .emulate = target_emulate_evpd_86 },
663 { .page = 0xb0, .emulate = target_emulate_evpd_b0 },
664 { .page = 0xb1, .emulate = target_emulate_evpd_b1 },
665 { .page = 0xb2, .emulate = target_emulate_evpd_b2 },
668 /* supported vital product data pages */
670 target_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf)
674 if (cmd->data_length < 8)
677 * Only report the INQUIRY EVPD=1 pages after a valid NAA
678 * Registered Extended LUN WWN has been set via ConfigFS
679 * during device creation/restart.
681 if (cmd->se_dev->se_sub_dev->su_dev_flags &
682 SDF_EMULATED_VPD_UNIT_SERIAL) {
683 buf[3] = ARRAY_SIZE(evpd_handlers);
684 for (p = 0; p < min_t(int, ARRAY_SIZE(evpd_handlers),
685 cmd->data_length - 4); ++p)
686 buf[p + 4] = evpd_handlers[p].page;
692 int target_emulate_inquiry(struct se_task *task)
694 struct se_cmd *cmd = task->task_se_cmd;
695 struct se_device *dev = cmd->se_dev;
697 unsigned char *cdb = cmd->t_task_cdb;
700 if (!(cdb[1] & 0x1)) {
701 ret = target_emulate_inquiry_std(cmd);
706 * Make sure we at least have 4 bytes of INQUIRY response
707 * payload for 0x00 going back for EVPD=1. Note that 0x80
708 * and 0x83 will check for enough payload data length and
709 * jump to set_len: label when there is not enough inquiry EVPD
710 * payload length left for the next outgoing EVPD metadata
712 if (cmd->data_length < 4) {
713 pr_err("SCSI Inquiry payload length: %u"
714 " too small for EVPD=1\n", cmd->data_length);
715 cmd->scsi_sense_reason = TCM_INVALID_CDB_FIELD;
719 buf = transport_kmap_first_data_page(cmd);
721 buf[0] = dev->transport->get_device_type(dev);
723 for (p = 0; p < ARRAY_SIZE(evpd_handlers); ++p) {
724 if (cdb[2] == evpd_handlers[p].page) {
726 ret = evpd_handlers[p].emulate(cmd, buf);
731 pr_err("Unknown VPD Code: 0x%02x\n", cdb[2]);
732 cmd->scsi_sense_reason = TCM_UNSUPPORTED_SCSI_OPCODE;
736 transport_kunmap_first_data_page(cmd);
739 task->task_scsi_status = GOOD;
740 transport_complete_task(task, 1);
745 int target_emulate_readcapacity(struct se_task *task)
747 struct se_cmd *cmd = task->task_se_cmd;
748 struct se_device *dev = cmd->se_dev;
750 unsigned long long blocks_long = dev->transport->get_blocks(dev);
753 if (blocks_long >= 0x00000000ffffffff)
756 blocks = (u32)blocks_long;
758 buf = transport_kmap_first_data_page(cmd);
760 buf[0] = (blocks >> 24) & 0xff;
761 buf[1] = (blocks >> 16) & 0xff;
762 buf[2] = (blocks >> 8) & 0xff;
763 buf[3] = blocks & 0xff;
764 buf[4] = (dev->se_sub_dev->se_dev_attrib.block_size >> 24) & 0xff;
765 buf[5] = (dev->se_sub_dev->se_dev_attrib.block_size >> 16) & 0xff;
766 buf[6] = (dev->se_sub_dev->se_dev_attrib.block_size >> 8) & 0xff;
767 buf[7] = dev->se_sub_dev->se_dev_attrib.block_size & 0xff;
769 * Set max 32-bit blocks to signal SERVICE ACTION READ_CAPACITY_16
771 if (dev->se_sub_dev->se_dev_attrib.emulate_tpu || dev->se_sub_dev->se_dev_attrib.emulate_tpws)
772 put_unaligned_be32(0xFFFFFFFF, &buf[0]);
774 transport_kunmap_first_data_page(cmd);
776 task->task_scsi_status = GOOD;
777 transport_complete_task(task, 1);
781 int target_emulate_readcapacity_16(struct se_task *task)
783 struct se_cmd *cmd = task->task_se_cmd;
784 struct se_device *dev = cmd->se_dev;
786 unsigned long long blocks = dev->transport->get_blocks(dev);
788 buf = transport_kmap_first_data_page(cmd);
790 buf[0] = (blocks >> 56) & 0xff;
791 buf[1] = (blocks >> 48) & 0xff;
792 buf[2] = (blocks >> 40) & 0xff;
793 buf[3] = (blocks >> 32) & 0xff;
794 buf[4] = (blocks >> 24) & 0xff;
795 buf[5] = (blocks >> 16) & 0xff;
796 buf[6] = (blocks >> 8) & 0xff;
797 buf[7] = blocks & 0xff;
798 buf[8] = (dev->se_sub_dev->se_dev_attrib.block_size >> 24) & 0xff;
799 buf[9] = (dev->se_sub_dev->se_dev_attrib.block_size >> 16) & 0xff;
800 buf[10] = (dev->se_sub_dev->se_dev_attrib.block_size >> 8) & 0xff;
801 buf[11] = dev->se_sub_dev->se_dev_attrib.block_size & 0xff;
803 * Set Thin Provisioning Enable bit following sbc3r22 in section
804 * READ CAPACITY (16) byte 14 if emulate_tpu or emulate_tpws is enabled.
806 if (dev->se_sub_dev->se_dev_attrib.emulate_tpu || dev->se_sub_dev->se_dev_attrib.emulate_tpws)
809 transport_kunmap_first_data_page(cmd);
811 task->task_scsi_status = GOOD;
812 transport_complete_task(task, 1);
817 target_modesense_rwrecovery(unsigned char *p)
826 target_modesense_control(struct se_device *dev, unsigned char *p)
832 * From spc4r23, 7.4.7 Control mode page
834 * The QUEUE ALGORITHM MODIFIER field (see table 368) specifies
835 * restrictions on the algorithm used for reordering commands
836 * having the SIMPLE task attribute (see SAM-4).
838 * Table 368 -- QUEUE ALGORITHM MODIFIER field
840 * 0h Restricted reordering
841 * 1h Unrestricted reordering allowed
843 * 8h to Fh Vendor specific
845 * A value of zero in the QUEUE ALGORITHM MODIFIER field specifies that
846 * the device server shall order the processing sequence of commands
847 * having the SIMPLE task attribute such that data integrity is maintained
848 * for that I_T nexus (i.e., if the transmission of new SCSI transport protocol
849 * requests is halted at any time, the final value of all data observable
850 * on the medium shall be the same as if all the commands had been processed
851 * with the ORDERED task attribute).
853 * A value of one in the QUEUE ALGORITHM MODIFIER field specifies that the
854 * device server may reorder the processing sequence of commands having the
855 * SIMPLE task attribute in any manner. Any data integrity exposures related to
856 * command sequence order shall be explicitly handled by the application client
857 * through the selection of appropriate ommands and task attributes.
859 p[3] = (dev->se_sub_dev->se_dev_attrib.emulate_rest_reord == 1) ? 0x00 : 0x10;
861 * From spc4r17, section 7.4.6 Control mode Page
863 * Unit Attention interlocks control (UN_INTLCK_CTRL) to code 00b
865 * 00b: The logical unit shall clear any unit attention condition
866 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
867 * status and shall not establish a unit attention condition when a com-
868 * mand is completed with BUSY, TASK SET FULL, or RESERVATION CONFLICT
871 * 10b: The logical unit shall not clear any unit attention condition
872 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
873 * status and shall not establish a unit attention condition when
874 * a command is completed with BUSY, TASK SET FULL, or RESERVATION
877 * 11b a The logical unit shall not clear any unit attention condition
878 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
879 * status and shall establish a unit attention condition for the
880 * initiator port associated with the I_T nexus on which the BUSY,
881 * TASK SET FULL, or RESERVATION CONFLICT status is being returned.
882 * Depending on the status, the additional sense code shall be set to
883 * PREVIOUS BUSY STATUS, PREVIOUS TASK SET FULL STATUS, or PREVIOUS
884 * RESERVATION CONFLICT STATUS. Until it is cleared by a REQUEST SENSE
885 * command, a unit attention condition shall be established only once
886 * for a BUSY, TASK SET FULL, or RESERVATION CONFLICT status regardless
887 * to the number of commands completed with one of those status codes.
889 p[4] = (dev->se_sub_dev->se_dev_attrib.emulate_ua_intlck_ctrl == 2) ? 0x30 :
890 (dev->se_sub_dev->se_dev_attrib.emulate_ua_intlck_ctrl == 1) ? 0x20 : 0x00;
892 * From spc4r17, section 7.4.6 Control mode Page
894 * Task Aborted Status (TAS) bit set to zero.
896 * A task aborted status (TAS) bit set to zero specifies that aborted
897 * tasks shall be terminated by the device server without any response
898 * to the application client. A TAS bit set to one specifies that tasks
899 * aborted by the actions of an I_T nexus other than the I_T nexus on
900 * which the command was received shall be completed with TASK ABORTED
901 * status (see SAM-4).
903 p[5] = (dev->se_sub_dev->se_dev_attrib.emulate_tas) ? 0x40 : 0x00;
912 target_modesense_caching(struct se_device *dev, unsigned char *p)
916 if (dev->se_sub_dev->se_dev_attrib.emulate_write_cache > 0)
917 p[2] = 0x04; /* Write Cache Enable */
918 p[12] = 0x20; /* Disabled Read Ahead */
924 target_modesense_write_protect(unsigned char *buf, int type)
927 * I believe that the WP bit (bit 7) in the mode header is the same for
934 buf[0] |= 0x80; /* WP bit */
940 target_modesense_dpofua(unsigned char *buf, int type)
944 buf[0] |= 0x10; /* DPOFUA bit */
951 int target_emulate_modesense(struct se_task *task)
953 struct se_cmd *cmd = task->task_se_cmd;
954 struct se_device *dev = cmd->se_dev;
955 char *cdb = cmd->t_task_cdb;
957 int type = dev->transport->get_device_type(dev);
958 int ten = (cmd->t_task_cdb[0] == MODE_SENSE_10);
959 int offset = ten ? 8 : 4;
961 unsigned char buf[SE_MODE_PAGE_BUF];
963 memset(buf, 0, SE_MODE_PAGE_BUF);
965 switch (cdb[2] & 0x3f) {
967 length = target_modesense_rwrecovery(&buf[offset]);
970 length = target_modesense_caching(dev, &buf[offset]);
973 length = target_modesense_control(dev, &buf[offset]);
976 length = target_modesense_rwrecovery(&buf[offset]);
977 length += target_modesense_caching(dev, &buf[offset+length]);
978 length += target_modesense_control(dev, &buf[offset+length]);
981 pr_err("MODE SENSE: unimplemented page/subpage: 0x%02x/0x%02x\n",
982 cdb[2] & 0x3f, cdb[3]);
983 cmd->scsi_sense_reason = TCM_UNKNOWN_MODE_PAGE;
990 buf[0] = (offset >> 8) & 0xff;
991 buf[1] = offset & 0xff;
993 if ((cmd->se_lun->lun_access & TRANSPORT_LUNFLAGS_READ_ONLY) ||
995 (cmd->se_deve->lun_flags & TRANSPORT_LUNFLAGS_READ_ONLY)))
996 target_modesense_write_protect(&buf[3], type);
998 if ((dev->se_sub_dev->se_dev_attrib.emulate_write_cache > 0) &&
999 (dev->se_sub_dev->se_dev_attrib.emulate_fua_write > 0))
1000 target_modesense_dpofua(&buf[3], type);
1002 if ((offset + 2) > cmd->data_length)
1003 offset = cmd->data_length;
1007 buf[0] = offset & 0xff;
1009 if ((cmd->se_lun->lun_access & TRANSPORT_LUNFLAGS_READ_ONLY) ||
1011 (cmd->se_deve->lun_flags & TRANSPORT_LUNFLAGS_READ_ONLY)))
1012 target_modesense_write_protect(&buf[2], type);
1014 if ((dev->se_sub_dev->se_dev_attrib.emulate_write_cache > 0) &&
1015 (dev->se_sub_dev->se_dev_attrib.emulate_fua_write > 0))
1016 target_modesense_dpofua(&buf[2], type);
1018 if ((offset + 1) > cmd->data_length)
1019 offset = cmd->data_length;
1022 rbuf = transport_kmap_first_data_page(cmd);
1023 memcpy(rbuf, buf, offset);
1024 transport_kunmap_first_data_page(cmd);
1026 task->task_scsi_status = GOOD;
1027 transport_complete_task(task, 1);
1031 int target_emulate_request_sense(struct se_task *task)
1033 struct se_cmd *cmd = task->task_se_cmd;
1034 unsigned char *cdb = cmd->t_task_cdb;
1036 u8 ua_asc = 0, ua_ascq = 0;
1039 if (cdb[1] & 0x01) {
1040 pr_err("REQUEST_SENSE description emulation not"
1042 cmd->scsi_sense_reason = TCM_INVALID_CDB_FIELD;
1046 buf = transport_kmap_first_data_page(cmd);
1048 if (!core_scsi3_ua_clear_for_request_sense(cmd, &ua_asc, &ua_ascq)) {
1050 * CURRENT ERROR, UNIT ATTENTION
1053 buf[SPC_SENSE_KEY_OFFSET] = UNIT_ATTENTION;
1055 * Make sure request data length is enough for additional
1058 if (cmd->data_length <= 18) {
1064 * The Additional Sense Code (ASC) from the UNIT ATTENTION
1066 buf[SPC_ASC_KEY_OFFSET] = ua_asc;
1067 buf[SPC_ASCQ_KEY_OFFSET] = ua_ascq;
1071 * CURRENT ERROR, NO SENSE
1074 buf[SPC_SENSE_KEY_OFFSET] = NO_SENSE;
1076 * Make sure request data length is enough for additional
1079 if (cmd->data_length <= 18) {
1085 * NO ADDITIONAL SENSE INFORMATION
1087 buf[SPC_ASC_KEY_OFFSET] = 0x00;
1092 transport_kunmap_first_data_page(cmd);
1093 task->task_scsi_status = GOOD;
1094 transport_complete_task(task, 1);
1099 * Used for TCM/IBLOCK and TCM/FILEIO for block/blk-lib.c level discard support.
1100 * Note this is not used for TCM/pSCSI passthrough
1102 int target_emulate_unmap(struct se_task *task)
1104 struct se_cmd *cmd = task->task_se_cmd;
1105 struct se_device *dev = cmd->se_dev;
1106 unsigned char *buf, *ptr = NULL;
1107 unsigned char *cdb = &cmd->t_task_cdb[0];
1109 unsigned int size = cmd->data_length, range;
1110 int ret = 0, offset;
1111 unsigned short dl, bd_dl;
1113 if (!dev->transport->do_discard) {
1114 pr_err("UNMAP emulation not supported for: %s\n",
1115 dev->transport->name);
1116 cmd->scsi_sense_reason = TCM_UNSUPPORTED_SCSI_OPCODE;
1120 /* First UNMAP block descriptor starts at 8 byte offset */
1123 dl = get_unaligned_be16(&cdb[0]);
1124 bd_dl = get_unaligned_be16(&cdb[2]);
1126 buf = transport_kmap_first_data_page(cmd);
1129 pr_debug("UNMAP: Sub: %s Using dl: %hu bd_dl: %hu size: %hu"
1130 " ptr: %p\n", dev->transport->name, dl, bd_dl, size, ptr);
1133 lba = get_unaligned_be64(&ptr[0]);
1134 range = get_unaligned_be32(&ptr[8]);
1135 pr_debug("UNMAP: Using lba: %llu and range: %u\n",
1136 (unsigned long long)lba, range);
1138 ret = dev->transport->do_discard(dev, lba, range);
1140 pr_err("blkdev_issue_discard() failed: %d\n",
1150 transport_kunmap_first_data_page(cmd);
1152 task->task_scsi_status = GOOD;
1153 transport_complete_task(task, 1);
1159 * Used for TCM/IBLOCK and TCM/FILEIO for block/blk-lib.c level discard support.
1160 * Note this is not used for TCM/pSCSI passthrough
1162 int target_emulate_write_same(struct se_task *task)
1164 struct se_cmd *cmd = task->task_se_cmd;
1165 struct se_device *dev = cmd->se_dev;
1167 sector_t lba = cmd->t_task_lba;
1171 if (!dev->transport->do_discard) {
1172 pr_err("WRITE_SAME emulation not supported"
1173 " for: %s\n", dev->transport->name);
1174 cmd->scsi_sense_reason = TCM_UNSUPPORTED_SCSI_OPCODE;
1178 if (cmd->t_task_cdb[0] == WRITE_SAME)
1179 num_blocks = get_unaligned_be16(&cmd->t_task_cdb[7]);
1180 else if (cmd->t_task_cdb[0] == WRITE_SAME_16)
1181 num_blocks = get_unaligned_be32(&cmd->t_task_cdb[10]);
1182 else /* WRITE_SAME_32 via VARIABLE_LENGTH_CMD */
1183 num_blocks = get_unaligned_be32(&cmd->t_task_cdb[28]);
1186 * Use the explicit range when non zero is supplied, otherwise calculate
1187 * the remaining range based on ->get_blocks() - starting LBA.
1189 if (num_blocks != 0)
1192 range = (dev->transport->get_blocks(dev) - lba);
1194 pr_debug("WRITE_SAME UNMAP: LBA: %llu Range: %llu\n",
1195 (unsigned long long)lba, (unsigned long long)range);
1197 ret = dev->transport->do_discard(dev, lba, range);
1199 pr_debug("blkdev_issue_discard() failed for WRITE_SAME\n");
1203 task->task_scsi_status = GOOD;
1204 transport_complete_task(task, 1);
1208 int target_emulate_synchronize_cache(struct se_task *task)
1210 struct se_device *dev = task->task_se_cmd->se_dev;
1211 struct se_cmd *cmd = task->task_se_cmd;
1213 if (!dev->transport->do_sync_cache) {
1214 pr_err("SYNCHRONIZE_CACHE emulation not supported"
1215 " for: %s\n", dev->transport->name);
1216 cmd->scsi_sense_reason = TCM_UNSUPPORTED_SCSI_OPCODE;
1220 dev->transport->do_sync_cache(task);
1224 int target_emulate_noop(struct se_task *task)
1226 task->task_scsi_status = GOOD;
1227 transport_complete_task(task, 1);
1232 * Write a CDB into @cdb that is based on the one the intiator sent us,
1233 * but updated to only cover the sectors that the current task handles.
1235 void target_get_task_cdb(struct se_task *task, unsigned char *cdb)
1237 struct se_cmd *cmd = task->task_se_cmd;
1238 unsigned int cdb_len = scsi_command_size(cmd->t_task_cdb);
1240 memcpy(cdb, cmd->t_task_cdb, cdb_len);
1241 if (cmd->se_cmd_flags & SCF_SCSI_DATA_SG_IO_CDB) {
1242 unsigned long long lba = task->task_lba;
1243 u32 sectors = task->task_sectors;
1247 /* 21-bit LBA and 8-bit sectors */
1248 cdb[1] = (lba >> 16) & 0x1f;
1249 cdb[2] = (lba >> 8) & 0xff;
1250 cdb[3] = lba & 0xff;
1251 cdb[4] = sectors & 0xff;
1254 /* 32-bit LBA and 16-bit sectors */
1255 put_unaligned_be32(lba, &cdb[2]);
1256 put_unaligned_be16(sectors, &cdb[7]);
1259 /* 32-bit LBA and 32-bit sectors */
1260 put_unaligned_be32(lba, &cdb[2]);
1261 put_unaligned_be32(sectors, &cdb[6]);
1264 /* 64-bit LBA and 32-bit sectors */
1265 put_unaligned_be64(lba, &cdb[2]);
1266 put_unaligned_be32(sectors, &cdb[10]);
1269 /* 64-bit LBA and 32-bit sectors, extended CDB */
1270 put_unaligned_be64(lba, &cdb[12]);
1271 put_unaligned_be32(sectors, &cdb[28]);
1278 EXPORT_SYMBOL(target_get_task_cdb);