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 explict and/or implict 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 buf[7] = 0x2; /* CmdQue=1 */
106 snprintf(&buf[8], 8, "LIO-ORG");
107 snprintf(&buf[16], 16, "%s", dev->t10_wwn.model);
108 snprintf(&buf[32], 4, "%s", dev->t10_wwn.revision);
109 buf[4] = 31; /* Set additional length to 31 */
113 EXPORT_SYMBOL(spc_emulate_inquiry_std);
115 /* unit serial number */
116 static sense_reason_t
117 spc_emulate_evpd_80(struct se_cmd *cmd, unsigned char *buf)
119 struct se_device *dev = cmd->se_dev;
122 if (dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL) {
125 unit_serial_len = strlen(dev->t10_wwn.unit_serial);
126 unit_serial_len++; /* For NULL Terminator */
128 len += sprintf(&buf[4], "%s", dev->t10_wwn.unit_serial);
129 len++; /* Extra Byte for NULL Terminator */
135 void spc_parse_naa_6h_vendor_specific(struct se_device *dev,
138 unsigned char *p = &dev->t10_wwn.unit_serial[0];
143 * Generate up to 36 bits of VENDOR SPECIFIC IDENTIFIER starting on
144 * byte 3 bit 3-0 for NAA IEEE Registered Extended DESIGNATOR field
145 * format, followed by 64 bits of VENDOR SPECIFIC IDENTIFIER EXTENSION
146 * to complete the payload. These are based from VPD=0x80 PRODUCT SERIAL
147 * NUMBER set via vpd_unit_serial in target_core_configfs.c to ensure
148 * per device uniqeness.
150 for (cnt = 0; *p && cnt < 13; p++) {
151 int val = hex_to_bin(*p);
167 * Device identification VPD, for a complete list of
168 * DESIGNATOR TYPEs see spc4r17 Table 459.
171 spc_emulate_evpd_83(struct se_cmd *cmd, unsigned char *buf)
173 struct se_device *dev = cmd->se_dev;
174 struct se_lun *lun = cmd->se_lun;
175 struct se_port *port = NULL;
176 struct se_portal_group *tpg = NULL;
177 struct t10_alua_lu_gp_member *lu_gp_mem;
178 struct t10_alua_tg_pt_gp *tg_pt_gp;
179 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
180 unsigned char *prod = &dev->t10_wwn.model[0];
182 u32 unit_serial_len, off = 0;
188 * NAA IEEE Registered Extended Assigned designator format, see
189 * spc4r17 section 7.7.3.6.5
191 * We depend upon a target_core_mod/ConfigFS provided
192 * /sys/kernel/config/target/core/$HBA/$DEV/wwn/vpd_unit_serial
193 * value in order to return the NAA id.
195 if (!(dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL))
196 goto check_t10_vend_desc;
198 /* CODE SET == Binary */
201 /* Set ASSOCIATION == addressed logical unit: 0)b */
204 /* Identifier/Designator type == NAA identifier */
208 /* Identifier/Designator length */
212 * Start NAA IEEE Registered Extended Identifier/Designator
214 buf[off++] = (0x6 << 4);
217 * Use OpenFabrics IEEE Company ID: 00 14 05
221 buf[off] = (0x5 << 4);
224 * Return ConfigFS Unit Serial Number information for
225 * VENDOR_SPECIFIC_IDENTIFIER and
226 * VENDOR_SPECIFIC_IDENTIFIER_EXTENTION
228 spc_parse_naa_6h_vendor_specific(dev, &buf[off]);
235 * T10 Vendor Identifier Page, see spc4r17 section 7.7.3.4
237 id_len = 8; /* For Vendor field */
238 prod_len = 4; /* For VPD Header */
239 prod_len += 8; /* For Vendor field */
240 prod_len += strlen(prod);
241 prod_len++; /* For : */
243 if (dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL) {
244 unit_serial_len = strlen(&dev->t10_wwn.unit_serial[0]);
245 unit_serial_len++; /* For NULL Terminator */
247 id_len += sprintf(&buf[off+12], "%s:%s", prod,
248 &dev->t10_wwn.unit_serial[0]);
250 buf[off] = 0x2; /* ASCII */
251 buf[off+1] = 0x1; /* T10 Vendor ID */
253 memcpy(&buf[off+4], "LIO-ORG", 8);
254 /* Extra Byte for NULL Terminator */
256 /* Identifier Length */
258 /* Header size for Designation descriptor */
262 * struct se_port is only set for INQUIRY VPD=1 through $FABRIC_MOD
266 struct t10_alua_lu_gp *lu_gp;
267 u32 padding, scsi_name_len;
274 * Relative target port identifer, see spc4r17
277 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
278 * section 7.5.1 Table 362
281 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
282 buf[off++] |= 0x1; /* CODE SET == Binary */
283 buf[off] = 0x80; /* Set PIV=1 */
284 /* Set ASSOCIATION == target port: 01b */
286 /* DESIGNATOR TYPE == Relative target port identifer */
288 off++; /* Skip over Reserved */
289 buf[off++] = 4; /* DESIGNATOR LENGTH */
290 /* Skip over Obsolete field in RTPI payload
293 buf[off++] = ((port->sep_rtpi >> 8) & 0xff);
294 buf[off++] = (port->sep_rtpi & 0xff);
295 len += 8; /* Header size + Designation descriptor */
297 * Target port group identifier, see spc4r17
300 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
301 * section 7.5.1 Table 362
303 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
307 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
308 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
310 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
313 tg_pt_gp_id = tg_pt_gp->tg_pt_gp_id;
314 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
317 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
318 buf[off++] |= 0x1; /* CODE SET == Binary */
319 buf[off] = 0x80; /* Set PIV=1 */
320 /* Set ASSOCIATION == target port: 01b */
322 /* DESIGNATOR TYPE == Target port group identifier */
324 off++; /* Skip over Reserved */
325 buf[off++] = 4; /* DESIGNATOR LENGTH */
326 off += 2; /* Skip over Reserved Field */
327 buf[off++] = ((tg_pt_gp_id >> 8) & 0xff);
328 buf[off++] = (tg_pt_gp_id & 0xff);
329 len += 8; /* Header size + Designation descriptor */
331 * Logical Unit Group identifier, see spc4r17
335 lu_gp_mem = dev->dev_alua_lu_gp_mem;
337 goto check_scsi_name;
339 spin_lock(&lu_gp_mem->lu_gp_mem_lock);
340 lu_gp = lu_gp_mem->lu_gp;
342 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
343 goto check_scsi_name;
345 lu_gp_id = lu_gp->lu_gp_id;
346 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
348 buf[off++] |= 0x1; /* CODE SET == Binary */
349 /* DESIGNATOR TYPE == Logical Unit Group identifier */
351 off++; /* Skip over Reserved */
352 buf[off++] = 4; /* DESIGNATOR LENGTH */
353 off += 2; /* Skip over Reserved Field */
354 buf[off++] = ((lu_gp_id >> 8) & 0xff);
355 buf[off++] = (lu_gp_id & 0xff);
356 len += 8; /* Header size + Designation descriptor */
358 * SCSI name string designator, see spc4r17
361 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
362 * section 7.5.1 Table 362
365 scsi_name_len = strlen(tpg->se_tpg_tfo->tpg_get_wwn(tpg));
366 /* UTF-8 ",t,0x<16-bit TPGT>" + NULL Terminator */
368 /* Check for 4-byte padding */
369 padding = ((-scsi_name_len) & 3);
371 scsi_name_len += padding;
372 /* Header size + Designation descriptor */
376 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
377 buf[off++] |= 0x3; /* CODE SET == UTF-8 */
378 buf[off] = 0x80; /* Set PIV=1 */
379 /* Set ASSOCIATION == target port: 01b */
381 /* DESIGNATOR TYPE == SCSI name string */
383 off += 2; /* Skip over Reserved and length */
385 * SCSI name string identifer containing, $FABRIC_MOD
386 * dependent information. For LIO-Target and iSCSI
387 * Target Port, this means "<iSCSI name>,t,0x<TPGT> in
390 tpgt = tpg->se_tpg_tfo->tpg_get_tag(tpg);
391 scsi_name_len = sprintf(&buf[off], "%s,t,0x%04x",
392 tpg->se_tpg_tfo->tpg_get_wwn(tpg), tpgt);
393 scsi_name_len += 1 /* Include NULL terminator */;
395 * The null-terminated, null-padded (see 4.4.2) SCSI
396 * NAME STRING field contains a UTF-8 format string.
397 * The number of bytes in the SCSI NAME STRING field
398 * (i.e., the value in the DESIGNATOR LENGTH field)
399 * shall be no larger than 256 and shall be a multiple
403 scsi_name_len += padding;
405 buf[off-1] = scsi_name_len;
406 off += scsi_name_len;
407 /* Header size + Designation descriptor */
408 len += (scsi_name_len + 4);
410 buf[2] = ((len >> 8) & 0xff);
411 buf[3] = (len & 0xff); /* Page Length for VPD 0x83 */
414 EXPORT_SYMBOL(spc_emulate_evpd_83);
417 spc_check_dev_wce(struct se_device *dev)
421 if (dev->transport->get_write_cache)
422 wce = dev->transport->get_write_cache(dev);
423 else if (dev->dev_attrib.emulate_write_cache > 0)
429 /* Extended INQUIRY Data VPD Page */
430 static sense_reason_t
431 spc_emulate_evpd_86(struct se_cmd *cmd, unsigned char *buf)
433 struct se_device *dev = cmd->se_dev;
436 /* Set HEADSUP, ORDSUP, SIMPSUP */
439 /* If WriteCache emulation is enabled, set V_SUP */
440 if (spc_check_dev_wce(dev))
445 /* Block Limits VPD page */
446 static sense_reason_t
447 spc_emulate_evpd_b0(struct se_cmd *cmd, unsigned char *buf)
449 struct se_device *dev = cmd->se_dev;
454 * Following spc3r22 section 6.5.3 Block Limits VPD page, when
455 * emulate_tpu=1 or emulate_tpws=1 we will be expect a
456 * different page length for Thin Provisioning.
458 if (dev->dev_attrib.emulate_tpu || dev->dev_attrib.emulate_tpws)
461 buf[0] = dev->transport->get_device_type(dev);
462 buf[3] = have_tp ? 0x3c : 0x10;
467 * Set MAXIMUM COMPARE AND WRITE LENGTH
469 if (dev->dev_attrib.emulate_caw)
473 * Set OPTIMAL TRANSFER LENGTH GRANULARITY
475 put_unaligned_be16(1, &buf[6]);
478 * Set MAXIMUM TRANSFER LENGTH
480 max_sectors = min(dev->dev_attrib.fabric_max_sectors,
481 dev->dev_attrib.hw_max_sectors);
482 put_unaligned_be32(max_sectors, &buf[8]);
485 * Set OPTIMAL TRANSFER LENGTH
487 put_unaligned_be32(dev->dev_attrib.optimal_sectors, &buf[12]);
490 * Exit now if we don't support TP.
496 * Set MAXIMUM UNMAP LBA COUNT
498 put_unaligned_be32(dev->dev_attrib.max_unmap_lba_count, &buf[20]);
501 * Set MAXIMUM UNMAP BLOCK DESCRIPTOR COUNT
503 put_unaligned_be32(dev->dev_attrib.max_unmap_block_desc_count,
507 * Set OPTIMAL UNMAP GRANULARITY
509 put_unaligned_be32(dev->dev_attrib.unmap_granularity, &buf[28]);
512 * UNMAP GRANULARITY ALIGNMENT
514 put_unaligned_be32(dev->dev_attrib.unmap_granularity_alignment,
516 if (dev->dev_attrib.unmap_granularity_alignment != 0)
517 buf[32] |= 0x80; /* Set the UGAVALID bit */
520 * MAXIMUM WRITE SAME LENGTH
523 put_unaligned_be64(dev->dev_attrib.max_write_same_len, &buf[36]);
528 /* Block Device Characteristics VPD page */
529 static sense_reason_t
530 spc_emulate_evpd_b1(struct se_cmd *cmd, unsigned char *buf)
532 struct se_device *dev = cmd->se_dev;
534 buf[0] = dev->transport->get_device_type(dev);
536 buf[5] = dev->dev_attrib.is_nonrot ? 1 : 0;
541 /* Thin Provisioning VPD */
542 static sense_reason_t
543 spc_emulate_evpd_b2(struct se_cmd *cmd, unsigned char *buf)
545 struct se_device *dev = cmd->se_dev;
548 * From spc3r22 section 6.5.4 Thin Provisioning VPD page:
550 * The PAGE LENGTH field is defined in SPC-4. If the DP bit is set to
551 * zero, then the page length shall be set to 0004h. If the DP bit
552 * is set to one, then the page length shall be set to the value
553 * defined in table 162.
555 buf[0] = dev->transport->get_device_type(dev);
558 * Set Hardcoded length mentioned above for DP=0
560 put_unaligned_be16(0x0004, &buf[2]);
563 * The THRESHOLD EXPONENT field indicates the threshold set size in
564 * LBAs as a power of 2 (i.e., the threshold set size is equal to
565 * 2(threshold exponent)).
567 * Note that this is currently set to 0x00 as mkp says it will be
568 * changing again. We can enable this once it has settled in T10
569 * and is actually used by Linux/SCSI ML code.
574 * A TPU bit set to one indicates that the device server supports
575 * the UNMAP command (see 5.25). A TPU bit set to zero indicates
576 * that the device server does not support the UNMAP command.
578 if (dev->dev_attrib.emulate_tpu != 0)
582 * A TPWS bit set to one indicates that the device server supports
583 * the use of the WRITE SAME (16) command (see 5.42) to unmap LBAs.
584 * A TPWS bit set to zero indicates that the device server does not
585 * support the use of the WRITE SAME (16) command to unmap LBAs.
587 if (dev->dev_attrib.emulate_tpws != 0)
593 static sense_reason_t
594 spc_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf);
598 sense_reason_t (*emulate)(struct se_cmd *, unsigned char *);
599 } evpd_handlers[] = {
600 { .page = 0x00, .emulate = spc_emulate_evpd_00 },
601 { .page = 0x80, .emulate = spc_emulate_evpd_80 },
602 { .page = 0x83, .emulate = spc_emulate_evpd_83 },
603 { .page = 0x86, .emulate = spc_emulate_evpd_86 },
604 { .page = 0xb0, .emulate = spc_emulate_evpd_b0 },
605 { .page = 0xb1, .emulate = spc_emulate_evpd_b1 },
606 { .page = 0xb2, .emulate = spc_emulate_evpd_b2 },
609 /* supported vital product data pages */
610 static sense_reason_t
611 spc_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf)
616 * Only report the INQUIRY EVPD=1 pages after a valid NAA
617 * Registered Extended LUN WWN has been set via ConfigFS
618 * during device creation/restart.
620 if (cmd->se_dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL) {
621 buf[3] = ARRAY_SIZE(evpd_handlers);
622 for (p = 0; p < ARRAY_SIZE(evpd_handlers); ++p)
623 buf[p + 4] = evpd_handlers[p].page;
629 static sense_reason_t
630 spc_emulate_inquiry(struct se_cmd *cmd)
632 struct se_device *dev = cmd->se_dev;
633 struct se_portal_group *tpg = cmd->se_lun->lun_sep->sep_tpg;
635 unsigned char *cdb = cmd->t_task_cdb;
636 unsigned char buf[SE_INQUIRY_BUF];
640 memset(buf, 0, SE_INQUIRY_BUF);
642 if (dev == tpg->tpg_virt_lun0.lun_se_dev)
643 buf[0] = 0x3f; /* Not connected */
645 buf[0] = dev->transport->get_device_type(dev);
647 if (!(cdb[1] & 0x1)) {
649 pr_err("INQUIRY with EVPD==0 but PAGE CODE=%02x\n",
651 ret = TCM_INVALID_CDB_FIELD;
655 ret = spc_emulate_inquiry_std(cmd, buf);
659 for (p = 0; p < ARRAY_SIZE(evpd_handlers); ++p) {
660 if (cdb[2] == evpd_handlers[p].page) {
662 ret = evpd_handlers[p].emulate(cmd, buf);
667 pr_err("Unknown VPD Code: 0x%02x\n", cdb[2]);
668 ret = TCM_INVALID_CDB_FIELD;
671 rbuf = transport_kmap_data_sg(cmd);
673 memcpy(rbuf, buf, min_t(u32, sizeof(buf), cmd->data_length));
674 transport_kunmap_data_sg(cmd);
678 target_complete_cmd(cmd, GOOD);
682 static int spc_modesense_rwrecovery(struct se_device *dev, u8 pc, u8 *p)
687 /* No changeable values for now */
695 static int spc_modesense_control(struct se_device *dev, u8 pc, u8 *p)
700 /* No changeable values for now */
706 * From spc4r23, 7.4.7 Control mode page
708 * The QUEUE ALGORITHM MODIFIER field (see table 368) specifies
709 * restrictions on the algorithm used for reordering commands
710 * having the SIMPLE task attribute (see SAM-4).
712 * Table 368 -- QUEUE ALGORITHM MODIFIER field
714 * 0h Restricted reordering
715 * 1h Unrestricted reordering allowed
717 * 8h to Fh Vendor specific
719 * A value of zero in the QUEUE ALGORITHM MODIFIER field specifies that
720 * the device server shall order the processing sequence of commands
721 * having the SIMPLE task attribute such that data integrity is maintained
722 * for that I_T nexus (i.e., if the transmission of new SCSI transport protocol
723 * requests is halted at any time, the final value of all data observable
724 * on the medium shall be the same as if all the commands had been processed
725 * with the ORDERED task attribute).
727 * A value of one in the QUEUE ALGORITHM MODIFIER field specifies that the
728 * device server may reorder the processing sequence of commands having the
729 * SIMPLE task attribute in any manner. Any data integrity exposures related to
730 * command sequence order shall be explicitly handled by the application client
731 * through the selection of appropriate ommands and task attributes.
733 p[3] = (dev->dev_attrib.emulate_rest_reord == 1) ? 0x00 : 0x10;
735 * From spc4r17, section 7.4.6 Control mode Page
737 * Unit Attention interlocks control (UN_INTLCK_CTRL) to code 00b
739 * 00b: The logical unit shall clear any unit attention condition
740 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
741 * status and shall not establish a unit attention condition when a com-
742 * mand is completed with BUSY, TASK SET FULL, or RESERVATION CONFLICT
745 * 10b: The logical unit shall not clear any unit attention condition
746 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
747 * status and shall not establish a unit attention condition when
748 * a command is completed with BUSY, TASK SET FULL, or RESERVATION
751 * 11b a The logical unit shall not clear any unit attention condition
752 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
753 * status and shall establish a unit attention condition for the
754 * initiator port associated with the I_T nexus on which the BUSY,
755 * TASK SET FULL, or RESERVATION CONFLICT status is being returned.
756 * Depending on the status, the additional sense code shall be set to
757 * PREVIOUS BUSY STATUS, PREVIOUS TASK SET FULL STATUS, or PREVIOUS
758 * RESERVATION CONFLICT STATUS. Until it is cleared by a REQUEST SENSE
759 * command, a unit attention condition shall be established only once
760 * for a BUSY, TASK SET FULL, or RESERVATION CONFLICT status regardless
761 * to the number of commands completed with one of those status codes.
763 p[4] = (dev->dev_attrib.emulate_ua_intlck_ctrl == 2) ? 0x30 :
764 (dev->dev_attrib.emulate_ua_intlck_ctrl == 1) ? 0x20 : 0x00;
766 * From spc4r17, section 7.4.6 Control mode Page
768 * Task Aborted Status (TAS) bit set to zero.
770 * A task aborted status (TAS) bit set to zero specifies that aborted
771 * tasks shall be terminated by the device server without any response
772 * to the application client. A TAS bit set to one specifies that tasks
773 * aborted by the actions of an I_T nexus other than the I_T nexus on
774 * which the command was received shall be completed with TASK ABORTED
775 * status (see SAM-4).
777 p[5] = (dev->dev_attrib.emulate_tas) ? 0x40 : 0x00;
786 static int spc_modesense_caching(struct se_device *dev, u8 pc, u8 *p)
791 /* No changeable values for now */
795 if (spc_check_dev_wce(dev))
796 p[2] = 0x04; /* Write Cache Enable */
797 p[12] = 0x20; /* Disabled Read Ahead */
803 static int spc_modesense_informational_exceptions(struct se_device *dev, u8 pc, unsigned char *p)
808 /* No changeable values for now */
819 int (*emulate)(struct se_device *, u8, unsigned char *);
820 } modesense_handlers[] = {
821 { .page = 0x01, .subpage = 0x00, .emulate = spc_modesense_rwrecovery },
822 { .page = 0x08, .subpage = 0x00, .emulate = spc_modesense_caching },
823 { .page = 0x0a, .subpage = 0x00, .emulate = spc_modesense_control },
824 { .page = 0x1c, .subpage = 0x00, .emulate = spc_modesense_informational_exceptions },
827 static void spc_modesense_write_protect(unsigned char *buf, int type)
830 * I believe that the WP bit (bit 7) in the mode header is the same for
837 buf[0] |= 0x80; /* WP bit */
842 static void spc_modesense_dpofua(unsigned char *buf, int type)
846 buf[0] |= 0x10; /* DPOFUA bit */
853 static int spc_modesense_blockdesc(unsigned char *buf, u64 blocks, u32 block_size)
856 put_unaligned_be32(min(blocks, 0xffffffffull), buf);
858 put_unaligned_be32(block_size, buf);
862 static int spc_modesense_long_blockdesc(unsigned char *buf, u64 blocks, u32 block_size)
864 if (blocks <= 0xffffffff)
865 return spc_modesense_blockdesc(buf + 3, blocks, block_size) + 3;
867 *buf++ = 1; /* LONGLBA */
870 put_unaligned_be64(blocks, buf);
872 put_unaligned_be32(block_size, buf);
877 static sense_reason_t spc_emulate_modesense(struct se_cmd *cmd)
879 struct se_device *dev = cmd->se_dev;
880 char *cdb = cmd->t_task_cdb;
881 unsigned char buf[SE_MODE_PAGE_BUF], *rbuf;
882 int type = dev->transport->get_device_type(dev);
883 int ten = (cmd->t_task_cdb[0] == MODE_SENSE_10);
884 bool dbd = !!(cdb[1] & 0x08);
885 bool llba = ten ? !!(cdb[1] & 0x10) : false;
887 u8 page = cdb[2] & 0x3f;
893 memset(buf, 0, SE_MODE_PAGE_BUF);
896 * Skip over MODE DATA LENGTH + MEDIUM TYPE fields to byte 3 for
897 * MODE_SENSE_10 and byte 2 for MODE_SENSE (6).
899 length = ten ? 3 : 2;
901 /* DEVICE-SPECIFIC PARAMETER */
902 if ((cmd->se_lun->lun_access & TRANSPORT_LUNFLAGS_READ_ONLY) ||
904 (cmd->se_deve->lun_flags & TRANSPORT_LUNFLAGS_READ_ONLY)))
905 spc_modesense_write_protect(&buf[length], type);
907 if ((spc_check_dev_wce(dev)) &&
908 (dev->dev_attrib.emulate_fua_write > 0))
909 spc_modesense_dpofua(&buf[length], type);
913 /* BLOCK DESCRIPTOR */
916 * For now we only include a block descriptor for disk (SBC)
917 * devices; other command sets use a slightly different format.
919 if (!dbd && type == TYPE_DISK) {
920 u64 blocks = dev->transport->get_blocks(dev);
921 u32 block_size = dev->dev_attrib.block_size;
925 length += spc_modesense_long_blockdesc(&buf[length],
929 length += spc_modesense_blockdesc(&buf[length],
933 length += spc_modesense_blockdesc(&buf[length], blocks,
944 if (subpage != 0x00 && subpage != 0xff) {
945 pr_warn("MODE_SENSE: Invalid subpage code: 0x%02x\n", subpage);
946 return TCM_INVALID_CDB_FIELD;
949 for (i = 0; i < ARRAY_SIZE(modesense_handlers); ++i) {
951 * Tricky way to say all subpage 00h for
952 * subpage==0, all subpages for subpage==0xff
953 * (and we just checked above that those are
954 * the only two possibilities).
956 if ((modesense_handlers[i].subpage & ~subpage) == 0) {
957 ret = modesense_handlers[i].emulate(dev, pc, &buf[length]);
958 if (!ten && length + ret >= 255)
967 for (i = 0; i < ARRAY_SIZE(modesense_handlers); ++i)
968 if (modesense_handlers[i].page == page &&
969 modesense_handlers[i].subpage == subpage) {
970 length += modesense_handlers[i].emulate(dev, pc, &buf[length]);
975 * We don't intend to implement:
976 * - obsolete page 03h "format parameters" (checked by Solaris)
979 pr_err("MODE SENSE: unimplemented page/subpage: 0x%02x/0x%02x\n",
982 return TCM_UNKNOWN_MODE_PAGE;
986 put_unaligned_be16(length - 2, buf);
990 rbuf = transport_kmap_data_sg(cmd);
992 memcpy(rbuf, buf, min_t(u32, SE_MODE_PAGE_BUF, cmd->data_length));
993 transport_kunmap_data_sg(cmd);
996 target_complete_cmd(cmd, GOOD);
1000 static sense_reason_t spc_emulate_modeselect(struct se_cmd *cmd)
1002 struct se_device *dev = cmd->se_dev;
1003 char *cdb = cmd->t_task_cdb;
1004 bool ten = cdb[0] == MODE_SELECT_10;
1005 int off = ten ? 8 : 4;
1006 bool pf = !!(cdb[1] & 0x10);
1009 unsigned char tbuf[SE_MODE_PAGE_BUF];
1014 if (!cmd->data_length) {
1015 target_complete_cmd(cmd, GOOD);
1019 if (cmd->data_length < off + 2)
1020 return TCM_PARAMETER_LIST_LENGTH_ERROR;
1022 buf = transport_kmap_data_sg(cmd);
1024 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1027 ret = TCM_INVALID_CDB_FIELD;
1031 page = buf[off] & 0x3f;
1032 subpage = buf[off] & 0x40 ? buf[off + 1] : 0;
1034 for (i = 0; i < ARRAY_SIZE(modesense_handlers); ++i)
1035 if (modesense_handlers[i].page == page &&
1036 modesense_handlers[i].subpage == subpage) {
1037 memset(tbuf, 0, SE_MODE_PAGE_BUF);
1038 length = modesense_handlers[i].emulate(dev, 0, tbuf);
1039 goto check_contents;
1042 ret = TCM_UNKNOWN_MODE_PAGE;
1046 if (cmd->data_length < off + length) {
1047 ret = TCM_PARAMETER_LIST_LENGTH_ERROR;
1051 if (memcmp(buf + off, tbuf, length))
1052 ret = TCM_INVALID_PARAMETER_LIST;
1055 transport_kunmap_data_sg(cmd);
1058 target_complete_cmd(cmd, GOOD);
1062 static sense_reason_t spc_emulate_request_sense(struct se_cmd *cmd)
1064 unsigned char *cdb = cmd->t_task_cdb;
1065 unsigned char *rbuf;
1066 u8 ua_asc = 0, ua_ascq = 0;
1067 unsigned char buf[SE_SENSE_BUF];
1069 memset(buf, 0, SE_SENSE_BUF);
1071 if (cdb[1] & 0x01) {
1072 pr_err("REQUEST_SENSE description emulation not"
1074 return TCM_INVALID_CDB_FIELD;
1077 rbuf = transport_kmap_data_sg(cmd);
1079 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1081 if (!core_scsi3_ua_clear_for_request_sense(cmd, &ua_asc, &ua_ascq)) {
1083 * CURRENT ERROR, UNIT ATTENTION
1086 buf[SPC_SENSE_KEY_OFFSET] = UNIT_ATTENTION;
1089 * The Additional Sense Code (ASC) from the UNIT ATTENTION
1091 buf[SPC_ASC_KEY_OFFSET] = ua_asc;
1092 buf[SPC_ASCQ_KEY_OFFSET] = ua_ascq;
1096 * CURRENT ERROR, NO SENSE
1099 buf[SPC_SENSE_KEY_OFFSET] = NO_SENSE;
1102 * NO ADDITIONAL SENSE INFORMATION
1104 buf[SPC_ASC_KEY_OFFSET] = 0x00;
1108 memcpy(rbuf, buf, min_t(u32, sizeof(buf), cmd->data_length));
1109 transport_kunmap_data_sg(cmd);
1111 target_complete_cmd(cmd, GOOD);
1115 sense_reason_t spc_emulate_report_luns(struct se_cmd *cmd)
1117 struct se_dev_entry *deve;
1118 struct se_session *sess = cmd->se_sess;
1120 u32 lun_count = 0, offset = 8, i;
1122 if (cmd->data_length < 16) {
1123 pr_warn("REPORT LUNS allocation length %u too small\n",
1125 return TCM_INVALID_CDB_FIELD;
1128 buf = transport_kmap_data_sg(cmd);
1130 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1133 * If no struct se_session pointer is present, this struct se_cmd is
1134 * coming via a target_core_mod PASSTHROUGH op, and not through
1135 * a $FABRIC_MOD. In that case, report LUN=0 only.
1138 int_to_scsilun(0, (struct scsi_lun *)&buf[offset]);
1143 spin_lock_irq(&sess->se_node_acl->device_list_lock);
1144 for (i = 0; i < TRANSPORT_MAX_LUNS_PER_TPG; i++) {
1145 deve = sess->se_node_acl->device_list[i];
1146 if (!(deve->lun_flags & TRANSPORT_LUNFLAGS_INITIATOR_ACCESS))
1149 * We determine the correct LUN LIST LENGTH even once we
1150 * have reached the initial allocation length.
1151 * See SPC2-R20 7.19.
1154 if ((offset + 8) > cmd->data_length)
1157 int_to_scsilun(deve->mapped_lun, (struct scsi_lun *)&buf[offset]);
1160 spin_unlock_irq(&sess->se_node_acl->device_list_lock);
1163 * See SPC3 r07, page 159.
1167 buf[0] = ((lun_count >> 24) & 0xff);
1168 buf[1] = ((lun_count >> 16) & 0xff);
1169 buf[2] = ((lun_count >> 8) & 0xff);
1170 buf[3] = (lun_count & 0xff);
1171 transport_kunmap_data_sg(cmd);
1173 target_complete_cmd(cmd, GOOD);
1176 EXPORT_SYMBOL(spc_emulate_report_luns);
1178 static sense_reason_t
1179 spc_emulate_testunitready(struct se_cmd *cmd)
1181 target_complete_cmd(cmd, GOOD);
1186 spc_parse_cdb(struct se_cmd *cmd, unsigned int *size)
1188 struct se_device *dev = cmd->se_dev;
1189 unsigned char *cdb = cmd->t_task_cdb;
1194 cmd->execute_cmd = spc_emulate_modeselect;
1196 case MODE_SELECT_10:
1197 *size = (cdb[7] << 8) + cdb[8];
1198 cmd->execute_cmd = spc_emulate_modeselect;
1202 cmd->execute_cmd = spc_emulate_modesense;
1205 *size = (cdb[7] << 8) + cdb[8];
1206 cmd->execute_cmd = spc_emulate_modesense;
1210 *size = (cdb[7] << 8) + cdb[8];
1212 case PERSISTENT_RESERVE_IN:
1213 *size = (cdb[7] << 8) + cdb[8];
1214 cmd->execute_cmd = target_scsi3_emulate_pr_in;
1216 case PERSISTENT_RESERVE_OUT:
1217 *size = (cdb[7] << 8) + cdb[8];
1218 cmd->execute_cmd = target_scsi3_emulate_pr_out;
1222 if (cdb[0] == RELEASE_10)
1223 *size = (cdb[7] << 8) | cdb[8];
1225 *size = cmd->data_length;
1227 cmd->execute_cmd = target_scsi2_reservation_release;
1232 * The SPC-2 RESERVE does not contain a size in the SCSI CDB.
1233 * Assume the passthrough or $FABRIC_MOD will tell us about it.
1235 if (cdb[0] == RESERVE_10)
1236 *size = (cdb[7] << 8) | cdb[8];
1238 *size = cmd->data_length;
1240 cmd->execute_cmd = target_scsi2_reservation_reserve;
1244 cmd->execute_cmd = spc_emulate_request_sense;
1247 *size = (cdb[3] << 8) + cdb[4];
1250 * Do implict HEAD_OF_QUEUE processing for INQUIRY.
1251 * See spc4r17 section 5.3
1253 cmd->sam_task_attr = MSG_HEAD_TAG;
1254 cmd->execute_cmd = spc_emulate_inquiry;
1256 case SECURITY_PROTOCOL_IN:
1257 case SECURITY_PROTOCOL_OUT:
1258 *size = (cdb[6] << 24) | (cdb[7] << 16) | (cdb[8] << 8) | cdb[9];
1261 *size = get_unaligned_be32(&cdb[10]);
1262 cmd->execute_cmd = target_do_xcopy;
1264 case RECEIVE_COPY_RESULTS:
1265 *size = get_unaligned_be32(&cdb[10]);
1266 cmd->execute_cmd = target_do_receive_copy_results;
1268 case READ_ATTRIBUTE:
1269 case WRITE_ATTRIBUTE:
1270 *size = (cdb[10] << 24) | (cdb[11] << 16) |
1271 (cdb[12] << 8) | cdb[13];
1273 case RECEIVE_DIAGNOSTIC:
1274 case SEND_DIAGNOSTIC:
1275 *size = (cdb[3] << 8) | cdb[4];
1278 *size = (cdb[6] << 16) + (cdb[7] << 8) + cdb[8];
1281 cmd->execute_cmd = spc_emulate_report_luns;
1282 *size = (cdb[6] << 24) | (cdb[7] << 16) | (cdb[8] << 8) | cdb[9];
1284 * Do implict HEAD_OF_QUEUE processing for REPORT_LUNS
1285 * See spc4r17 section 5.3
1287 cmd->sam_task_attr = MSG_HEAD_TAG;
1289 case TEST_UNIT_READY:
1290 cmd->execute_cmd = spc_emulate_testunitready;
1293 case MAINTENANCE_IN:
1294 if (dev->transport->get_device_type(dev) != TYPE_ROM) {
1296 * MAINTENANCE_IN from SCC-2
1297 * Check for emulated MI_REPORT_TARGET_PGS
1299 if ((cdb[1] & 0x1f) == MI_REPORT_TARGET_PGS) {
1301 target_emulate_report_target_port_groups;
1303 *size = get_unaligned_be32(&cdb[6]);
1306 * GPCMD_SEND_KEY from multi media commands
1308 *size = get_unaligned_be16(&cdb[8]);
1311 case MAINTENANCE_OUT:
1312 if (dev->transport->get_device_type(dev) != TYPE_ROM) {
1314 * MAINTENANCE_OUT from SCC-2
1315 * Check for emulated MO_SET_TARGET_PGS.
1317 if (cdb[1] == MO_SET_TARGET_PGS) {
1319 target_emulate_set_target_port_groups;
1321 *size = get_unaligned_be32(&cdb[6]);
1324 * GPCMD_SEND_KEY from multi media commands
1326 *size = get_unaligned_be16(&cdb[8]);
1330 pr_warn("TARGET_CORE[%s]: Unsupported SCSI Opcode"
1331 " 0x%02x, sending CHECK_CONDITION.\n",
1332 cmd->se_tfo->get_fabric_name(), cdb[0]);
1333 return TCM_UNSUPPORTED_SCSI_OPCODE;
1338 EXPORT_SYMBOL(spc_parse_cdb);