2 * SCSI Primary Commands (SPC) parsing and emulation.
4 * (c) Copyright 2002-2013 Datera, Inc.
6 * Nicholas A. Bellinger <nab@kernel.org>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 #include <linux/kernel.h>
24 #include <linux/module.h>
25 #include <asm/unaligned.h>
27 #include <scsi/scsi.h>
28 #include <scsi/scsi_tcq.h>
30 #include <target/target_core_base.h>
31 #include <target/target_core_backend.h>
32 #include <target/target_core_fabric.h>
34 #include "target_core_internal.h"
35 #include "target_core_alua.h"
36 #include "target_core_pr.h"
37 #include "target_core_ua.h"
38 #include "target_core_xcopy.h"
40 static void spc_fill_alua_data(struct se_port *port, unsigned char *buf)
42 struct t10_alua_tg_pt_gp *tg_pt_gp;
43 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
46 * Set SCCS for MAINTENANCE_IN + REPORT_TARGET_PORT_GROUPS.
51 * Set TPGS field for explicit and/or implicit ALUA access type
54 * See spc4r17 section 6.4.2 Table 135
58 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
62 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
63 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
65 buf[5] |= tg_pt_gp->tg_pt_gp_alua_access_type;
66 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
70 spc_emulate_inquiry_std(struct se_cmd *cmd, unsigned char *buf)
72 struct se_lun *lun = cmd->se_lun;
73 struct se_device *dev = cmd->se_dev;
75 /* Set RMB (removable media) for tape devices */
76 if (dev->transport->get_device_type(dev) == TYPE_TAPE)
79 buf[2] = 0x05; /* SPC-3 */
82 * NORMACA and HISUP = 0, RESPONSE DATA FORMAT = 2
85 * A RESPONSE DATA FORMAT field set to 2h indicates that the
86 * standard INQUIRY data is in the format defined in this
87 * standard. Response data format values less than 2h are
88 * obsolete. Response data format values greater than 2h are
94 * Enable SCCS and TPGS fields for Emulated ALUA
96 spc_fill_alua_data(lun->lun_sep, buf);
99 * Set Third-Party Copy (3PC) bit to indicate support for EXTENDED_COPY
101 if (dev->dev_attrib.emulate_3pc)
104 * Set Protection (PROTECT) bit when DIF has been enabled.
106 if (dev->dev_attrib.pi_prot_type)
109 buf[7] = 0x2; /* CmdQue=1 */
111 memcpy(&buf[8], "LIO-ORG ", 8);
112 memset(&buf[16], 0x20, 16);
113 memcpy(&buf[16], dev->t10_wwn.model,
114 min_t(size_t, strlen(dev->t10_wwn.model), 16));
115 memcpy(&buf[32], dev->t10_wwn.revision,
116 min_t(size_t, strlen(dev->t10_wwn.revision), 4));
117 buf[4] = 31; /* Set additional length to 31 */
121 EXPORT_SYMBOL(spc_emulate_inquiry_std);
123 /* unit serial number */
124 static sense_reason_t
125 spc_emulate_evpd_80(struct se_cmd *cmd, unsigned char *buf)
127 struct se_device *dev = cmd->se_dev;
130 if (dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL) {
133 unit_serial_len = strlen(dev->t10_wwn.unit_serial);
134 unit_serial_len++; /* For NULL Terminator */
136 len += sprintf(&buf[4], "%s", dev->t10_wwn.unit_serial);
137 len++; /* Extra Byte for NULL Terminator */
143 void spc_parse_naa_6h_vendor_specific(struct se_device *dev,
146 unsigned char *p = &dev->t10_wwn.unit_serial[0];
151 * Generate up to 36 bits of VENDOR SPECIFIC IDENTIFIER starting on
152 * byte 3 bit 3-0 for NAA IEEE Registered Extended DESIGNATOR field
153 * format, followed by 64 bits of VENDOR SPECIFIC IDENTIFIER EXTENSION
154 * to complete the payload. These are based from VPD=0x80 PRODUCT SERIAL
155 * NUMBER set via vpd_unit_serial in target_core_configfs.c to ensure
156 * per device uniqeness.
158 for (cnt = 0; *p && cnt < 13; p++) {
159 int val = hex_to_bin(*p);
175 * Device identification VPD, for a complete list of
176 * DESIGNATOR TYPEs see spc4r17 Table 459.
179 spc_emulate_evpd_83(struct se_cmd *cmd, unsigned char *buf)
181 struct se_device *dev = cmd->se_dev;
182 struct se_lun *lun = cmd->se_lun;
183 struct se_port *port = NULL;
184 struct se_portal_group *tpg = NULL;
185 struct t10_alua_lu_gp_member *lu_gp_mem;
186 struct t10_alua_tg_pt_gp *tg_pt_gp;
187 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
188 unsigned char *prod = &dev->t10_wwn.model[0];
190 u32 unit_serial_len, off = 0;
196 * NAA IEEE Registered Extended Assigned designator format, see
197 * spc4r17 section 7.7.3.6.5
199 * We depend upon a target_core_mod/ConfigFS provided
200 * /sys/kernel/config/target/core/$HBA/$DEV/wwn/vpd_unit_serial
201 * value in order to return the NAA id.
203 if (!(dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL))
204 goto check_t10_vend_desc;
206 /* CODE SET == Binary */
209 /* Set ASSOCIATION == addressed logical unit: 0)b */
212 /* Identifier/Designator type == NAA identifier */
216 /* Identifier/Designator length */
220 * Start NAA IEEE Registered Extended Identifier/Designator
222 buf[off++] = (0x6 << 4);
225 * Use OpenFabrics IEEE Company ID: 00 14 05
229 buf[off] = (0x5 << 4);
232 * Return ConfigFS Unit Serial Number information for
233 * VENDOR_SPECIFIC_IDENTIFIER and
234 * VENDOR_SPECIFIC_IDENTIFIER_EXTENTION
236 spc_parse_naa_6h_vendor_specific(dev, &buf[off]);
243 * T10 Vendor Identifier Page, see spc4r17 section 7.7.3.4
245 id_len = 8; /* For Vendor field */
246 prod_len = 4; /* For VPD Header */
247 prod_len += 8; /* For Vendor field */
248 prod_len += strlen(prod);
249 prod_len++; /* For : */
251 if (dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL) {
252 unit_serial_len = strlen(&dev->t10_wwn.unit_serial[0]);
253 unit_serial_len++; /* For NULL Terminator */
255 id_len += sprintf(&buf[off+12], "%s:%s", prod,
256 &dev->t10_wwn.unit_serial[0]);
258 buf[off] = 0x2; /* ASCII */
259 buf[off+1] = 0x1; /* T10 Vendor ID */
261 memcpy(&buf[off+4], "LIO-ORG", 8);
262 /* Extra Byte for NULL Terminator */
264 /* Identifier Length */
266 /* Header size for Designation descriptor */
270 * struct se_port is only set for INQUIRY VPD=1 through $FABRIC_MOD
274 struct t10_alua_lu_gp *lu_gp;
275 u32 padding, scsi_name_len, scsi_target_len;
282 * Relative target port identifer, see spc4r17
285 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
286 * section 7.5.1 Table 362
289 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
290 buf[off++] |= 0x1; /* CODE SET == Binary */
291 buf[off] = 0x80; /* Set PIV=1 */
292 /* Set ASSOCIATION == target port: 01b */
294 /* DESIGNATOR TYPE == Relative target port identifer */
296 off++; /* Skip over Reserved */
297 buf[off++] = 4; /* DESIGNATOR LENGTH */
298 /* Skip over Obsolete field in RTPI payload
301 buf[off++] = ((port->sep_rtpi >> 8) & 0xff);
302 buf[off++] = (port->sep_rtpi & 0xff);
303 len += 8; /* Header size + Designation descriptor */
305 * Target port group identifier, see spc4r17
308 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
309 * section 7.5.1 Table 362
311 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
315 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
316 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
318 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
321 tg_pt_gp_id = tg_pt_gp->tg_pt_gp_id;
322 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
325 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
326 buf[off++] |= 0x1; /* CODE SET == Binary */
327 buf[off] = 0x80; /* Set PIV=1 */
328 /* Set ASSOCIATION == target port: 01b */
330 /* DESIGNATOR TYPE == Target port group identifier */
332 off++; /* Skip over Reserved */
333 buf[off++] = 4; /* DESIGNATOR LENGTH */
334 off += 2; /* Skip over Reserved Field */
335 buf[off++] = ((tg_pt_gp_id >> 8) & 0xff);
336 buf[off++] = (tg_pt_gp_id & 0xff);
337 len += 8; /* Header size + Designation descriptor */
339 * Logical Unit Group identifier, see spc4r17
343 lu_gp_mem = dev->dev_alua_lu_gp_mem;
345 goto check_scsi_name;
347 spin_lock(&lu_gp_mem->lu_gp_mem_lock);
348 lu_gp = lu_gp_mem->lu_gp;
350 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
351 goto check_scsi_name;
353 lu_gp_id = lu_gp->lu_gp_id;
354 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
356 buf[off++] |= 0x1; /* CODE SET == Binary */
357 /* DESIGNATOR TYPE == Logical Unit Group identifier */
359 off++; /* Skip over Reserved */
360 buf[off++] = 4; /* DESIGNATOR LENGTH */
361 off += 2; /* Skip over Reserved Field */
362 buf[off++] = ((lu_gp_id >> 8) & 0xff);
363 buf[off++] = (lu_gp_id & 0xff);
364 len += 8; /* Header size + Designation descriptor */
366 * SCSI name string designator, see spc4r17
369 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
370 * section 7.5.1 Table 362
374 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
375 buf[off++] |= 0x3; /* CODE SET == UTF-8 */
376 buf[off] = 0x80; /* Set PIV=1 */
377 /* Set ASSOCIATION == target port: 01b */
379 /* DESIGNATOR TYPE == SCSI name string */
381 off += 2; /* Skip over Reserved and length */
383 * SCSI name string identifer containing, $FABRIC_MOD
384 * dependent information. For LIO-Target and iSCSI
385 * Target Port, this means "<iSCSI name>,t,0x<TPGT> in
388 tpgt = tpg->se_tpg_tfo->tpg_get_tag(tpg);
389 scsi_name_len = sprintf(&buf[off], "%s,t,0x%04x",
390 tpg->se_tpg_tfo->tpg_get_wwn(tpg), tpgt);
391 scsi_name_len += 1 /* Include NULL terminator */;
393 * The null-terminated, null-padded (see 4.4.2) SCSI
394 * NAME STRING field contains a UTF-8 format string.
395 * The number of bytes in the SCSI NAME STRING field
396 * (i.e., the value in the DESIGNATOR LENGTH field)
397 * shall be no larger than 256 and shall be a multiple
400 padding = ((-scsi_name_len) & 3);
402 scsi_name_len += padding;
403 if (scsi_name_len > 256)
406 buf[off-1] = scsi_name_len;
407 off += scsi_name_len;
408 /* Header size + Designation descriptor */
409 len += (scsi_name_len + 4);
412 * Target device designator
415 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
416 buf[off++] |= 0x3; /* CODE SET == UTF-8 */
417 buf[off] = 0x80; /* Set PIV=1 */
418 /* Set ASSOCIATION == target device: 10b */
420 /* DESIGNATOR TYPE == SCSI name string */
422 off += 2; /* Skip over Reserved and length */
424 * SCSI name string identifer containing, $FABRIC_MOD
425 * dependent information. For LIO-Target and iSCSI
426 * Target Port, this means "<iSCSI name>" in
429 scsi_target_len = sprintf(&buf[off], "%s",
430 tpg->se_tpg_tfo->tpg_get_wwn(tpg));
431 scsi_target_len += 1 /* Include NULL terminator */;
433 * The null-terminated, null-padded (see 4.4.2) SCSI
434 * NAME STRING field contains a UTF-8 format string.
435 * The number of bytes in the SCSI NAME STRING field
436 * (i.e., the value in the DESIGNATOR LENGTH field)
437 * shall be no larger than 256 and shall be a multiple
440 padding = ((-scsi_target_len) & 3);
442 scsi_target_len += padding;
443 if (scsi_name_len > 256)
446 buf[off-1] = scsi_target_len;
447 off += scsi_target_len;
449 /* Header size + Designation descriptor */
450 len += (scsi_target_len + 4);
452 buf[2] = ((len >> 8) & 0xff);
453 buf[3] = (len & 0xff); /* Page Length for VPD 0x83 */
456 EXPORT_SYMBOL(spc_emulate_evpd_83);
459 spc_check_dev_wce(struct se_device *dev)
463 if (dev->transport->get_write_cache)
464 wce = dev->transport->get_write_cache(dev);
465 else if (dev->dev_attrib.emulate_write_cache > 0)
471 /* Extended INQUIRY Data VPD Page */
472 static sense_reason_t
473 spc_emulate_evpd_86(struct se_cmd *cmd, unsigned char *buf)
475 struct se_device *dev = cmd->se_dev;
479 * Set GRD_CHK + REF_CHK for TYPE1 protection, or GRD_CHK
480 * only for TYPE3 protection.
482 if (dev->dev_attrib.pi_prot_type == TARGET_DIF_TYPE1_PROT)
484 else if (dev->dev_attrib.pi_prot_type == TARGET_DIF_TYPE3_PROT)
487 /* Set HEADSUP, ORDSUP, SIMPSUP */
490 /* If WriteCache emulation is enabled, set V_SUP */
491 if (spc_check_dev_wce(dev))
493 /* If an LBA map is present set R_SUP */
494 spin_lock(&cmd->se_dev->t10_alua.lba_map_lock);
495 if (!list_empty(&dev->t10_alua.lba_map_list))
497 spin_unlock(&cmd->se_dev->t10_alua.lba_map_lock);
501 /* Block Limits VPD page */
502 static sense_reason_t
503 spc_emulate_evpd_b0(struct se_cmd *cmd, unsigned char *buf)
505 struct se_device *dev = cmd->se_dev;
511 * Following spc3r22 section 6.5.3 Block Limits VPD page, when
512 * emulate_tpu=1 or emulate_tpws=1 we will be expect a
513 * different page length for Thin Provisioning.
515 if (dev->dev_attrib.emulate_tpu || dev->dev_attrib.emulate_tpws)
518 buf[0] = dev->transport->get_device_type(dev);
519 buf[3] = have_tp ? 0x3c : 0x10;
524 * Set MAXIMUM COMPARE AND WRITE LENGTH
526 if (dev->dev_attrib.emulate_caw)
530 * Set OPTIMAL TRANSFER LENGTH GRANULARITY
532 if (dev->transport->get_io_min && (min = dev->transport->get_io_min(dev)))
533 put_unaligned_be16(min / dev->dev_attrib.block_size, &buf[6]);
535 put_unaligned_be16(1, &buf[6]);
538 * Set MAXIMUM TRANSFER LENGTH
540 max_sectors = min(dev->dev_attrib.fabric_max_sectors,
541 dev->dev_attrib.hw_max_sectors);
542 put_unaligned_be32(max_sectors, &buf[8]);
545 * Set OPTIMAL TRANSFER LENGTH
547 if (dev->transport->get_io_opt && (opt = dev->transport->get_io_opt(dev)))
548 put_unaligned_be32(opt / dev->dev_attrib.block_size, &buf[12]);
550 put_unaligned_be32(dev->dev_attrib.optimal_sectors, &buf[12]);
553 * Exit now if we don't support TP.
559 * Set MAXIMUM UNMAP LBA COUNT
561 put_unaligned_be32(dev->dev_attrib.max_unmap_lba_count, &buf[20]);
564 * Set MAXIMUM UNMAP BLOCK DESCRIPTOR COUNT
566 put_unaligned_be32(dev->dev_attrib.max_unmap_block_desc_count,
570 * Set OPTIMAL UNMAP GRANULARITY
572 put_unaligned_be32(dev->dev_attrib.unmap_granularity, &buf[28]);
575 * UNMAP GRANULARITY ALIGNMENT
577 put_unaligned_be32(dev->dev_attrib.unmap_granularity_alignment,
579 if (dev->dev_attrib.unmap_granularity_alignment != 0)
580 buf[32] |= 0x80; /* Set the UGAVALID bit */
583 * MAXIMUM WRITE SAME LENGTH
586 put_unaligned_be64(dev->dev_attrib.max_write_same_len, &buf[36]);
591 /* Block Device Characteristics VPD page */
592 static sense_reason_t
593 spc_emulate_evpd_b1(struct se_cmd *cmd, unsigned char *buf)
595 struct se_device *dev = cmd->se_dev;
597 buf[0] = dev->transport->get_device_type(dev);
599 buf[5] = dev->dev_attrib.is_nonrot ? 1 : 0;
604 /* Thin Provisioning VPD */
605 static sense_reason_t
606 spc_emulate_evpd_b2(struct se_cmd *cmd, unsigned char *buf)
608 struct se_device *dev = cmd->se_dev;
611 * From spc3r22 section 6.5.4 Thin Provisioning VPD page:
613 * The PAGE LENGTH field is defined in SPC-4. If the DP bit is set to
614 * zero, then the page length shall be set to 0004h. If the DP bit
615 * is set to one, then the page length shall be set to the value
616 * defined in table 162.
618 buf[0] = dev->transport->get_device_type(dev);
621 * Set Hardcoded length mentioned above for DP=0
623 put_unaligned_be16(0x0004, &buf[2]);
626 * The THRESHOLD EXPONENT field indicates the threshold set size in
627 * LBAs as a power of 2 (i.e., the threshold set size is equal to
628 * 2(threshold exponent)).
630 * Note that this is currently set to 0x00 as mkp says it will be
631 * changing again. We can enable this once it has settled in T10
632 * and is actually used by Linux/SCSI ML code.
637 * A TPU bit set to one indicates that the device server supports
638 * the UNMAP command (see 5.25). A TPU bit set to zero indicates
639 * that the device server does not support the UNMAP command.
641 if (dev->dev_attrib.emulate_tpu != 0)
645 * A TPWS bit set to one indicates that the device server supports
646 * the use of the WRITE SAME (16) command (see 5.42) to unmap LBAs.
647 * A TPWS bit set to zero indicates that the device server does not
648 * support the use of the WRITE SAME (16) command to unmap LBAs.
650 if (dev->dev_attrib.emulate_tpws != 0)
656 /* Referrals VPD page */
657 static sense_reason_t
658 spc_emulate_evpd_b3(struct se_cmd *cmd, unsigned char *buf)
660 struct se_device *dev = cmd->se_dev;
662 buf[0] = dev->transport->get_device_type(dev);
664 put_unaligned_be32(dev->t10_alua.lba_map_segment_size, &buf[8]);
665 put_unaligned_be32(dev->t10_alua.lba_map_segment_size, &buf[12]);
670 static sense_reason_t
671 spc_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf);
675 sense_reason_t (*emulate)(struct se_cmd *, unsigned char *);
676 } evpd_handlers[] = {
677 { .page = 0x00, .emulate = spc_emulate_evpd_00 },
678 { .page = 0x80, .emulate = spc_emulate_evpd_80 },
679 { .page = 0x83, .emulate = spc_emulate_evpd_83 },
680 { .page = 0x86, .emulate = spc_emulate_evpd_86 },
681 { .page = 0xb0, .emulate = spc_emulate_evpd_b0 },
682 { .page = 0xb1, .emulate = spc_emulate_evpd_b1 },
683 { .page = 0xb2, .emulate = spc_emulate_evpd_b2 },
684 { .page = 0xb3, .emulate = spc_emulate_evpd_b3 },
687 /* supported vital product data pages */
688 static sense_reason_t
689 spc_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf)
694 * Only report the INQUIRY EVPD=1 pages after a valid NAA
695 * Registered Extended LUN WWN has been set via ConfigFS
696 * during device creation/restart.
698 if (cmd->se_dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL) {
699 buf[3] = ARRAY_SIZE(evpd_handlers);
700 for (p = 0; p < ARRAY_SIZE(evpd_handlers); ++p)
701 buf[p + 4] = evpd_handlers[p].page;
707 static sense_reason_t
708 spc_emulate_inquiry(struct se_cmd *cmd)
710 struct se_device *dev = cmd->se_dev;
711 struct se_portal_group *tpg = cmd->se_lun->lun_sep->sep_tpg;
713 unsigned char *cdb = cmd->t_task_cdb;
718 buf = kzalloc(SE_INQUIRY_BUF, GFP_KERNEL);
720 pr_err("Unable to allocate response buffer for INQUIRY\n");
721 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
724 if (dev == tpg->tpg_virt_lun0.lun_se_dev)
725 buf[0] = 0x3f; /* Not connected */
727 buf[0] = dev->transport->get_device_type(dev);
729 if (!(cdb[1] & 0x1)) {
731 pr_err("INQUIRY with EVPD==0 but PAGE CODE=%02x\n",
733 ret = TCM_INVALID_CDB_FIELD;
737 ret = spc_emulate_inquiry_std(cmd, buf);
741 for (p = 0; p < ARRAY_SIZE(evpd_handlers); ++p) {
742 if (cdb[2] == evpd_handlers[p].page) {
744 ret = evpd_handlers[p].emulate(cmd, buf);
749 pr_err("Unknown VPD Code: 0x%02x\n", cdb[2]);
750 ret = TCM_INVALID_CDB_FIELD;
753 rbuf = transport_kmap_data_sg(cmd);
755 memcpy(rbuf, buf, min_t(u32, SE_INQUIRY_BUF, cmd->data_length));
756 transport_kunmap_data_sg(cmd);
761 target_complete_cmd(cmd, GOOD);
765 static int spc_modesense_rwrecovery(struct se_device *dev, u8 pc, u8 *p)
770 /* No changeable values for now */
778 static int spc_modesense_control(struct se_device *dev, u8 pc, u8 *p)
783 /* No changeable values for now */
789 * From spc4r23, 7.4.7 Control mode page
791 * The QUEUE ALGORITHM MODIFIER field (see table 368) specifies
792 * restrictions on the algorithm used for reordering commands
793 * having the SIMPLE task attribute (see SAM-4).
795 * Table 368 -- QUEUE ALGORITHM MODIFIER field
797 * 0h Restricted reordering
798 * 1h Unrestricted reordering allowed
800 * 8h to Fh Vendor specific
802 * A value of zero in the QUEUE ALGORITHM MODIFIER field specifies that
803 * the device server shall order the processing sequence of commands
804 * having the SIMPLE task attribute such that data integrity is maintained
805 * for that I_T nexus (i.e., if the transmission of new SCSI transport protocol
806 * requests is halted at any time, the final value of all data observable
807 * on the medium shall be the same as if all the commands had been processed
808 * with the ORDERED task attribute).
810 * A value of one in the QUEUE ALGORITHM MODIFIER field specifies that the
811 * device server may reorder the processing sequence of commands having the
812 * SIMPLE task attribute in any manner. Any data integrity exposures related to
813 * command sequence order shall be explicitly handled by the application client
814 * through the selection of appropriate ommands and task attributes.
816 p[3] = (dev->dev_attrib.emulate_rest_reord == 1) ? 0x00 : 0x10;
818 * From spc4r17, section 7.4.6 Control mode Page
820 * Unit Attention interlocks control (UN_INTLCK_CTRL) to code 00b
822 * 00b: The logical unit shall clear any unit attention condition
823 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
824 * status and shall not establish a unit attention condition when a com-
825 * mand is completed with BUSY, TASK SET FULL, or RESERVATION CONFLICT
828 * 10b: The logical unit shall not clear any unit attention condition
829 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
830 * status and shall not establish a unit attention condition when
831 * a command is completed with BUSY, TASK SET FULL, or RESERVATION
834 * 11b a The logical unit shall not clear any unit attention condition
835 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
836 * status and shall establish a unit attention condition for the
837 * initiator port associated with the I_T nexus on which the BUSY,
838 * TASK SET FULL, or RESERVATION CONFLICT status is being returned.
839 * Depending on the status, the additional sense code shall be set to
840 * PREVIOUS BUSY STATUS, PREVIOUS TASK SET FULL STATUS, or PREVIOUS
841 * RESERVATION CONFLICT STATUS. Until it is cleared by a REQUEST SENSE
842 * command, a unit attention condition shall be established only once
843 * for a BUSY, TASK SET FULL, or RESERVATION CONFLICT status regardless
844 * to the number of commands completed with one of those status codes.
846 p[4] = (dev->dev_attrib.emulate_ua_intlck_ctrl == 2) ? 0x30 :
847 (dev->dev_attrib.emulate_ua_intlck_ctrl == 1) ? 0x20 : 0x00;
849 * From spc4r17, section 7.4.6 Control mode Page
851 * Task Aborted Status (TAS) bit set to zero.
853 * A task aborted status (TAS) bit set to zero specifies that aborted
854 * tasks shall be terminated by the device server without any response
855 * to the application client. A TAS bit set to one specifies that tasks
856 * aborted by the actions of an I_T nexus other than the I_T nexus on
857 * which the command was received shall be completed with TASK ABORTED
858 * status (see SAM-4).
860 p[5] = (dev->dev_attrib.emulate_tas) ? 0x40 : 0x00;
862 * From spc4r30, section 7.5.7 Control mode page
864 * Application Tag Owner (ATO) bit set to one.
866 * If the ATO bit is set to one the device server shall not modify the
867 * LOGICAL BLOCK APPLICATION TAG field and, depending on the protection
868 * type, shall not modify the contents of the LOGICAL BLOCK REFERENCE
871 if (dev->dev_attrib.pi_prot_type)
882 static int spc_modesense_caching(struct se_device *dev, u8 pc, u8 *p)
887 /* No changeable values for now */
891 if (spc_check_dev_wce(dev))
892 p[2] = 0x04; /* Write Cache Enable */
893 p[12] = 0x20; /* Disabled Read Ahead */
899 static int spc_modesense_informational_exceptions(struct se_device *dev, u8 pc, unsigned char *p)
904 /* No changeable values for now */
915 int (*emulate)(struct se_device *, u8, unsigned char *);
916 } modesense_handlers[] = {
917 { .page = 0x01, .subpage = 0x00, .emulate = spc_modesense_rwrecovery },
918 { .page = 0x08, .subpage = 0x00, .emulate = spc_modesense_caching },
919 { .page = 0x0a, .subpage = 0x00, .emulate = spc_modesense_control },
920 { .page = 0x1c, .subpage = 0x00, .emulate = spc_modesense_informational_exceptions },
923 static void spc_modesense_write_protect(unsigned char *buf, int type)
926 * I believe that the WP bit (bit 7) in the mode header is the same for
933 buf[0] |= 0x80; /* WP bit */
938 static void spc_modesense_dpofua(unsigned char *buf, int type)
942 buf[0] |= 0x10; /* DPOFUA bit */
949 static int spc_modesense_blockdesc(unsigned char *buf, u64 blocks, u32 block_size)
952 put_unaligned_be32(min(blocks, 0xffffffffull), buf);
954 put_unaligned_be32(block_size, buf);
958 static int spc_modesense_long_blockdesc(unsigned char *buf, u64 blocks, u32 block_size)
960 if (blocks <= 0xffffffff)
961 return spc_modesense_blockdesc(buf + 3, blocks, block_size) + 3;
963 *buf++ = 1; /* LONGLBA */
966 put_unaligned_be64(blocks, buf);
968 put_unaligned_be32(block_size, buf);
973 static sense_reason_t spc_emulate_modesense(struct se_cmd *cmd)
975 struct se_device *dev = cmd->se_dev;
976 char *cdb = cmd->t_task_cdb;
977 unsigned char buf[SE_MODE_PAGE_BUF], *rbuf;
978 int type = dev->transport->get_device_type(dev);
979 int ten = (cmd->t_task_cdb[0] == MODE_SENSE_10);
980 bool dbd = !!(cdb[1] & 0x08);
981 bool llba = ten ? !!(cdb[1] & 0x10) : false;
983 u8 page = cdb[2] & 0x3f;
989 memset(buf, 0, SE_MODE_PAGE_BUF);
992 * Skip over MODE DATA LENGTH + MEDIUM TYPE fields to byte 3 for
993 * MODE_SENSE_10 and byte 2 for MODE_SENSE (6).
995 length = ten ? 3 : 2;
997 /* DEVICE-SPECIFIC PARAMETER */
998 if ((cmd->se_lun->lun_access & TRANSPORT_LUNFLAGS_READ_ONLY) ||
1000 (cmd->se_deve->lun_flags & TRANSPORT_LUNFLAGS_READ_ONLY)))
1001 spc_modesense_write_protect(&buf[length], type);
1003 if ((spc_check_dev_wce(dev)) &&
1004 (dev->dev_attrib.emulate_fua_write > 0))
1005 spc_modesense_dpofua(&buf[length], type);
1009 /* BLOCK DESCRIPTOR */
1012 * For now we only include a block descriptor for disk (SBC)
1013 * devices; other command sets use a slightly different format.
1015 if (!dbd && type == TYPE_DISK) {
1016 u64 blocks = dev->transport->get_blocks(dev);
1017 u32 block_size = dev->dev_attrib.block_size;
1021 length += spc_modesense_long_blockdesc(&buf[length],
1022 blocks, block_size);
1025 length += spc_modesense_blockdesc(&buf[length],
1026 blocks, block_size);
1029 length += spc_modesense_blockdesc(&buf[length], blocks,
1040 if (subpage != 0x00 && subpage != 0xff) {
1041 pr_warn("MODE_SENSE: Invalid subpage code: 0x%02x\n", subpage);
1042 return TCM_INVALID_CDB_FIELD;
1045 for (i = 0; i < ARRAY_SIZE(modesense_handlers); ++i) {
1047 * Tricky way to say all subpage 00h for
1048 * subpage==0, all subpages for subpage==0xff
1049 * (and we just checked above that those are
1050 * the only two possibilities).
1052 if ((modesense_handlers[i].subpage & ~subpage) == 0) {
1053 ret = modesense_handlers[i].emulate(dev, pc, &buf[length]);
1054 if (!ten && length + ret >= 255)
1063 for (i = 0; i < ARRAY_SIZE(modesense_handlers); ++i)
1064 if (modesense_handlers[i].page == page &&
1065 modesense_handlers[i].subpage == subpage) {
1066 length += modesense_handlers[i].emulate(dev, pc, &buf[length]);
1071 * We don't intend to implement:
1072 * - obsolete page 03h "format parameters" (checked by Solaris)
1075 pr_err("MODE SENSE: unimplemented page/subpage: 0x%02x/0x%02x\n",
1078 return TCM_UNKNOWN_MODE_PAGE;
1082 put_unaligned_be16(length - 2, buf);
1084 buf[0] = length - 1;
1086 rbuf = transport_kmap_data_sg(cmd);
1088 memcpy(rbuf, buf, min_t(u32, SE_MODE_PAGE_BUF, cmd->data_length));
1089 transport_kunmap_data_sg(cmd);
1092 target_complete_cmd(cmd, GOOD);
1096 static sense_reason_t spc_emulate_modeselect(struct se_cmd *cmd)
1098 struct se_device *dev = cmd->se_dev;
1099 char *cdb = cmd->t_task_cdb;
1100 bool ten = cdb[0] == MODE_SELECT_10;
1101 int off = ten ? 8 : 4;
1102 bool pf = !!(cdb[1] & 0x10);
1105 unsigned char tbuf[SE_MODE_PAGE_BUF];
1110 if (!cmd->data_length) {
1111 target_complete_cmd(cmd, GOOD);
1115 if (cmd->data_length < off + 2)
1116 return TCM_PARAMETER_LIST_LENGTH_ERROR;
1118 buf = transport_kmap_data_sg(cmd);
1120 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1123 ret = TCM_INVALID_CDB_FIELD;
1127 page = buf[off] & 0x3f;
1128 subpage = buf[off] & 0x40 ? buf[off + 1] : 0;
1130 for (i = 0; i < ARRAY_SIZE(modesense_handlers); ++i)
1131 if (modesense_handlers[i].page == page &&
1132 modesense_handlers[i].subpage == subpage) {
1133 memset(tbuf, 0, SE_MODE_PAGE_BUF);
1134 length = modesense_handlers[i].emulate(dev, 0, tbuf);
1135 goto check_contents;
1138 ret = TCM_UNKNOWN_MODE_PAGE;
1142 if (cmd->data_length < off + length) {
1143 ret = TCM_PARAMETER_LIST_LENGTH_ERROR;
1147 if (memcmp(buf + off, tbuf, length))
1148 ret = TCM_INVALID_PARAMETER_LIST;
1151 transport_kunmap_data_sg(cmd);
1154 target_complete_cmd(cmd, GOOD);
1158 static sense_reason_t spc_emulate_request_sense(struct se_cmd *cmd)
1160 unsigned char *cdb = cmd->t_task_cdb;
1161 unsigned char *rbuf;
1162 u8 ua_asc = 0, ua_ascq = 0;
1163 unsigned char buf[SE_SENSE_BUF];
1165 memset(buf, 0, SE_SENSE_BUF);
1167 if (cdb[1] & 0x01) {
1168 pr_err("REQUEST_SENSE description emulation not"
1170 return TCM_INVALID_CDB_FIELD;
1173 rbuf = transport_kmap_data_sg(cmd);
1175 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1177 if (!core_scsi3_ua_clear_for_request_sense(cmd, &ua_asc, &ua_ascq)) {
1179 * CURRENT ERROR, UNIT ATTENTION
1182 buf[SPC_SENSE_KEY_OFFSET] = UNIT_ATTENTION;
1185 * The Additional Sense Code (ASC) from the UNIT ATTENTION
1187 buf[SPC_ASC_KEY_OFFSET] = ua_asc;
1188 buf[SPC_ASCQ_KEY_OFFSET] = ua_ascq;
1192 * CURRENT ERROR, NO SENSE
1195 buf[SPC_SENSE_KEY_OFFSET] = NO_SENSE;
1198 * NO ADDITIONAL SENSE INFORMATION
1200 buf[SPC_ASC_KEY_OFFSET] = 0x00;
1204 memcpy(rbuf, buf, min_t(u32, sizeof(buf), cmd->data_length));
1205 transport_kunmap_data_sg(cmd);
1207 target_complete_cmd(cmd, GOOD);
1211 sense_reason_t spc_emulate_report_luns(struct se_cmd *cmd)
1213 struct se_dev_entry *deve;
1214 struct se_session *sess = cmd->se_sess;
1216 u32 lun_count = 0, offset = 8, i;
1218 if (cmd->data_length < 16) {
1219 pr_warn("REPORT LUNS allocation length %u too small\n",
1221 return TCM_INVALID_CDB_FIELD;
1224 buf = transport_kmap_data_sg(cmd);
1226 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1229 * If no struct se_session pointer is present, this struct se_cmd is
1230 * coming via a target_core_mod PASSTHROUGH op, and not through
1231 * a $FABRIC_MOD. In that case, report LUN=0 only.
1234 int_to_scsilun(0, (struct scsi_lun *)&buf[offset]);
1239 spin_lock_irq(&sess->se_node_acl->device_list_lock);
1240 for (i = 0; i < TRANSPORT_MAX_LUNS_PER_TPG; i++) {
1241 deve = sess->se_node_acl->device_list[i];
1242 if (!(deve->lun_flags & TRANSPORT_LUNFLAGS_INITIATOR_ACCESS))
1245 * We determine the correct LUN LIST LENGTH even once we
1246 * have reached the initial allocation length.
1247 * See SPC2-R20 7.19.
1250 if ((offset + 8) > cmd->data_length)
1253 int_to_scsilun(deve->mapped_lun, (struct scsi_lun *)&buf[offset]);
1256 spin_unlock_irq(&sess->se_node_acl->device_list_lock);
1259 * See SPC3 r07, page 159.
1263 buf[0] = ((lun_count >> 24) & 0xff);
1264 buf[1] = ((lun_count >> 16) & 0xff);
1265 buf[2] = ((lun_count >> 8) & 0xff);
1266 buf[3] = (lun_count & 0xff);
1267 transport_kunmap_data_sg(cmd);
1269 target_complete_cmd(cmd, GOOD);
1272 EXPORT_SYMBOL(spc_emulate_report_luns);
1274 static sense_reason_t
1275 spc_emulate_testunitready(struct se_cmd *cmd)
1277 target_complete_cmd(cmd, GOOD);
1282 spc_parse_cdb(struct se_cmd *cmd, unsigned int *size)
1284 struct se_device *dev = cmd->se_dev;
1285 unsigned char *cdb = cmd->t_task_cdb;
1290 cmd->execute_cmd = spc_emulate_modeselect;
1292 case MODE_SELECT_10:
1293 *size = (cdb[7] << 8) + cdb[8];
1294 cmd->execute_cmd = spc_emulate_modeselect;
1298 cmd->execute_cmd = spc_emulate_modesense;
1301 *size = (cdb[7] << 8) + cdb[8];
1302 cmd->execute_cmd = spc_emulate_modesense;
1306 *size = (cdb[7] << 8) + cdb[8];
1308 case PERSISTENT_RESERVE_IN:
1309 *size = (cdb[7] << 8) + cdb[8];
1310 cmd->execute_cmd = target_scsi3_emulate_pr_in;
1312 case PERSISTENT_RESERVE_OUT:
1313 *size = (cdb[7] << 8) + cdb[8];
1314 cmd->execute_cmd = target_scsi3_emulate_pr_out;
1318 if (cdb[0] == RELEASE_10)
1319 *size = (cdb[7] << 8) | cdb[8];
1321 *size = cmd->data_length;
1323 cmd->execute_cmd = target_scsi2_reservation_release;
1328 * The SPC-2 RESERVE does not contain a size in the SCSI CDB.
1329 * Assume the passthrough or $FABRIC_MOD will tell us about it.
1331 if (cdb[0] == RESERVE_10)
1332 *size = (cdb[7] << 8) | cdb[8];
1334 *size = cmd->data_length;
1336 cmd->execute_cmd = target_scsi2_reservation_reserve;
1340 cmd->execute_cmd = spc_emulate_request_sense;
1343 *size = (cdb[3] << 8) + cdb[4];
1346 * Do implicit HEAD_OF_QUEUE processing for INQUIRY.
1347 * See spc4r17 section 5.3
1349 cmd->sam_task_attr = MSG_HEAD_TAG;
1350 cmd->execute_cmd = spc_emulate_inquiry;
1352 case SECURITY_PROTOCOL_IN:
1353 case SECURITY_PROTOCOL_OUT:
1354 *size = (cdb[6] << 24) | (cdb[7] << 16) | (cdb[8] << 8) | cdb[9];
1357 *size = get_unaligned_be32(&cdb[10]);
1358 cmd->execute_cmd = target_do_xcopy;
1360 case RECEIVE_COPY_RESULTS:
1361 *size = get_unaligned_be32(&cdb[10]);
1362 cmd->execute_cmd = target_do_receive_copy_results;
1364 case READ_ATTRIBUTE:
1365 case WRITE_ATTRIBUTE:
1366 *size = (cdb[10] << 24) | (cdb[11] << 16) |
1367 (cdb[12] << 8) | cdb[13];
1369 case RECEIVE_DIAGNOSTIC:
1370 case SEND_DIAGNOSTIC:
1371 *size = (cdb[3] << 8) | cdb[4];
1374 *size = (cdb[6] << 16) + (cdb[7] << 8) + cdb[8];
1377 cmd->execute_cmd = spc_emulate_report_luns;
1378 *size = (cdb[6] << 24) | (cdb[7] << 16) | (cdb[8] << 8) | cdb[9];
1380 * Do implicit HEAD_OF_QUEUE processing for REPORT_LUNS
1381 * See spc4r17 section 5.3
1383 cmd->sam_task_attr = MSG_HEAD_TAG;
1385 case TEST_UNIT_READY:
1386 cmd->execute_cmd = spc_emulate_testunitready;
1389 case MAINTENANCE_IN:
1390 if (dev->transport->get_device_type(dev) != TYPE_ROM) {
1392 * MAINTENANCE_IN from SCC-2
1393 * Check for emulated MI_REPORT_TARGET_PGS
1395 if ((cdb[1] & 0x1f) == MI_REPORT_TARGET_PGS) {
1397 target_emulate_report_target_port_groups;
1399 *size = get_unaligned_be32(&cdb[6]);
1402 * GPCMD_SEND_KEY from multi media commands
1404 *size = get_unaligned_be16(&cdb[8]);
1407 case MAINTENANCE_OUT:
1408 if (dev->transport->get_device_type(dev) != TYPE_ROM) {
1410 * MAINTENANCE_OUT from SCC-2
1411 * Check for emulated MO_SET_TARGET_PGS.
1413 if (cdb[1] == MO_SET_TARGET_PGS) {
1415 target_emulate_set_target_port_groups;
1417 *size = get_unaligned_be32(&cdb[6]);
1420 * GPCMD_SEND_KEY from multi media commands
1422 *size = get_unaligned_be16(&cdb[8]);
1426 pr_warn("TARGET_CORE[%s]: Unsupported SCSI Opcode"
1427 " 0x%02x, sending CHECK_CONDITION.\n",
1428 cmd->se_tfo->get_fabric_name(), cdb[0]);
1429 return TCM_UNSUPPORTED_SCSI_OPCODE;
1434 EXPORT_SYMBOL(spc_parse_cdb);