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, char *buf)
71 struct se_lun *lun = cmd->se_lun;
72 struct se_device *dev = cmd->se_dev;
74 /* Set RMB (removable media) for tape devices */
75 if (dev->transport->get_device_type(dev) == TYPE_TAPE)
78 buf[2] = dev->transport->get_device_rev(dev);
81 * NORMACA and HISUP = 0, RESPONSE DATA FORMAT = 2
84 * A RESPONSE DATA FORMAT field set to 2h indicates that the
85 * standard INQUIRY data is in the format defined in this
86 * standard. Response data format values less than 2h are
87 * obsolete. Response data format values greater than 2h are
93 * Enable SCCS and TPGS fields for Emulated ALUA
95 if (dev->se_sub_dev->t10_alua.alua_type == SPC3_ALUA_EMULATED)
96 target_fill_alua_data(lun->lun_sep, buf);
98 buf[7] = 0x2; /* CmdQue=1 */
100 snprintf(&buf[8], 8, "LIO-ORG");
101 snprintf(&buf[16], 16, "%s", dev->se_sub_dev->t10_wwn.model);
102 snprintf(&buf[32], 4, "%s", dev->se_sub_dev->t10_wwn.revision);
103 buf[4] = 31; /* Set additional length to 31 */
108 /* unit serial number */
110 target_emulate_evpd_80(struct se_cmd *cmd, unsigned char *buf)
112 struct se_device *dev = cmd->se_dev;
115 if (dev->se_sub_dev->su_dev_flags &
116 SDF_EMULATED_VPD_UNIT_SERIAL) {
119 unit_serial_len = strlen(dev->se_sub_dev->t10_wwn.unit_serial);
120 unit_serial_len++; /* For NULL Terminator */
122 len += sprintf(&buf[4], "%s",
123 dev->se_sub_dev->t10_wwn.unit_serial);
124 len++; /* Extra Byte for NULL Terminator */
131 target_parse_naa_6h_vendor_specific(struct se_device *dev, unsigned char *buf)
133 unsigned char *p = &dev->se_sub_dev->t10_wwn.unit_serial[0];
138 * Generate up to 36 bits of VENDOR SPECIFIC IDENTIFIER starting on
139 * byte 3 bit 3-0 for NAA IEEE Registered Extended DESIGNATOR field
140 * format, followed by 64 bits of VENDOR SPECIFIC IDENTIFIER EXTENSION
141 * to complete the payload. These are based from VPD=0x80 PRODUCT SERIAL
142 * NUMBER set via vpd_unit_serial in target_core_configfs.c to ensure
143 * per device uniqeness.
145 for (cnt = 0; *p && cnt < 13; p++) {
146 int val = hex_to_bin(*p);
162 * Device identification VPD, for a complete list of
163 * DESIGNATOR TYPEs see spc4r17 Table 459.
166 target_emulate_evpd_83(struct se_cmd *cmd, unsigned char *buf)
168 struct se_device *dev = cmd->se_dev;
169 struct se_lun *lun = cmd->se_lun;
170 struct se_port *port = NULL;
171 struct se_portal_group *tpg = NULL;
172 struct t10_alua_lu_gp_member *lu_gp_mem;
173 struct t10_alua_tg_pt_gp *tg_pt_gp;
174 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
175 unsigned char *prod = &dev->se_sub_dev->t10_wwn.model[0];
177 u32 unit_serial_len, off = 0;
183 * NAA IEEE Registered Extended Assigned designator format, see
184 * spc4r17 section 7.7.3.6.5
186 * We depend upon a target_core_mod/ConfigFS provided
187 * /sys/kernel/config/target/core/$HBA/$DEV/wwn/vpd_unit_serial
188 * value in order to return the NAA id.
190 if (!(dev->se_sub_dev->su_dev_flags & SDF_EMULATED_VPD_UNIT_SERIAL))
191 goto check_t10_vend_desc;
193 /* CODE SET == Binary */
196 /* Set ASSOCIATION == addressed logical unit: 0)b */
199 /* Identifier/Designator type == NAA identifier */
203 /* Identifier/Designator length */
207 * Start NAA IEEE Registered Extended Identifier/Designator
209 buf[off++] = (0x6 << 4);
212 * Use OpenFabrics IEEE Company ID: 00 14 05
216 buf[off] = (0x5 << 4);
219 * Return ConfigFS Unit Serial Number information for
220 * VENDOR_SPECIFIC_IDENTIFIER and
221 * VENDOR_SPECIFIC_IDENTIFIER_EXTENTION
223 target_parse_naa_6h_vendor_specific(dev, &buf[off]);
230 * T10 Vendor Identifier Page, see spc4r17 section 7.7.3.4
232 id_len = 8; /* For Vendor field */
233 prod_len = 4; /* For VPD Header */
234 prod_len += 8; /* For Vendor field */
235 prod_len += strlen(prod);
236 prod_len++; /* For : */
238 if (dev->se_sub_dev->su_dev_flags &
239 SDF_EMULATED_VPD_UNIT_SERIAL) {
241 strlen(&dev->se_sub_dev->t10_wwn.unit_serial[0]);
242 unit_serial_len++; /* For NULL Terminator */
244 id_len += sprintf(&buf[off+12], "%s:%s", prod,
245 &dev->se_sub_dev->t10_wwn.unit_serial[0]);
247 buf[off] = 0x2; /* ASCII */
248 buf[off+1] = 0x1; /* T10 Vendor ID */
250 memcpy(&buf[off+4], "LIO-ORG", 8);
251 /* Extra Byte for NULL Terminator */
253 /* Identifier Length */
255 /* Header size for Designation descriptor */
259 * struct se_port is only set for INQUIRY VPD=1 through $FABRIC_MOD
263 struct t10_alua_lu_gp *lu_gp;
264 u32 padding, scsi_name_len;
271 * Relative target port identifer, see spc4r17
274 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
275 * section 7.5.1 Table 362
278 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
279 buf[off++] |= 0x1; /* CODE SET == Binary */
280 buf[off] = 0x80; /* Set PIV=1 */
281 /* Set ASSOCIATION == target port: 01b */
283 /* DESIGNATOR TYPE == Relative target port identifer */
285 off++; /* Skip over Reserved */
286 buf[off++] = 4; /* DESIGNATOR LENGTH */
287 /* Skip over Obsolete field in RTPI payload
290 buf[off++] = ((port->sep_rtpi >> 8) & 0xff);
291 buf[off++] = (port->sep_rtpi & 0xff);
292 len += 8; /* Header size + Designation descriptor */
294 * Target port group identifier, see spc4r17
297 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
298 * section 7.5.1 Table 362
300 if (dev->se_sub_dev->t10_alua.alua_type !=
302 goto check_scsi_name;
304 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
308 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
309 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
311 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
314 tg_pt_gp_id = tg_pt_gp->tg_pt_gp_id;
315 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
318 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
319 buf[off++] |= 0x1; /* CODE SET == Binary */
320 buf[off] = 0x80; /* Set PIV=1 */
321 /* Set ASSOCIATION == target port: 01b */
323 /* DESIGNATOR TYPE == Target port group identifier */
325 off++; /* Skip over Reserved */
326 buf[off++] = 4; /* DESIGNATOR LENGTH */
327 off += 2; /* Skip over Reserved Field */
328 buf[off++] = ((tg_pt_gp_id >> 8) & 0xff);
329 buf[off++] = (tg_pt_gp_id & 0xff);
330 len += 8; /* Header size + Designation descriptor */
332 * Logical Unit Group identifier, see spc4r17
336 lu_gp_mem = dev->dev_alua_lu_gp_mem;
338 goto check_scsi_name;
340 spin_lock(&lu_gp_mem->lu_gp_mem_lock);
341 lu_gp = lu_gp_mem->lu_gp;
343 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
344 goto check_scsi_name;
346 lu_gp_id = lu_gp->lu_gp_id;
347 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
349 buf[off++] |= 0x1; /* CODE SET == Binary */
350 /* DESIGNATOR TYPE == Logical Unit Group identifier */
352 off++; /* Skip over Reserved */
353 buf[off++] = 4; /* DESIGNATOR LENGTH */
354 off += 2; /* Skip over Reserved Field */
355 buf[off++] = ((lu_gp_id >> 8) & 0xff);
356 buf[off++] = (lu_gp_id & 0xff);
357 len += 8; /* Header size + Designation descriptor */
359 * SCSI name string designator, see spc4r17
362 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
363 * section 7.5.1 Table 362
366 scsi_name_len = strlen(tpg->se_tpg_tfo->tpg_get_wwn(tpg));
367 /* UTF-8 ",t,0x<16-bit TPGT>" + NULL Terminator */
369 /* Check for 4-byte padding */
370 padding = ((-scsi_name_len) & 3);
372 scsi_name_len += padding;
373 /* Header size + Designation descriptor */
377 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
378 buf[off++] |= 0x3; /* CODE SET == UTF-8 */
379 buf[off] = 0x80; /* Set PIV=1 */
380 /* Set ASSOCIATION == target port: 01b */
382 /* DESIGNATOR TYPE == SCSI name string */
384 off += 2; /* Skip over Reserved and length */
386 * SCSI name string identifer containing, $FABRIC_MOD
387 * dependent information. For LIO-Target and iSCSI
388 * Target Port, this means "<iSCSI name>,t,0x<TPGT> in
391 tpgt = tpg->se_tpg_tfo->tpg_get_tag(tpg);
392 scsi_name_len = sprintf(&buf[off], "%s,t,0x%04x",
393 tpg->se_tpg_tfo->tpg_get_wwn(tpg), tpgt);
394 scsi_name_len += 1 /* Include NULL terminator */;
396 * The null-terminated, null-padded (see 4.4.2) SCSI
397 * NAME STRING field contains a UTF-8 format string.
398 * The number of bytes in the SCSI NAME STRING field
399 * (i.e., the value in the DESIGNATOR LENGTH field)
400 * shall be no larger than 256 and shall be a multiple
404 scsi_name_len += padding;
406 buf[off-1] = scsi_name_len;
407 off += scsi_name_len;
408 /* Header size + Designation descriptor */
409 len += (scsi_name_len + 4);
411 buf[2] = ((len >> 8) & 0xff);
412 buf[3] = (len & 0xff); /* Page Length for VPD 0x83 */
416 /* Extended INQUIRY Data VPD Page */
418 target_emulate_evpd_86(struct se_cmd *cmd, unsigned char *buf)
421 /* Set HEADSUP, ORDSUP, SIMPSUP */
424 /* If WriteCache emulation is enabled, set V_SUP */
425 if (cmd->se_dev->se_sub_dev->se_dev_attrib.emulate_write_cache > 0)
430 /* Block Limits VPD page */
432 target_emulate_evpd_b0(struct se_cmd *cmd, unsigned char *buf)
434 struct se_device *dev = cmd->se_dev;
438 * Following sbc3r22 section 6.5.3 Block Limits VPD page, when
439 * emulate_tpu=1 or emulate_tpws=1 we will be expect a
440 * different page length for Thin Provisioning.
442 if (dev->se_sub_dev->se_dev_attrib.emulate_tpu || dev->se_sub_dev->se_dev_attrib.emulate_tpws)
445 buf[0] = dev->transport->get_device_type(dev);
446 buf[3] = have_tp ? 0x3c : 0x10;
452 * Set OPTIMAL TRANSFER LENGTH GRANULARITY
454 put_unaligned_be16(1, &buf[6]);
457 * Set MAXIMUM TRANSFER LENGTH
459 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.fabric_max_sectors, &buf[8]);
462 * Set OPTIMAL TRANSFER LENGTH
464 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.optimal_sectors, &buf[12]);
467 * Exit now if we don't support TP.
473 * Set MAXIMUM UNMAP LBA COUNT
475 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.max_unmap_lba_count, &buf[20]);
478 * Set MAXIMUM UNMAP BLOCK DESCRIPTOR COUNT
480 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.max_unmap_block_desc_count,
484 * Set OPTIMAL UNMAP GRANULARITY
486 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.unmap_granularity, &buf[28]);
489 * UNMAP GRANULARITY ALIGNMENT
491 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.unmap_granularity_alignment,
493 if (dev->se_sub_dev->se_dev_attrib.unmap_granularity_alignment != 0)
494 buf[32] |= 0x80; /* Set the UGAVALID bit */
499 /* Block Device Characteristics VPD page */
501 target_emulate_evpd_b1(struct se_cmd *cmd, unsigned char *buf)
503 struct se_device *dev = cmd->se_dev;
505 buf[0] = dev->transport->get_device_type(dev);
507 buf[5] = dev->se_sub_dev->se_dev_attrib.is_nonrot ? 1 : 0;
512 /* Thin Provisioning VPD */
514 target_emulate_evpd_b2(struct se_cmd *cmd, unsigned char *buf)
516 struct se_device *dev = cmd->se_dev;
519 * From sbc3r22 section 6.5.4 Thin Provisioning VPD page:
521 * The PAGE LENGTH field is defined in SPC-4. If the DP bit is set to
522 * zero, then the page length shall be set to 0004h. If the DP bit
523 * is set to one, then the page length shall be set to the value
524 * defined in table 162.
526 buf[0] = dev->transport->get_device_type(dev);
529 * Set Hardcoded length mentioned above for DP=0
531 put_unaligned_be16(0x0004, &buf[2]);
534 * The THRESHOLD EXPONENT field indicates the threshold set size in
535 * LBAs as a power of 2 (i.e., the threshold set size is equal to
536 * 2(threshold exponent)).
538 * Note that this is currently set to 0x00 as mkp says it will be
539 * changing again. We can enable this once it has settled in T10
540 * and is actually used by Linux/SCSI ML code.
545 * A TPU bit set to one indicates that the device server supports
546 * the UNMAP command (see 5.25). A TPU bit set to zero indicates
547 * that the device server does not support the UNMAP command.
549 if (dev->se_sub_dev->se_dev_attrib.emulate_tpu != 0)
553 * A TPWS bit set to one indicates that the device server supports
554 * the use of the WRITE SAME (16) command (see 5.42) to unmap LBAs.
555 * A TPWS bit set to zero indicates that the device server does not
556 * support the use of the WRITE SAME (16) command to unmap LBAs.
558 if (dev->se_sub_dev->se_dev_attrib.emulate_tpws != 0)
565 target_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf);
569 int (*emulate)(struct se_cmd *, unsigned char *);
570 } evpd_handlers[] = {
571 { .page = 0x00, .emulate = target_emulate_evpd_00 },
572 { .page = 0x80, .emulate = target_emulate_evpd_80 },
573 { .page = 0x83, .emulate = target_emulate_evpd_83 },
574 { .page = 0x86, .emulate = target_emulate_evpd_86 },
575 { .page = 0xb0, .emulate = target_emulate_evpd_b0 },
576 { .page = 0xb1, .emulate = target_emulate_evpd_b1 },
577 { .page = 0xb2, .emulate = target_emulate_evpd_b2 },
580 /* supported vital product data pages */
582 target_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf)
587 * Only report the INQUIRY EVPD=1 pages after a valid NAA
588 * Registered Extended LUN WWN has been set via ConfigFS
589 * during device creation/restart.
591 if (cmd->se_dev->se_sub_dev->su_dev_flags &
592 SDF_EMULATED_VPD_UNIT_SERIAL) {
593 buf[3] = ARRAY_SIZE(evpd_handlers);
594 for (p = 0; p < ARRAY_SIZE(evpd_handlers); ++p)
595 buf[p + 4] = evpd_handlers[p].page;
601 int target_emulate_inquiry(struct se_task *task)
603 struct se_cmd *cmd = task->task_se_cmd;
604 struct se_device *dev = cmd->se_dev;
605 struct se_portal_group *tpg = cmd->se_lun->lun_sep->sep_tpg;
606 unsigned char *buf, *map_buf;
607 unsigned char *cdb = cmd->t_task_cdb;
610 map_buf = transport_kmap_data_sg(cmd);
612 * If SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC is not set, then we
613 * know we actually allocated a full page. Otherwise, if the
614 * data buffer is too small, allocate a temporary buffer so we
615 * don't have to worry about overruns in all our INQUIRY
616 * emulation handling.
618 if (cmd->data_length < SE_INQUIRY_BUF &&
619 (cmd->se_cmd_flags & SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC)) {
620 buf = kzalloc(SE_INQUIRY_BUF, GFP_KERNEL);
622 transport_kunmap_data_sg(cmd);
623 cmd->scsi_sense_reason = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
630 if (dev == tpg->tpg_virt_lun0.lun_se_dev)
631 buf[0] = 0x3f; /* Not connected */
633 buf[0] = dev->transport->get_device_type(dev);
635 if (!(cdb[1] & 0x1)) {
637 pr_err("INQUIRY with EVPD==0 but PAGE CODE=%02x\n",
639 cmd->scsi_sense_reason = TCM_INVALID_CDB_FIELD;
644 ret = target_emulate_inquiry_std(cmd, buf);
648 for (p = 0; p < ARRAY_SIZE(evpd_handlers); ++p) {
649 if (cdb[2] == evpd_handlers[p].page) {
651 ret = evpd_handlers[p].emulate(cmd, buf);
656 pr_err("Unknown VPD Code: 0x%02x\n", cdb[2]);
657 cmd->scsi_sense_reason = TCM_INVALID_CDB_FIELD;
661 if (buf != map_buf) {
662 memcpy(map_buf, buf, cmd->data_length);
665 transport_kunmap_data_sg(cmd);
668 task->task_scsi_status = GOOD;
669 transport_complete_task(task, 1);
674 int target_emulate_readcapacity(struct se_task *task)
676 struct se_cmd *cmd = task->task_se_cmd;
677 struct se_device *dev = cmd->se_dev;
679 unsigned long long blocks_long = dev->transport->get_blocks(dev);
682 if (blocks_long >= 0x00000000ffffffff)
685 blocks = (u32)blocks_long;
687 buf = transport_kmap_data_sg(cmd);
689 buf[0] = (blocks >> 24) & 0xff;
690 buf[1] = (blocks >> 16) & 0xff;
691 buf[2] = (blocks >> 8) & 0xff;
692 buf[3] = blocks & 0xff;
693 buf[4] = (dev->se_sub_dev->se_dev_attrib.block_size >> 24) & 0xff;
694 buf[5] = (dev->se_sub_dev->se_dev_attrib.block_size >> 16) & 0xff;
695 buf[6] = (dev->se_sub_dev->se_dev_attrib.block_size >> 8) & 0xff;
696 buf[7] = dev->se_sub_dev->se_dev_attrib.block_size & 0xff;
698 transport_kunmap_data_sg(cmd);
700 task->task_scsi_status = GOOD;
701 transport_complete_task(task, 1);
705 int target_emulate_readcapacity_16(struct se_task *task)
707 struct se_cmd *cmd = task->task_se_cmd;
708 struct se_device *dev = cmd->se_dev;
710 unsigned long long blocks = dev->transport->get_blocks(dev);
712 buf = transport_kmap_data_sg(cmd);
714 buf[0] = (blocks >> 56) & 0xff;
715 buf[1] = (blocks >> 48) & 0xff;
716 buf[2] = (blocks >> 40) & 0xff;
717 buf[3] = (blocks >> 32) & 0xff;
718 buf[4] = (blocks >> 24) & 0xff;
719 buf[5] = (blocks >> 16) & 0xff;
720 buf[6] = (blocks >> 8) & 0xff;
721 buf[7] = blocks & 0xff;
722 buf[8] = (dev->se_sub_dev->se_dev_attrib.block_size >> 24) & 0xff;
723 buf[9] = (dev->se_sub_dev->se_dev_attrib.block_size >> 16) & 0xff;
724 buf[10] = (dev->se_sub_dev->se_dev_attrib.block_size >> 8) & 0xff;
725 buf[11] = dev->se_sub_dev->se_dev_attrib.block_size & 0xff;
727 * Set Thin Provisioning Enable bit following sbc3r22 in section
728 * READ CAPACITY (16) byte 14 if emulate_tpu or emulate_tpws is enabled.
730 if (dev->se_sub_dev->se_dev_attrib.emulate_tpu || dev->se_sub_dev->se_dev_attrib.emulate_tpws)
733 transport_kunmap_data_sg(cmd);
735 task->task_scsi_status = GOOD;
736 transport_complete_task(task, 1);
741 target_modesense_rwrecovery(unsigned char *p)
750 target_modesense_control(struct se_device *dev, unsigned char *p)
756 * From spc4r23, 7.4.7 Control mode page
758 * The QUEUE ALGORITHM MODIFIER field (see table 368) specifies
759 * restrictions on the algorithm used for reordering commands
760 * having the SIMPLE task attribute (see SAM-4).
762 * Table 368 -- QUEUE ALGORITHM MODIFIER field
764 * 0h Restricted reordering
765 * 1h Unrestricted reordering allowed
767 * 8h to Fh Vendor specific
769 * A value of zero in the QUEUE ALGORITHM MODIFIER field specifies that
770 * the device server shall order the processing sequence of commands
771 * having the SIMPLE task attribute such that data integrity is maintained
772 * for that I_T nexus (i.e., if the transmission of new SCSI transport protocol
773 * requests is halted at any time, the final value of all data observable
774 * on the medium shall be the same as if all the commands had been processed
775 * with the ORDERED task attribute).
777 * A value of one in the QUEUE ALGORITHM MODIFIER field specifies that the
778 * device server may reorder the processing sequence of commands having the
779 * SIMPLE task attribute in any manner. Any data integrity exposures related to
780 * command sequence order shall be explicitly handled by the application client
781 * through the selection of appropriate ommands and task attributes.
783 p[3] = (dev->se_sub_dev->se_dev_attrib.emulate_rest_reord == 1) ? 0x00 : 0x10;
785 * From spc4r17, section 7.4.6 Control mode Page
787 * Unit Attention interlocks control (UN_INTLCK_CTRL) to code 00b
789 * 00b: The logical unit shall clear any unit attention condition
790 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
791 * status and shall not establish a unit attention condition when a com-
792 * mand is completed with BUSY, TASK SET FULL, or RESERVATION CONFLICT
795 * 10b: The logical unit shall not clear any unit attention condition
796 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
797 * status and shall not establish a unit attention condition when
798 * a command is completed with BUSY, TASK SET FULL, or RESERVATION
801 * 11b a The logical unit shall not clear any unit attention condition
802 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
803 * status and shall establish a unit attention condition for the
804 * initiator port associated with the I_T nexus on which the BUSY,
805 * TASK SET FULL, or RESERVATION CONFLICT status is being returned.
806 * Depending on the status, the additional sense code shall be set to
807 * PREVIOUS BUSY STATUS, PREVIOUS TASK SET FULL STATUS, or PREVIOUS
808 * RESERVATION CONFLICT STATUS. Until it is cleared by a REQUEST SENSE
809 * command, a unit attention condition shall be established only once
810 * for a BUSY, TASK SET FULL, or RESERVATION CONFLICT status regardless
811 * to the number of commands completed with one of those status codes.
813 p[4] = (dev->se_sub_dev->se_dev_attrib.emulate_ua_intlck_ctrl == 2) ? 0x30 :
814 (dev->se_sub_dev->se_dev_attrib.emulate_ua_intlck_ctrl == 1) ? 0x20 : 0x00;
816 * From spc4r17, section 7.4.6 Control mode Page
818 * Task Aborted Status (TAS) bit set to zero.
820 * A task aborted status (TAS) bit set to zero specifies that aborted
821 * tasks shall be terminated by the device server without any response
822 * to the application client. A TAS bit set to one specifies that tasks
823 * aborted by the actions of an I_T nexus other than the I_T nexus on
824 * which the command was received shall be completed with TASK ABORTED
825 * status (see SAM-4).
827 p[5] = (dev->se_sub_dev->se_dev_attrib.emulate_tas) ? 0x40 : 0x00;
836 target_modesense_caching(struct se_device *dev, unsigned char *p)
840 if (dev->se_sub_dev->se_dev_attrib.emulate_write_cache > 0)
841 p[2] = 0x04; /* Write Cache Enable */
842 p[12] = 0x20; /* Disabled Read Ahead */
848 target_modesense_write_protect(unsigned char *buf, int type)
851 * I believe that the WP bit (bit 7) in the mode header is the same for
858 buf[0] |= 0x80; /* WP bit */
864 target_modesense_dpofua(unsigned char *buf, int type)
868 buf[0] |= 0x10; /* DPOFUA bit */
875 int target_emulate_modesense(struct se_task *task)
877 struct se_cmd *cmd = task->task_se_cmd;
878 struct se_device *dev = cmd->se_dev;
879 char *cdb = cmd->t_task_cdb;
881 int type = dev->transport->get_device_type(dev);
882 int ten = (cmd->t_task_cdb[0] == MODE_SENSE_10);
883 int offset = ten ? 8 : 4;
885 unsigned char buf[SE_MODE_PAGE_BUF];
887 memset(buf, 0, SE_MODE_PAGE_BUF);
889 switch (cdb[2] & 0x3f) {
891 length = target_modesense_rwrecovery(&buf[offset]);
894 length = target_modesense_caching(dev, &buf[offset]);
897 length = target_modesense_control(dev, &buf[offset]);
900 length = target_modesense_rwrecovery(&buf[offset]);
901 length += target_modesense_caching(dev, &buf[offset+length]);
902 length += target_modesense_control(dev, &buf[offset+length]);
905 pr_err("MODE SENSE: unimplemented page/subpage: 0x%02x/0x%02x\n",
906 cdb[2] & 0x3f, cdb[3]);
907 cmd->scsi_sense_reason = TCM_UNKNOWN_MODE_PAGE;
914 buf[0] = (offset >> 8) & 0xff;
915 buf[1] = offset & 0xff;
917 if ((cmd->se_lun->lun_access & TRANSPORT_LUNFLAGS_READ_ONLY) ||
919 (cmd->se_deve->lun_flags & TRANSPORT_LUNFLAGS_READ_ONLY)))
920 target_modesense_write_protect(&buf[3], type);
922 if ((dev->se_sub_dev->se_dev_attrib.emulate_write_cache > 0) &&
923 (dev->se_sub_dev->se_dev_attrib.emulate_fua_write > 0))
924 target_modesense_dpofua(&buf[3], type);
926 if ((offset + 2) > cmd->data_length)
927 offset = cmd->data_length;
931 buf[0] = offset & 0xff;
933 if ((cmd->se_lun->lun_access & TRANSPORT_LUNFLAGS_READ_ONLY) ||
935 (cmd->se_deve->lun_flags & TRANSPORT_LUNFLAGS_READ_ONLY)))
936 target_modesense_write_protect(&buf[2], type);
938 if ((dev->se_sub_dev->se_dev_attrib.emulate_write_cache > 0) &&
939 (dev->se_sub_dev->se_dev_attrib.emulate_fua_write > 0))
940 target_modesense_dpofua(&buf[2], type);
942 if ((offset + 1) > cmd->data_length)
943 offset = cmd->data_length;
946 rbuf = transport_kmap_data_sg(cmd);
947 memcpy(rbuf, buf, offset);
948 transport_kunmap_data_sg(cmd);
950 task->task_scsi_status = GOOD;
951 transport_complete_task(task, 1);
955 int target_emulate_request_sense(struct se_task *task)
957 struct se_cmd *cmd = task->task_se_cmd;
958 unsigned char *cdb = cmd->t_task_cdb;
960 u8 ua_asc = 0, ua_ascq = 0;
964 pr_err("REQUEST_SENSE description emulation not"
966 cmd->scsi_sense_reason = TCM_INVALID_CDB_FIELD;
970 buf = transport_kmap_data_sg(cmd);
972 if (!core_scsi3_ua_clear_for_request_sense(cmd, &ua_asc, &ua_ascq)) {
974 * CURRENT ERROR, UNIT ATTENTION
977 buf[SPC_SENSE_KEY_OFFSET] = UNIT_ATTENTION;
979 if (cmd->data_length < 18) {
985 * The Additional Sense Code (ASC) from the UNIT ATTENTION
987 buf[SPC_ASC_KEY_OFFSET] = ua_asc;
988 buf[SPC_ASCQ_KEY_OFFSET] = ua_ascq;
992 * CURRENT ERROR, NO SENSE
995 buf[SPC_SENSE_KEY_OFFSET] = NO_SENSE;
997 if (cmd->data_length < 18) {
1003 * NO ADDITIONAL SENSE INFORMATION
1005 buf[SPC_ASC_KEY_OFFSET] = 0x00;
1010 transport_kunmap_data_sg(cmd);
1011 task->task_scsi_status = GOOD;
1012 transport_complete_task(task, 1);
1017 * Used for TCM/IBLOCK and TCM/FILEIO for block/blk-lib.c level discard support.
1018 * Note this is not used for TCM/pSCSI passthrough
1020 int target_emulate_unmap(struct se_task *task)
1022 struct se_cmd *cmd = task->task_se_cmd;
1023 struct se_device *dev = cmd->se_dev;
1024 unsigned char *buf, *ptr = NULL;
1025 unsigned char *cdb = &cmd->t_task_cdb[0];
1027 unsigned int size = cmd->data_length, range;
1028 int ret = 0, offset;
1029 unsigned short dl, bd_dl;
1031 if (!dev->transport->do_discard) {
1032 pr_err("UNMAP emulation not supported for: %s\n",
1033 dev->transport->name);
1034 cmd->scsi_sense_reason = TCM_UNSUPPORTED_SCSI_OPCODE;
1038 /* First UNMAP block descriptor starts at 8 byte offset */
1041 dl = get_unaligned_be16(&cdb[0]);
1042 bd_dl = get_unaligned_be16(&cdb[2]);
1044 buf = transport_kmap_data_sg(cmd);
1047 pr_debug("UNMAP: Sub: %s Using dl: %hu bd_dl: %hu size: %hu"
1048 " ptr: %p\n", dev->transport->name, dl, bd_dl, size, ptr);
1051 lba = get_unaligned_be64(&ptr[0]);
1052 range = get_unaligned_be32(&ptr[8]);
1053 pr_debug("UNMAP: Using lba: %llu and range: %u\n",
1054 (unsigned long long)lba, range);
1056 ret = dev->transport->do_discard(dev, lba, range);
1058 pr_err("blkdev_issue_discard() failed: %d\n",
1068 transport_kunmap_data_sg(cmd);
1070 task->task_scsi_status = GOOD;
1071 transport_complete_task(task, 1);
1077 * Used for TCM/IBLOCK and TCM/FILEIO for block/blk-lib.c level discard support.
1078 * Note this is not used for TCM/pSCSI passthrough
1080 int target_emulate_write_same(struct se_task *task)
1082 struct se_cmd *cmd = task->task_se_cmd;
1083 struct se_device *dev = cmd->se_dev;
1085 sector_t lba = cmd->t_task_lba;
1089 if (!dev->transport->do_discard) {
1090 pr_err("WRITE_SAME emulation not supported"
1091 " for: %s\n", dev->transport->name);
1092 cmd->scsi_sense_reason = TCM_UNSUPPORTED_SCSI_OPCODE;
1096 if (cmd->t_task_cdb[0] == WRITE_SAME)
1097 num_blocks = get_unaligned_be16(&cmd->t_task_cdb[7]);
1098 else if (cmd->t_task_cdb[0] == WRITE_SAME_16)
1099 num_blocks = get_unaligned_be32(&cmd->t_task_cdb[10]);
1100 else /* WRITE_SAME_32 via VARIABLE_LENGTH_CMD */
1101 num_blocks = get_unaligned_be32(&cmd->t_task_cdb[28]);
1104 * Use the explicit range when non zero is supplied, otherwise calculate
1105 * the remaining range based on ->get_blocks() - starting LBA.
1107 if (num_blocks != 0)
1110 range = (dev->transport->get_blocks(dev) - lba);
1112 pr_debug("WRITE_SAME UNMAP: LBA: %llu Range: %llu\n",
1113 (unsigned long long)lba, (unsigned long long)range);
1115 ret = dev->transport->do_discard(dev, lba, range);
1117 pr_debug("blkdev_issue_discard() failed for WRITE_SAME\n");
1121 task->task_scsi_status = GOOD;
1122 transport_complete_task(task, 1);
1126 int target_emulate_synchronize_cache(struct se_task *task)
1128 struct se_device *dev = task->task_se_cmd->se_dev;
1129 struct se_cmd *cmd = task->task_se_cmd;
1131 if (!dev->transport->do_sync_cache) {
1132 pr_err("SYNCHRONIZE_CACHE emulation not supported"
1133 " for: %s\n", dev->transport->name);
1134 cmd->scsi_sense_reason = TCM_UNSUPPORTED_SCSI_OPCODE;
1138 dev->transport->do_sync_cache(task);
1142 int target_emulate_noop(struct se_task *task)
1144 task->task_scsi_status = GOOD;
1145 transport_complete_task(task, 1);
1150 * Write a CDB into @cdb that is based on the one the intiator sent us,
1151 * but updated to only cover the sectors that the current task handles.
1153 void target_get_task_cdb(struct se_task *task, unsigned char *cdb)
1155 struct se_cmd *cmd = task->task_se_cmd;
1156 unsigned int cdb_len = scsi_command_size(cmd->t_task_cdb);
1158 memcpy(cdb, cmd->t_task_cdb, cdb_len);
1159 if (cmd->se_cmd_flags & SCF_SCSI_DATA_SG_IO_CDB) {
1160 unsigned long long lba = task->task_lba;
1161 u32 sectors = task->task_sectors;
1165 /* 21-bit LBA and 8-bit sectors */
1166 cdb[1] = (lba >> 16) & 0x1f;
1167 cdb[2] = (lba >> 8) & 0xff;
1168 cdb[3] = lba & 0xff;
1169 cdb[4] = sectors & 0xff;
1172 /* 32-bit LBA and 16-bit sectors */
1173 put_unaligned_be32(lba, &cdb[2]);
1174 put_unaligned_be16(sectors, &cdb[7]);
1177 /* 32-bit LBA and 32-bit sectors */
1178 put_unaligned_be32(lba, &cdb[2]);
1179 put_unaligned_be32(sectors, &cdb[6]);
1182 /* 64-bit LBA and 32-bit sectors */
1183 put_unaligned_be64(lba, &cdb[2]);
1184 put_unaligned_be32(sectors, &cdb[10]);
1187 /* 64-bit LBA and 32-bit sectors, extended CDB */
1188 put_unaligned_be64(lba, &cdb[12]);
1189 put_unaligned_be32(sectors, &cdb[28]);
1196 EXPORT_SYMBOL(target_get_task_cdb);