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 <asm/unaligned.h>
28 #include <scsi/scsi.h>
30 #include <target/target_core_base.h>
31 #include <target/target_core_transport.h>
32 #include <target/target_core_fabric_ops.h>
33 #include "target_core_ua.h"
36 target_fill_alua_data(struct se_port *port, unsigned char *buf)
38 struct t10_alua_tg_pt_gp *tg_pt_gp;
39 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
42 * Set SCCS for MAINTENANCE_IN + REPORT_TARGET_PORT_GROUPS.
47 * Set TPGS field for explict and/or implict ALUA access type
50 * See spc4r17 section 6.4.2 Table 135
54 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
58 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
59 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
61 buf[5] |= tg_pt_gp->tg_pt_gp_alua_access_type;
62 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
66 target_emulate_inquiry_std(struct se_cmd *cmd)
68 struct se_lun *lun = cmd->se_lun;
69 struct se_device *dev = cmd->se_dev;
70 struct se_portal_group *tpg = lun->lun_sep->sep_tpg;
74 * Make sure we at least have 6 bytes of INQUIRY response
75 * payload going back for EVPD=0
77 if (cmd->data_length < 6) {
78 pr_err("SCSI Inquiry payload length: %u"
79 " too small for EVPD=0\n", cmd->data_length);
83 buf = transport_kmap_first_data_page(cmd);
85 if (dev == tpg->tpg_virt_lun0.lun_se_dev) {
86 buf[0] = 0x3f; /* Not connected */
88 buf[0] = dev->transport->get_device_type(dev);
89 if (buf[0] == TYPE_TAPE)
92 buf[2] = dev->transport->get_device_rev(dev);
95 * Enable SCCS and TPGS fields for Emulated ALUA
97 if (dev->se_sub_dev->t10_alua.alua_type == SPC3_ALUA_EMULATED)
98 target_fill_alua_data(lun->lun_sep, buf);
100 if (cmd->data_length < 8) {
101 buf[4] = 1; /* Set additional length to 1 */
105 buf[7] = 0x32; /* Sync=1 and CmdQue=1 */
108 * Do not include vendor, product, reversion info in INQUIRY
109 * response payload for cdbs with a small allocation length.
111 if (cmd->data_length < 36) {
112 buf[4] = 3; /* Set additional length to 3 */
116 snprintf((unsigned char *)&buf[8], 8, "LIO-ORG");
117 snprintf((unsigned char *)&buf[16], 16, "%s",
118 &dev->se_sub_dev->t10_wwn.model[0]);
119 snprintf((unsigned char *)&buf[32], 4, "%s",
120 &dev->se_sub_dev->t10_wwn.revision[0]);
121 buf[4] = 31; /* Set additional length to 31 */
124 transport_kunmap_first_data_page(cmd);
128 /* unit serial number */
130 target_emulate_evpd_80(struct se_cmd *cmd, unsigned char *buf)
132 struct se_device *dev = cmd->se_dev;
135 if (dev->se_sub_dev->su_dev_flags &
136 SDF_EMULATED_VPD_UNIT_SERIAL) {
140 strlen(&dev->se_sub_dev->t10_wwn.unit_serial[0]);
141 unit_serial_len++; /* For NULL Terminator */
143 if (((len + 4) + unit_serial_len) > cmd->data_length) {
144 len += unit_serial_len;
145 buf[2] = ((len >> 8) & 0xff);
146 buf[3] = (len & 0xff);
149 len += sprintf((unsigned char *)&buf[4], "%s",
150 &dev->se_sub_dev->t10_wwn.unit_serial[0]);
151 len++; /* Extra Byte for NULL Terminator */
158 target_parse_naa_6h_vendor_specific(struct se_device *dev, unsigned char *buf)
160 unsigned char *p = &dev->se_sub_dev->t10_wwn.unit_serial[0];
165 * Generate up to 36 bits of VENDOR SPECIFIC IDENTIFIER starting on
166 * byte 3 bit 3-0 for NAA IEEE Registered Extended DESIGNATOR field
167 * format, followed by 64 bits of VENDOR SPECIFIC IDENTIFIER EXTENSION
168 * to complete the payload. These are based from VPD=0x80 PRODUCT SERIAL
169 * NUMBER set via vpd_unit_serial in target_core_configfs.c to ensure
170 * per device uniqeness.
172 for (cnt = 0; *p && cnt < 13; p++) {
173 int val = hex_to_bin(*p);
189 * Device identification VPD, for a complete list of
190 * DESIGNATOR TYPEs see spc4r17 Table 459.
193 target_emulate_evpd_83(struct se_cmd *cmd, unsigned char *buf)
195 struct se_device *dev = cmd->se_dev;
196 struct se_lun *lun = cmd->se_lun;
197 struct se_port *port = NULL;
198 struct se_portal_group *tpg = NULL;
199 struct t10_alua_lu_gp_member *lu_gp_mem;
200 struct t10_alua_tg_pt_gp *tg_pt_gp;
201 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
202 unsigned char *prod = &dev->se_sub_dev->t10_wwn.model[0];
204 u32 unit_serial_len, off = 0;
210 * NAA IEEE Registered Extended Assigned designator format, see
211 * spc4r17 section 7.7.3.6.5
213 * We depend upon a target_core_mod/ConfigFS provided
214 * /sys/kernel/config/target/core/$HBA/$DEV/wwn/vpd_unit_serial
215 * value in order to return the NAA id.
217 if (!(dev->se_sub_dev->su_dev_flags & SDF_EMULATED_VPD_UNIT_SERIAL))
218 goto check_t10_vend_desc;
220 if (off + 20 > cmd->data_length)
221 goto check_t10_vend_desc;
223 /* CODE SET == Binary */
226 /* Set ASSOCIATION == addressed logical unit: 0)b */
229 /* Identifier/Designator type == NAA identifier */
233 /* Identifier/Designator length */
237 * Start NAA IEEE Registered Extended Identifier/Designator
239 buf[off++] = (0x6 << 4);
242 * Use OpenFabrics IEEE Company ID: 00 14 05
246 buf[off] = (0x5 << 4);
249 * Return ConfigFS Unit Serial Number information for
250 * VENDOR_SPECIFIC_IDENTIFIER and
251 * VENDOR_SPECIFIC_IDENTIFIER_EXTENTION
253 target_parse_naa_6h_vendor_specific(dev, &buf[off]);
260 * T10 Vendor Identifier Page, see spc4r17 section 7.7.3.4
262 id_len = 8; /* For Vendor field */
263 prod_len = 4; /* For VPD Header */
264 prod_len += 8; /* For Vendor field */
265 prod_len += strlen(prod);
266 prod_len++; /* For : */
268 if (dev->se_sub_dev->su_dev_flags &
269 SDF_EMULATED_VPD_UNIT_SERIAL) {
271 strlen(&dev->se_sub_dev->t10_wwn.unit_serial[0]);
272 unit_serial_len++; /* For NULL Terminator */
274 if ((len + (id_len + 4) +
275 (prod_len + unit_serial_len)) >
277 len += (prod_len + unit_serial_len);
280 id_len += sprintf((unsigned char *)&buf[off+12],
282 &dev->se_sub_dev->t10_wwn.unit_serial[0]);
284 buf[off] = 0x2; /* ASCII */
285 buf[off+1] = 0x1; /* T10 Vendor ID */
287 memcpy((unsigned char *)&buf[off+4], "LIO-ORG", 8);
288 /* Extra Byte for NULL Terminator */
290 /* Identifier Length */
292 /* Header size for Designation descriptor */
296 * struct se_port is only set for INQUIRY VPD=1 through $FABRIC_MOD
301 struct t10_alua_lu_gp *lu_gp;
302 u32 padding, scsi_name_len;
309 * Relative target port identifer, see spc4r17
312 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
313 * section 7.5.1 Table 362
315 if (((len + 4) + 8) > cmd->data_length) {
320 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
321 buf[off++] |= 0x1; /* CODE SET == Binary */
322 buf[off] = 0x80; /* Set PIV=1 */
323 /* Set ASSOCIATION == target port: 01b */
325 /* DESIGNATOR TYPE == Relative target port identifer */
327 off++; /* Skip over Reserved */
328 buf[off++] = 4; /* DESIGNATOR LENGTH */
329 /* Skip over Obsolete field in RTPI payload
332 buf[off++] = ((port->sep_rtpi >> 8) & 0xff);
333 buf[off++] = (port->sep_rtpi & 0xff);
334 len += 8; /* Header size + Designation descriptor */
336 * Target port group identifier, see spc4r17
339 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
340 * section 7.5.1 Table 362
343 if (dev->se_sub_dev->t10_alua.alua_type !=
345 goto check_scsi_name;
347 if (((len + 4) + 8) > cmd->data_length) {
351 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
355 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
356 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
358 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
361 tg_pt_gp_id = tg_pt_gp->tg_pt_gp_id;
362 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
365 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
366 buf[off++] |= 0x1; /* CODE SET == Binary */
367 buf[off] = 0x80; /* Set PIV=1 */
368 /* Set ASSOCIATION == target port: 01b */
370 /* DESIGNATOR TYPE == Target port group identifier */
372 off++; /* Skip over Reserved */
373 buf[off++] = 4; /* DESIGNATOR LENGTH */
374 off += 2; /* Skip over Reserved Field */
375 buf[off++] = ((tg_pt_gp_id >> 8) & 0xff);
376 buf[off++] = (tg_pt_gp_id & 0xff);
377 len += 8; /* Header size + Designation descriptor */
379 * Logical Unit Group identifier, see spc4r17
383 if (((len + 4) + 8) > cmd->data_length) {
385 goto check_scsi_name;
387 lu_gp_mem = dev->dev_alua_lu_gp_mem;
389 goto check_scsi_name;
391 spin_lock(&lu_gp_mem->lu_gp_mem_lock);
392 lu_gp = lu_gp_mem->lu_gp;
394 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
395 goto check_scsi_name;
397 lu_gp_id = lu_gp->lu_gp_id;
398 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
400 buf[off++] |= 0x1; /* CODE SET == Binary */
401 /* DESIGNATOR TYPE == Logical Unit Group identifier */
403 off++; /* Skip over Reserved */
404 buf[off++] = 4; /* DESIGNATOR LENGTH */
405 off += 2; /* Skip over Reserved Field */
406 buf[off++] = ((lu_gp_id >> 8) & 0xff);
407 buf[off++] = (lu_gp_id & 0xff);
408 len += 8; /* Header size + Designation descriptor */
410 * SCSI name string designator, see spc4r17
413 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
414 * section 7.5.1 Table 362
417 scsi_name_len = strlen(tpg->se_tpg_tfo->tpg_get_wwn(tpg));
418 /* UTF-8 ",t,0x<16-bit TPGT>" + NULL Terminator */
420 /* Check for 4-byte padding */
421 padding = ((-scsi_name_len) & 3);
423 scsi_name_len += padding;
424 /* Header size + Designation descriptor */
427 if (((len + 4) + scsi_name_len) > cmd->data_length) {
428 len += scsi_name_len;
432 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
433 buf[off++] |= 0x3; /* CODE SET == UTF-8 */
434 buf[off] = 0x80; /* Set PIV=1 */
435 /* Set ASSOCIATION == target port: 01b */
437 /* DESIGNATOR TYPE == SCSI name string */
439 off += 2; /* Skip over Reserved and length */
441 * SCSI name string identifer containing, $FABRIC_MOD
442 * dependent information. For LIO-Target and iSCSI
443 * Target Port, this means "<iSCSI name>,t,0x<TPGT> in
446 tpgt = tpg->se_tpg_tfo->tpg_get_tag(tpg);
447 scsi_name_len = sprintf(&buf[off], "%s,t,0x%04x",
448 tpg->se_tpg_tfo->tpg_get_wwn(tpg), tpgt);
449 scsi_name_len += 1 /* Include NULL terminator */;
451 * The null-terminated, null-padded (see 4.4.2) SCSI
452 * NAME STRING field contains a UTF-8 format string.
453 * The number of bytes in the SCSI NAME STRING field
454 * (i.e., the value in the DESIGNATOR LENGTH field)
455 * shall be no larger than 256 and shall be a multiple
459 scsi_name_len += padding;
461 buf[off-1] = scsi_name_len;
462 off += scsi_name_len;
463 /* Header size + Designation descriptor */
464 len += (scsi_name_len + 4);
467 buf[2] = ((len >> 8) & 0xff);
468 buf[3] = (len & 0xff); /* Page Length for VPD 0x83 */
472 /* Extended INQUIRY Data VPD Page */
474 target_emulate_evpd_86(struct se_cmd *cmd, unsigned char *buf)
476 if (cmd->data_length < 60)
480 /* Set HEADSUP, ORDSUP, SIMPSUP */
483 /* If WriteCache emulation is enabled, set V_SUP */
484 if (cmd->se_dev->se_sub_dev->se_dev_attrib.emulate_write_cache > 0)
489 /* Block Limits VPD page */
491 target_emulate_evpd_b0(struct se_cmd *cmd, unsigned char *buf)
493 struct se_device *dev = cmd->se_dev;
497 * Following sbc3r22 section 6.5.3 Block Limits VPD page, when
498 * emulate_tpu=1 or emulate_tpws=1 we will be expect a
499 * different page length for Thin Provisioning.
501 if (dev->se_sub_dev->se_dev_attrib.emulate_tpu || dev->se_sub_dev->se_dev_attrib.emulate_tpws)
504 if (cmd->data_length < (0x10 + 4)) {
505 pr_debug("Received data_length: %u"
506 " too small for EVPD 0xb0\n",
511 if (have_tp && cmd->data_length < (0x3c + 4)) {
512 pr_debug("Received data_length: %u"
513 " too small for TPE=1 EVPD 0xb0\n",
518 buf[0] = dev->transport->get_device_type(dev);
519 buf[3] = have_tp ? 0x3c : 0x10;
525 * Set OPTIMAL TRANSFER LENGTH GRANULARITY
527 put_unaligned_be16(1, &buf[6]);
530 * Set MAXIMUM TRANSFER LENGTH
532 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.max_sectors, &buf[8]);
535 * Set OPTIMAL TRANSFER LENGTH
537 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.optimal_sectors, &buf[12]);
540 * Exit now if we don't support TP or the initiator sent a too
543 if (!have_tp || cmd->data_length < (0x3c + 4))
547 * Set MAXIMUM UNMAP LBA COUNT
549 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.max_unmap_lba_count, &buf[20]);
552 * Set MAXIMUM UNMAP BLOCK DESCRIPTOR COUNT
554 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.max_unmap_block_desc_count,
558 * Set OPTIMAL UNMAP GRANULARITY
560 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.unmap_granularity, &buf[28]);
563 * UNMAP GRANULARITY ALIGNMENT
565 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.unmap_granularity_alignment,
567 if (dev->se_sub_dev->se_dev_attrib.unmap_granularity_alignment != 0)
568 buf[32] |= 0x80; /* Set the UGAVALID bit */
573 /* Block Device Characteristics VPD page */
575 target_emulate_evpd_b1(struct se_cmd *cmd, unsigned char *buf)
577 struct se_device *dev = cmd->se_dev;
579 buf[0] = dev->transport->get_device_type(dev);
582 if (cmd->data_length >= 5 &&
583 dev->se_sub_dev->se_dev_attrib.is_nonrot)
589 /* Thin Provisioning VPD */
591 target_emulate_evpd_b2(struct se_cmd *cmd, unsigned char *buf)
593 struct se_device *dev = cmd->se_dev;
596 * From sbc3r22 section 6.5.4 Thin Provisioning VPD page:
598 * The PAGE LENGTH field is defined in SPC-4. If the DP bit is set to
599 * zero, then the page length shall be set to 0004h. If the DP bit
600 * is set to one, then the page length shall be set to the value
601 * defined in table 162.
603 buf[0] = dev->transport->get_device_type(dev);
606 * Set Hardcoded length mentioned above for DP=0
608 put_unaligned_be16(0x0004, &buf[2]);
611 * The THRESHOLD EXPONENT field indicates the threshold set size in
612 * LBAs as a power of 2 (i.e., the threshold set size is equal to
613 * 2(threshold exponent)).
615 * Note that this is currently set to 0x00 as mkp says it will be
616 * changing again. We can enable this once it has settled in T10
617 * and is actually used by Linux/SCSI ML code.
622 * A TPU bit set to one indicates that the device server supports
623 * the UNMAP command (see 5.25). A TPU bit set to zero indicates
624 * that the device server does not support the UNMAP command.
626 if (dev->se_sub_dev->se_dev_attrib.emulate_tpu != 0)
630 * A TPWS bit set to one indicates that the device server supports
631 * the use of the WRITE SAME (16) command (see 5.42) to unmap LBAs.
632 * A TPWS bit set to zero indicates that the device server does not
633 * support the use of the WRITE SAME (16) command to unmap LBAs.
635 if (dev->se_sub_dev->se_dev_attrib.emulate_tpws != 0)
642 target_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf);
646 int (*emulate)(struct se_cmd *, unsigned char *);
647 } evpd_handlers[] = {
648 { .page = 0x00, .emulate = target_emulate_evpd_00 },
649 { .page = 0x80, .emulate = target_emulate_evpd_80 },
650 { .page = 0x83, .emulate = target_emulate_evpd_83 },
651 { .page = 0x86, .emulate = target_emulate_evpd_86 },
652 { .page = 0xb0, .emulate = target_emulate_evpd_b0 },
653 { .page = 0xb1, .emulate = target_emulate_evpd_b1 },
654 { .page = 0xb2, .emulate = target_emulate_evpd_b2 },
657 /* supported vital product data pages */
659 target_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf)
663 if (cmd->data_length < 8)
666 * Only report the INQUIRY EVPD=1 pages after a valid NAA
667 * Registered Extended LUN WWN has been set via ConfigFS
668 * during device creation/restart.
670 if (cmd->se_dev->se_sub_dev->su_dev_flags &
671 SDF_EMULATED_VPD_UNIT_SERIAL) {
672 buf[3] = ARRAY_SIZE(evpd_handlers);
673 for (p = 0; p < min_t(int, ARRAY_SIZE(evpd_handlers),
674 cmd->data_length - 4); ++p)
675 buf[p + 4] = evpd_handlers[p].page;
682 target_emulate_inquiry(struct se_cmd *cmd)
684 struct se_device *dev = cmd->se_dev;
686 unsigned char *cdb = cmd->t_task_cdb;
690 return target_emulate_inquiry_std(cmd);
693 * Make sure we at least have 4 bytes of INQUIRY response
694 * payload for 0x00 going back for EVPD=1. Note that 0x80
695 * and 0x83 will check for enough payload data length and
696 * jump to set_len: label when there is not enough inquiry EVPD
697 * payload length left for the next outgoing EVPD metadata
699 if (cmd->data_length < 4) {
700 pr_err("SCSI Inquiry payload length: %u"
701 " too small for EVPD=1\n", cmd->data_length);
705 buf = transport_kmap_first_data_page(cmd);
707 buf[0] = dev->transport->get_device_type(dev);
709 for (p = 0; p < ARRAY_SIZE(evpd_handlers); ++p)
710 if (cdb[2] == evpd_handlers[p].page) {
712 ret = evpd_handlers[p].emulate(cmd, buf);
713 transport_kunmap_first_data_page(cmd);
717 transport_kunmap_first_data_page(cmd);
718 pr_err("Unknown VPD Code: 0x%02x\n", cdb[2]);
723 target_emulate_readcapacity(struct se_cmd *cmd)
725 struct se_device *dev = cmd->se_dev;
727 unsigned long long blocks_long = dev->transport->get_blocks(dev);
730 if (blocks_long >= 0x00000000ffffffff)
733 blocks = (u32)blocks_long;
735 buf = transport_kmap_first_data_page(cmd);
737 buf[0] = (blocks >> 24) & 0xff;
738 buf[1] = (blocks >> 16) & 0xff;
739 buf[2] = (blocks >> 8) & 0xff;
740 buf[3] = blocks & 0xff;
741 buf[4] = (dev->se_sub_dev->se_dev_attrib.block_size >> 24) & 0xff;
742 buf[5] = (dev->se_sub_dev->se_dev_attrib.block_size >> 16) & 0xff;
743 buf[6] = (dev->se_sub_dev->se_dev_attrib.block_size >> 8) & 0xff;
744 buf[7] = dev->se_sub_dev->se_dev_attrib.block_size & 0xff;
746 * Set max 32-bit blocks to signal SERVICE ACTION READ_CAPACITY_16
748 if (dev->se_sub_dev->se_dev_attrib.emulate_tpu || dev->se_sub_dev->se_dev_attrib.emulate_tpws)
749 put_unaligned_be32(0xFFFFFFFF, &buf[0]);
751 transport_kunmap_first_data_page(cmd);
757 target_emulate_readcapacity_16(struct se_cmd *cmd)
759 struct se_device *dev = cmd->se_dev;
761 unsigned long long blocks = dev->transport->get_blocks(dev);
763 buf = transport_kmap_first_data_page(cmd);
765 buf[0] = (blocks >> 56) & 0xff;
766 buf[1] = (blocks >> 48) & 0xff;
767 buf[2] = (blocks >> 40) & 0xff;
768 buf[3] = (blocks >> 32) & 0xff;
769 buf[4] = (blocks >> 24) & 0xff;
770 buf[5] = (blocks >> 16) & 0xff;
771 buf[6] = (blocks >> 8) & 0xff;
772 buf[7] = blocks & 0xff;
773 buf[8] = (dev->se_sub_dev->se_dev_attrib.block_size >> 24) & 0xff;
774 buf[9] = (dev->se_sub_dev->se_dev_attrib.block_size >> 16) & 0xff;
775 buf[10] = (dev->se_sub_dev->se_dev_attrib.block_size >> 8) & 0xff;
776 buf[11] = dev->se_sub_dev->se_dev_attrib.block_size & 0xff;
778 * Set Thin Provisioning Enable bit following sbc3r22 in section
779 * READ CAPACITY (16) byte 14 if emulate_tpu or emulate_tpws is enabled.
781 if (dev->se_sub_dev->se_dev_attrib.emulate_tpu || dev->se_sub_dev->se_dev_attrib.emulate_tpws)
784 transport_kunmap_first_data_page(cmd);
790 target_modesense_rwrecovery(unsigned char *p)
799 target_modesense_control(struct se_device *dev, unsigned char *p)
805 * From spc4r23, 7.4.7 Control mode page
807 * The QUEUE ALGORITHM MODIFIER field (see table 368) specifies
808 * restrictions on the algorithm used for reordering commands
809 * having the SIMPLE task attribute (see SAM-4).
811 * Table 368 -- QUEUE ALGORITHM MODIFIER field
813 * 0h Restricted reordering
814 * 1h Unrestricted reordering allowed
816 * 8h to Fh Vendor specific
818 * A value of zero in the QUEUE ALGORITHM MODIFIER field specifies that
819 * the device server shall order the processing sequence of commands
820 * having the SIMPLE task attribute such that data integrity is maintained
821 * for that I_T nexus (i.e., if the transmission of new SCSI transport protocol
822 * requests is halted at any time, the final value of all data observable
823 * on the medium shall be the same as if all the commands had been processed
824 * with the ORDERED task attribute).
826 * A value of one in the QUEUE ALGORITHM MODIFIER field specifies that the
827 * device server may reorder the processing sequence of commands having the
828 * SIMPLE task attribute in any manner. Any data integrity exposures related to
829 * command sequence order shall be explicitly handled by the application client
830 * through the selection of appropriate ommands and task attributes.
832 p[3] = (dev->se_sub_dev->se_dev_attrib.emulate_rest_reord == 1) ? 0x00 : 0x10;
834 * From spc4r17, section 7.4.6 Control mode Page
836 * Unit Attention interlocks control (UN_INTLCK_CTRL) to code 00b
838 * 00b: The logical unit shall clear any unit attention condition
839 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
840 * status and shall not establish a unit attention condition when a com-
841 * mand is completed with BUSY, TASK SET FULL, or RESERVATION CONFLICT
844 * 10b: The logical unit shall not clear any unit attention condition
845 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
846 * status and shall not establish a unit attention condition when
847 * a command is completed with BUSY, TASK SET FULL, or RESERVATION
850 * 11b a The logical unit shall not clear any unit attention condition
851 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
852 * status and shall establish a unit attention condition for the
853 * initiator port associated with the I_T nexus on which the BUSY,
854 * TASK SET FULL, or RESERVATION CONFLICT status is being returned.
855 * Depending on the status, the additional sense code shall be set to
856 * PREVIOUS BUSY STATUS, PREVIOUS TASK SET FULL STATUS, or PREVIOUS
857 * RESERVATION CONFLICT STATUS. Until it is cleared by a REQUEST SENSE
858 * command, a unit attention condition shall be established only once
859 * for a BUSY, TASK SET FULL, or RESERVATION CONFLICT status regardless
860 * to the number of commands completed with one of those status codes.
862 p[4] = (dev->se_sub_dev->se_dev_attrib.emulate_ua_intlck_ctrl == 2) ? 0x30 :
863 (dev->se_sub_dev->se_dev_attrib.emulate_ua_intlck_ctrl == 1) ? 0x20 : 0x00;
865 * From spc4r17, section 7.4.6 Control mode Page
867 * Task Aborted Status (TAS) bit set to zero.
869 * A task aborted status (TAS) bit set to zero specifies that aborted
870 * tasks shall be terminated by the device server without any response
871 * to the application client. A TAS bit set to one specifies that tasks
872 * aborted by the actions of an I_T nexus other than the I_T nexus on
873 * which the command was received shall be completed with TASK ABORTED
874 * status (see SAM-4).
876 p[5] = (dev->se_sub_dev->se_dev_attrib.emulate_tas) ? 0x40 : 0x00;
885 target_modesense_caching(struct se_device *dev, unsigned char *p)
889 if (dev->se_sub_dev->se_dev_attrib.emulate_write_cache > 0)
890 p[2] = 0x04; /* Write Cache Enable */
891 p[12] = 0x20; /* Disabled Read Ahead */
897 target_modesense_write_protect(unsigned char *buf, int type)
900 * I believe that the WP bit (bit 7) in the mode header is the same for
907 buf[0] |= 0x80; /* WP bit */
913 target_modesense_dpofua(unsigned char *buf, int type)
917 buf[0] |= 0x10; /* DPOFUA bit */
925 target_emulate_modesense(struct se_cmd *cmd, int ten)
927 struct se_device *dev = cmd->se_dev;
928 char *cdb = cmd->t_task_cdb;
930 int type = dev->transport->get_device_type(dev);
931 int offset = (ten) ? 8 : 4;
933 unsigned char buf[SE_MODE_PAGE_BUF];
935 memset(buf, 0, SE_MODE_PAGE_BUF);
937 switch (cdb[2] & 0x3f) {
939 length = target_modesense_rwrecovery(&buf[offset]);
942 length = target_modesense_caching(dev, &buf[offset]);
945 length = target_modesense_control(dev, &buf[offset]);
948 length = target_modesense_rwrecovery(&buf[offset]);
949 length += target_modesense_caching(dev, &buf[offset+length]);
950 length += target_modesense_control(dev, &buf[offset+length]);
953 pr_err("MODE SENSE: unimplemented page/subpage: 0x%02x/0x%02x\n",
954 cdb[2] & 0x3f, cdb[3]);
955 return PYX_TRANSPORT_UNKNOWN_MODE_PAGE;
961 buf[0] = (offset >> 8) & 0xff;
962 buf[1] = offset & 0xff;
964 if ((cmd->se_lun->lun_access & TRANSPORT_LUNFLAGS_READ_ONLY) ||
966 (cmd->se_deve->lun_flags & TRANSPORT_LUNFLAGS_READ_ONLY)))
967 target_modesense_write_protect(&buf[3], type);
969 if ((dev->se_sub_dev->se_dev_attrib.emulate_write_cache > 0) &&
970 (dev->se_sub_dev->se_dev_attrib.emulate_fua_write > 0))
971 target_modesense_dpofua(&buf[3], type);
973 if ((offset + 2) > cmd->data_length)
974 offset = cmd->data_length;
978 buf[0] = offset & 0xff;
980 if ((cmd->se_lun->lun_access & TRANSPORT_LUNFLAGS_READ_ONLY) ||
982 (cmd->se_deve->lun_flags & TRANSPORT_LUNFLAGS_READ_ONLY)))
983 target_modesense_write_protect(&buf[2], type);
985 if ((dev->se_sub_dev->se_dev_attrib.emulate_write_cache > 0) &&
986 (dev->se_sub_dev->se_dev_attrib.emulate_fua_write > 0))
987 target_modesense_dpofua(&buf[2], type);
989 if ((offset + 1) > cmd->data_length)
990 offset = cmd->data_length;
993 rbuf = transport_kmap_first_data_page(cmd);
994 memcpy(rbuf, buf, offset);
995 transport_kunmap_first_data_page(cmd);
1001 target_emulate_request_sense(struct se_cmd *cmd)
1003 unsigned char *cdb = cmd->t_task_cdb;
1005 u8 ua_asc = 0, ua_ascq = 0;
1008 if (cdb[1] & 0x01) {
1009 pr_err("REQUEST_SENSE description emulation not"
1011 return PYX_TRANSPORT_INVALID_CDB_FIELD;
1014 buf = transport_kmap_first_data_page(cmd);
1016 if (!core_scsi3_ua_clear_for_request_sense(cmd, &ua_asc, &ua_ascq)) {
1018 * CURRENT ERROR, UNIT ATTENTION
1021 buf[SPC_SENSE_KEY_OFFSET] = UNIT_ATTENTION;
1023 * Make sure request data length is enough for additional
1026 if (cmd->data_length <= 18) {
1032 * The Additional Sense Code (ASC) from the UNIT ATTENTION
1034 buf[SPC_ASC_KEY_OFFSET] = ua_asc;
1035 buf[SPC_ASCQ_KEY_OFFSET] = ua_ascq;
1039 * CURRENT ERROR, NO SENSE
1042 buf[SPC_SENSE_KEY_OFFSET] = NO_SENSE;
1044 * Make sure request data length is enough for additional
1047 if (cmd->data_length <= 18) {
1053 * NO ADDITIONAL SENSE INFORMATION
1055 buf[SPC_ASC_KEY_OFFSET] = 0x00;
1060 transport_kunmap_first_data_page(cmd);
1066 * Used for TCM/IBLOCK and TCM/FILEIO for block/blk-lib.c level discard support.
1067 * Note this is not used for TCM/pSCSI passthrough
1070 target_emulate_unmap(struct se_task *task)
1072 struct se_cmd *cmd = task->task_se_cmd;
1073 struct se_device *dev = cmd->se_dev;
1074 unsigned char *buf, *ptr = NULL;
1075 unsigned char *cdb = &cmd->t_task_cdb[0];
1077 unsigned int size = cmd->data_length, range;
1078 int ret = 0, offset;
1079 unsigned short dl, bd_dl;
1081 /* First UNMAP block descriptor starts at 8 byte offset */
1084 dl = get_unaligned_be16(&cdb[0]);
1085 bd_dl = get_unaligned_be16(&cdb[2]);
1087 buf = transport_kmap_first_data_page(cmd);
1090 pr_debug("UNMAP: Sub: %s Using dl: %hu bd_dl: %hu size: %hu"
1091 " ptr: %p\n", dev->transport->name, dl, bd_dl, size, ptr);
1094 lba = get_unaligned_be64(&ptr[0]);
1095 range = get_unaligned_be32(&ptr[8]);
1096 pr_debug("UNMAP: Using lba: %llu and range: %u\n",
1097 (unsigned long long)lba, range);
1099 ret = dev->transport->do_discard(dev, lba, range);
1101 pr_err("blkdev_issue_discard() failed: %d\n",
1111 transport_kunmap_first_data_page(cmd);
1117 * Used for TCM/IBLOCK and TCM/FILEIO for block/blk-lib.c level discard support.
1118 * Note this is not used for TCM/pSCSI passthrough
1121 target_emulate_write_same(struct se_task *task, u32 num_blocks)
1123 struct se_cmd *cmd = task->task_se_cmd;
1124 struct se_device *dev = cmd->se_dev;
1126 sector_t lba = cmd->t_task_lba;
1129 * Use the explicit range when non zero is supplied, otherwise calculate
1130 * the remaining range based on ->get_blocks() - starting LBA.
1132 if (num_blocks != 0)
1135 range = (dev->transport->get_blocks(dev) - lba);
1137 pr_debug("WRITE_SAME UNMAP: LBA: %llu Range: %llu\n",
1138 (unsigned long long)lba, (unsigned long long)range);
1140 ret = dev->transport->do_discard(dev, lba, range);
1142 pr_debug("blkdev_issue_discard() failed for WRITE_SAME\n");
1150 transport_emulate_control_cdb(struct se_task *task)
1152 struct se_cmd *cmd = task->task_se_cmd;
1153 struct se_device *dev = cmd->se_dev;
1154 unsigned short service_action;
1157 switch (cmd->t_task_cdb[0]) {
1159 ret = target_emulate_inquiry(cmd);
1162 ret = target_emulate_readcapacity(cmd);
1165 ret = target_emulate_modesense(cmd, 0);
1168 ret = target_emulate_modesense(cmd, 1);
1170 case SERVICE_ACTION_IN:
1171 switch (cmd->t_task_cdb[1] & 0x1f) {
1172 case SAI_READ_CAPACITY_16:
1173 ret = target_emulate_readcapacity_16(cmd);
1176 pr_err("Unsupported SA: 0x%02x\n",
1177 cmd->t_task_cdb[1] & 0x1f);
1178 return PYX_TRANSPORT_UNKNOWN_SAM_OPCODE;
1182 ret = target_emulate_request_sense(cmd);
1185 if (!dev->transport->do_discard) {
1186 pr_err("UNMAP emulation not supported for: %s\n",
1187 dev->transport->name);
1188 return PYX_TRANSPORT_UNKNOWN_SAM_OPCODE;
1190 ret = target_emulate_unmap(task);
1193 if (!dev->transport->do_discard) {
1194 pr_err("WRITE_SAME emulation not supported"
1195 " for: %s\n", dev->transport->name);
1196 return PYX_TRANSPORT_UNKNOWN_SAM_OPCODE;
1198 ret = target_emulate_write_same(task,
1199 get_unaligned_be16(&cmd->t_task_cdb[7]));
1202 if (!dev->transport->do_discard) {
1203 pr_err("WRITE_SAME_16 emulation not supported"
1204 " for: %s\n", dev->transport->name);
1205 return PYX_TRANSPORT_UNKNOWN_SAM_OPCODE;
1207 ret = target_emulate_write_same(task,
1208 get_unaligned_be32(&cmd->t_task_cdb[10]));
1210 case VARIABLE_LENGTH_CMD:
1212 get_unaligned_be16(&cmd->t_task_cdb[8]);
1213 switch (service_action) {
1215 if (!dev->transport->do_discard) {
1216 pr_err("WRITE_SAME_32 SA emulation not"
1217 " supported for: %s\n",
1218 dev->transport->name);
1219 return PYX_TRANSPORT_UNKNOWN_SAM_OPCODE;
1221 ret = target_emulate_write_same(task,
1222 get_unaligned_be32(&cmd->t_task_cdb[28]));
1225 pr_err("Unsupported VARIABLE_LENGTH_CMD SA:"
1226 " 0x%02x\n", service_action);
1230 case SYNCHRONIZE_CACHE:
1231 case 0x91: /* SYNCHRONIZE_CACHE_16: */
1232 if (!dev->transport->do_sync_cache) {
1233 pr_err("SYNCHRONIZE_CACHE emulation not supported"
1234 " for: %s\n", dev->transport->name);
1235 return PYX_TRANSPORT_UNKNOWN_SAM_OPCODE;
1237 dev->transport->do_sync_cache(task);
1239 case ALLOW_MEDIUM_REMOVAL:
1245 case TEST_UNIT_READY:
1247 case WRITE_FILEMARKS:
1250 pr_err("Unsupported SCSI Opcode: 0x%02x for %s\n",
1251 cmd->t_task_cdb[0], dev->transport->name);
1252 return PYX_TRANSPORT_UNKNOWN_SAM_OPCODE;
1258 * Handle the successful completion here unless a caller
1259 * has explictly requested an asychronous completion.
1261 if (!(cmd->se_cmd_flags & SCF_EMULATE_CDB_ASYNC)) {
1262 task->task_scsi_status = GOOD;
1263 transport_complete_task(task, 1);
1266 return PYX_TRANSPORT_SENT_TO_TRANSPORT;
1270 * Write a CDB into @cdb that is based on the one the intiator sent us,
1271 * but updated to only cover the sectors that the current task handles.
1273 void target_get_task_cdb(struct se_task *task, unsigned char *cdb)
1275 struct se_cmd *cmd = task->task_se_cmd;
1277 memcpy(cdb, cmd->t_task_cdb, scsi_command_size(cmd->t_task_cdb));
1278 if (cmd->se_cmd_flags & SCF_SCSI_DATA_SG_IO_CDB) {
1279 cmd->transport_split_cdb(task->task_lba, task->task_sectors,
1283 EXPORT_SYMBOL(target_get_task_cdb);