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 memcpy(&buf[8], "LIO-ORG ", 8);
107 memset(&buf[16], 0x20, 16);
108 memcpy(&buf[16], dev->t10_wwn.model,
109 min_t(size_t, strlen(dev->t10_wwn.model), 16));
110 memcpy(&buf[32], dev->t10_wwn.revision,
111 min_t(size_t, strlen(dev->t10_wwn.revision), 4));
112 buf[4] = 31; /* Set additional length to 31 */
116 EXPORT_SYMBOL(spc_emulate_inquiry_std);
118 /* unit serial number */
119 static sense_reason_t
120 spc_emulate_evpd_80(struct se_cmd *cmd, unsigned char *buf)
122 struct se_device *dev = cmd->se_dev;
125 if (dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL) {
128 unit_serial_len = strlen(dev->t10_wwn.unit_serial);
129 unit_serial_len++; /* For NULL Terminator */
131 len += sprintf(&buf[4], "%s", dev->t10_wwn.unit_serial);
132 len++; /* Extra Byte for NULL Terminator */
138 void spc_parse_naa_6h_vendor_specific(struct se_device *dev,
141 unsigned char *p = &dev->t10_wwn.unit_serial[0];
146 * Generate up to 36 bits of VENDOR SPECIFIC IDENTIFIER starting on
147 * byte 3 bit 3-0 for NAA IEEE Registered Extended DESIGNATOR field
148 * format, followed by 64 bits of VENDOR SPECIFIC IDENTIFIER EXTENSION
149 * to complete the payload. These are based from VPD=0x80 PRODUCT SERIAL
150 * NUMBER set via vpd_unit_serial in target_core_configfs.c to ensure
151 * per device uniqeness.
153 for (cnt = 0; *p && cnt < 13; p++) {
154 int val = hex_to_bin(*p);
170 * Device identification VPD, for a complete list of
171 * DESIGNATOR TYPEs see spc4r17 Table 459.
174 spc_emulate_evpd_83(struct se_cmd *cmd, unsigned char *buf)
176 struct se_device *dev = cmd->se_dev;
177 struct se_lun *lun = cmd->se_lun;
178 struct se_port *port = NULL;
179 struct se_portal_group *tpg = NULL;
180 struct t10_alua_lu_gp_member *lu_gp_mem;
181 struct t10_alua_tg_pt_gp *tg_pt_gp;
182 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
183 unsigned char *prod = &dev->t10_wwn.model[0];
185 u32 unit_serial_len, off = 0;
191 * NAA IEEE Registered Extended Assigned designator format, see
192 * spc4r17 section 7.7.3.6.5
194 * We depend upon a target_core_mod/ConfigFS provided
195 * /sys/kernel/config/target/core/$HBA/$DEV/wwn/vpd_unit_serial
196 * value in order to return the NAA id.
198 if (!(dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL))
199 goto check_t10_vend_desc;
201 /* CODE SET == Binary */
204 /* Set ASSOCIATION == addressed logical unit: 0)b */
207 /* Identifier/Designator type == NAA identifier */
211 /* Identifier/Designator length */
215 * Start NAA IEEE Registered Extended Identifier/Designator
217 buf[off++] = (0x6 << 4);
220 * Use OpenFabrics IEEE Company ID: 00 14 05
224 buf[off] = (0x5 << 4);
227 * Return ConfigFS Unit Serial Number information for
228 * VENDOR_SPECIFIC_IDENTIFIER and
229 * VENDOR_SPECIFIC_IDENTIFIER_EXTENTION
231 spc_parse_naa_6h_vendor_specific(dev, &buf[off]);
238 * T10 Vendor Identifier Page, see spc4r17 section 7.7.3.4
240 id_len = 8; /* For Vendor field */
241 prod_len = 4; /* For VPD Header */
242 prod_len += 8; /* For Vendor field */
243 prod_len += strlen(prod);
244 prod_len++; /* For : */
246 if (dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL) {
247 unit_serial_len = strlen(&dev->t10_wwn.unit_serial[0]);
248 unit_serial_len++; /* For NULL Terminator */
250 id_len += sprintf(&buf[off+12], "%s:%s", prod,
251 &dev->t10_wwn.unit_serial[0]);
253 buf[off] = 0x2; /* ASCII */
254 buf[off+1] = 0x1; /* T10 Vendor ID */
256 memcpy(&buf[off+4], "LIO-ORG", 8);
257 /* Extra Byte for NULL Terminator */
259 /* Identifier Length */
261 /* Header size for Designation descriptor */
265 * struct se_port is only set for INQUIRY VPD=1 through $FABRIC_MOD
269 struct t10_alua_lu_gp *lu_gp;
270 u32 padding, scsi_name_len;
277 * Relative target port identifer, see spc4r17
280 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
281 * section 7.5.1 Table 362
284 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
285 buf[off++] |= 0x1; /* CODE SET == Binary */
286 buf[off] = 0x80; /* Set PIV=1 */
287 /* Set ASSOCIATION == target port: 01b */
289 /* DESIGNATOR TYPE == Relative target port identifer */
291 off++; /* Skip over Reserved */
292 buf[off++] = 4; /* DESIGNATOR LENGTH */
293 /* Skip over Obsolete field in RTPI payload
296 buf[off++] = ((port->sep_rtpi >> 8) & 0xff);
297 buf[off++] = (port->sep_rtpi & 0xff);
298 len += 8; /* Header size + Designation descriptor */
300 * Target port group identifier, see spc4r17
303 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
304 * section 7.5.1 Table 362
306 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
310 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
311 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
313 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
316 tg_pt_gp_id = tg_pt_gp->tg_pt_gp_id;
317 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
320 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
321 buf[off++] |= 0x1; /* CODE SET == Binary */
322 buf[off] = 0x80; /* Set PIV=1 */
323 /* Set ASSOCIATION == target port: 01b */
325 /* DESIGNATOR TYPE == Target port group identifier */
327 off++; /* Skip over Reserved */
328 buf[off++] = 4; /* DESIGNATOR LENGTH */
329 off += 2; /* Skip over Reserved Field */
330 buf[off++] = ((tg_pt_gp_id >> 8) & 0xff);
331 buf[off++] = (tg_pt_gp_id & 0xff);
332 len += 8; /* Header size + Designation descriptor */
334 * Logical Unit Group identifier, see spc4r17
338 lu_gp_mem = dev->dev_alua_lu_gp_mem;
340 goto check_scsi_name;
342 spin_lock(&lu_gp_mem->lu_gp_mem_lock);
343 lu_gp = lu_gp_mem->lu_gp;
345 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
346 goto check_scsi_name;
348 lu_gp_id = lu_gp->lu_gp_id;
349 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
351 buf[off++] |= 0x1; /* CODE SET == Binary */
352 /* DESIGNATOR TYPE == Logical Unit Group identifier */
354 off++; /* Skip over Reserved */
355 buf[off++] = 4; /* DESIGNATOR LENGTH */
356 off += 2; /* Skip over Reserved Field */
357 buf[off++] = ((lu_gp_id >> 8) & 0xff);
358 buf[off++] = (lu_gp_id & 0xff);
359 len += 8; /* Header size + Designation descriptor */
361 * SCSI name string designator, see spc4r17
364 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
365 * section 7.5.1 Table 362
368 scsi_name_len = strlen(tpg->se_tpg_tfo->tpg_get_wwn(tpg));
369 /* UTF-8 ",t,0x<16-bit TPGT>" + NULL Terminator */
371 /* Check for 4-byte padding */
372 padding = ((-scsi_name_len) & 3);
374 scsi_name_len += padding;
375 /* Header size + Designation descriptor */
379 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
380 buf[off++] |= 0x3; /* CODE SET == UTF-8 */
381 buf[off] = 0x80; /* Set PIV=1 */
382 /* Set ASSOCIATION == target port: 01b */
384 /* DESIGNATOR TYPE == SCSI name string */
386 off += 2; /* Skip over Reserved and length */
388 * SCSI name string identifer containing, $FABRIC_MOD
389 * dependent information. For LIO-Target and iSCSI
390 * Target Port, this means "<iSCSI name>,t,0x<TPGT> in
393 tpgt = tpg->se_tpg_tfo->tpg_get_tag(tpg);
394 scsi_name_len = sprintf(&buf[off], "%s,t,0x%04x",
395 tpg->se_tpg_tfo->tpg_get_wwn(tpg), tpgt);
396 scsi_name_len += 1 /* Include NULL terminator */;
398 * The null-terminated, null-padded (see 4.4.2) SCSI
399 * NAME STRING field contains a UTF-8 format string.
400 * The number of bytes in the SCSI NAME STRING field
401 * (i.e., the value in the DESIGNATOR LENGTH field)
402 * shall be no larger than 256 and shall be a multiple
406 scsi_name_len += padding;
408 buf[off-1] = scsi_name_len;
409 off += scsi_name_len;
410 /* Header size + Designation descriptor */
411 len += (scsi_name_len + 4);
413 buf[2] = ((len >> 8) & 0xff);
414 buf[3] = (len & 0xff); /* Page Length for VPD 0x83 */
417 EXPORT_SYMBOL(spc_emulate_evpd_83);
420 spc_check_dev_wce(struct se_device *dev)
424 if (dev->transport->get_write_cache)
425 wce = dev->transport->get_write_cache(dev);
426 else if (dev->dev_attrib.emulate_write_cache > 0)
432 /* Extended INQUIRY Data VPD Page */
433 static sense_reason_t
434 spc_emulate_evpd_86(struct se_cmd *cmd, unsigned char *buf)
436 struct se_device *dev = cmd->se_dev;
439 /* Set HEADSUP, ORDSUP, SIMPSUP */
442 /* If WriteCache emulation is enabled, set V_SUP */
443 if (spc_check_dev_wce(dev))
448 /* Block Limits VPD page */
449 static sense_reason_t
450 spc_emulate_evpd_b0(struct se_cmd *cmd, unsigned char *buf)
452 struct se_device *dev = cmd->se_dev;
457 * Following spc3r22 section 6.5.3 Block Limits VPD page, when
458 * emulate_tpu=1 or emulate_tpws=1 we will be expect a
459 * different page length for Thin Provisioning.
461 if (dev->dev_attrib.emulate_tpu || dev->dev_attrib.emulate_tpws)
464 buf[0] = dev->transport->get_device_type(dev);
465 buf[3] = have_tp ? 0x3c : 0x10;
470 * Set MAXIMUM COMPARE AND WRITE LENGTH
472 if (dev->dev_attrib.emulate_caw)
476 * Set OPTIMAL TRANSFER LENGTH GRANULARITY
478 put_unaligned_be16(1, &buf[6]);
481 * Set MAXIMUM TRANSFER LENGTH
483 max_sectors = min(dev->dev_attrib.fabric_max_sectors,
484 dev->dev_attrib.hw_max_sectors);
485 put_unaligned_be32(max_sectors, &buf[8]);
488 * Set OPTIMAL TRANSFER LENGTH
490 put_unaligned_be32(dev->dev_attrib.optimal_sectors, &buf[12]);
493 * Exit now if we don't support TP.
499 * Set MAXIMUM UNMAP LBA COUNT
501 put_unaligned_be32(dev->dev_attrib.max_unmap_lba_count, &buf[20]);
504 * Set MAXIMUM UNMAP BLOCK DESCRIPTOR COUNT
506 put_unaligned_be32(dev->dev_attrib.max_unmap_block_desc_count,
510 * Set OPTIMAL UNMAP GRANULARITY
512 put_unaligned_be32(dev->dev_attrib.unmap_granularity, &buf[28]);
515 * UNMAP GRANULARITY ALIGNMENT
517 put_unaligned_be32(dev->dev_attrib.unmap_granularity_alignment,
519 if (dev->dev_attrib.unmap_granularity_alignment != 0)
520 buf[32] |= 0x80; /* Set the UGAVALID bit */
523 * MAXIMUM WRITE SAME LENGTH
526 put_unaligned_be64(dev->dev_attrib.max_write_same_len, &buf[36]);
531 /* Block Device Characteristics VPD page */
532 static sense_reason_t
533 spc_emulate_evpd_b1(struct se_cmd *cmd, unsigned char *buf)
535 struct se_device *dev = cmd->se_dev;
537 buf[0] = dev->transport->get_device_type(dev);
539 buf[5] = dev->dev_attrib.is_nonrot ? 1 : 0;
544 /* Thin Provisioning VPD */
545 static sense_reason_t
546 spc_emulate_evpd_b2(struct se_cmd *cmd, unsigned char *buf)
548 struct se_device *dev = cmd->se_dev;
551 * From spc3r22 section 6.5.4 Thin Provisioning VPD page:
553 * The PAGE LENGTH field is defined in SPC-4. If the DP bit is set to
554 * zero, then the page length shall be set to 0004h. If the DP bit
555 * is set to one, then the page length shall be set to the value
556 * defined in table 162.
558 buf[0] = dev->transport->get_device_type(dev);
561 * Set Hardcoded length mentioned above for DP=0
563 put_unaligned_be16(0x0004, &buf[2]);
566 * The THRESHOLD EXPONENT field indicates the threshold set size in
567 * LBAs as a power of 2 (i.e., the threshold set size is equal to
568 * 2(threshold exponent)).
570 * Note that this is currently set to 0x00 as mkp says it will be
571 * changing again. We can enable this once it has settled in T10
572 * and is actually used by Linux/SCSI ML code.
577 * A TPU bit set to one indicates that the device server supports
578 * the UNMAP command (see 5.25). A TPU bit set to zero indicates
579 * that the device server does not support the UNMAP command.
581 if (dev->dev_attrib.emulate_tpu != 0)
585 * A TPWS bit set to one indicates that the device server supports
586 * the use of the WRITE SAME (16) command (see 5.42) to unmap LBAs.
587 * A TPWS bit set to zero indicates that the device server does not
588 * support the use of the WRITE SAME (16) command to unmap LBAs.
590 if (dev->dev_attrib.emulate_tpws != 0)
596 static sense_reason_t
597 spc_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf);
601 sense_reason_t (*emulate)(struct se_cmd *, unsigned char *);
602 } evpd_handlers[] = {
603 { .page = 0x00, .emulate = spc_emulate_evpd_00 },
604 { .page = 0x80, .emulate = spc_emulate_evpd_80 },
605 { .page = 0x83, .emulate = spc_emulate_evpd_83 },
606 { .page = 0x86, .emulate = spc_emulate_evpd_86 },
607 { .page = 0xb0, .emulate = spc_emulate_evpd_b0 },
608 { .page = 0xb1, .emulate = spc_emulate_evpd_b1 },
609 { .page = 0xb2, .emulate = spc_emulate_evpd_b2 },
612 /* supported vital product data pages */
613 static sense_reason_t
614 spc_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf)
619 * Only report the INQUIRY EVPD=1 pages after a valid NAA
620 * Registered Extended LUN WWN has been set via ConfigFS
621 * during device creation/restart.
623 if (cmd->se_dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL) {
624 buf[3] = ARRAY_SIZE(evpd_handlers);
625 for (p = 0; p < ARRAY_SIZE(evpd_handlers); ++p)
626 buf[p + 4] = evpd_handlers[p].page;
632 static sense_reason_t
633 spc_emulate_inquiry(struct se_cmd *cmd)
635 struct se_device *dev = cmd->se_dev;
636 struct se_portal_group *tpg = cmd->se_lun->lun_sep->sep_tpg;
638 unsigned char *cdb = cmd->t_task_cdb;
639 unsigned char buf[SE_INQUIRY_BUF];
643 memset(buf, 0, SE_INQUIRY_BUF);
645 if (dev == tpg->tpg_virt_lun0.lun_se_dev)
646 buf[0] = 0x3f; /* Not connected */
648 buf[0] = dev->transport->get_device_type(dev);
650 if (!(cdb[1] & 0x1)) {
652 pr_err("INQUIRY with EVPD==0 but PAGE CODE=%02x\n",
654 ret = TCM_INVALID_CDB_FIELD;
658 ret = spc_emulate_inquiry_std(cmd, buf);
662 for (p = 0; p < ARRAY_SIZE(evpd_handlers); ++p) {
663 if (cdb[2] == evpd_handlers[p].page) {
665 ret = evpd_handlers[p].emulate(cmd, buf);
670 pr_err("Unknown VPD Code: 0x%02x\n", cdb[2]);
671 ret = TCM_INVALID_CDB_FIELD;
674 rbuf = transport_kmap_data_sg(cmd);
676 memcpy(rbuf, buf, min_t(u32, sizeof(buf), cmd->data_length));
677 transport_kunmap_data_sg(cmd);
681 target_complete_cmd(cmd, GOOD);
685 static int spc_modesense_rwrecovery(struct se_device *dev, u8 pc, u8 *p)
690 /* No changeable values for now */
698 static int spc_modesense_control(struct se_device *dev, u8 pc, u8 *p)
703 /* No changeable values for now */
709 * From spc4r23, 7.4.7 Control mode page
711 * The QUEUE ALGORITHM MODIFIER field (see table 368) specifies
712 * restrictions on the algorithm used for reordering commands
713 * having the SIMPLE task attribute (see SAM-4).
715 * Table 368 -- QUEUE ALGORITHM MODIFIER field
717 * 0h Restricted reordering
718 * 1h Unrestricted reordering allowed
720 * 8h to Fh Vendor specific
722 * A value of zero in the QUEUE ALGORITHM MODIFIER field specifies that
723 * the device server shall order the processing sequence of commands
724 * having the SIMPLE task attribute such that data integrity is maintained
725 * for that I_T nexus (i.e., if the transmission of new SCSI transport protocol
726 * requests is halted at any time, the final value of all data observable
727 * on the medium shall be the same as if all the commands had been processed
728 * with the ORDERED task attribute).
730 * A value of one in the QUEUE ALGORITHM MODIFIER field specifies that the
731 * device server may reorder the processing sequence of commands having the
732 * SIMPLE task attribute in any manner. Any data integrity exposures related to
733 * command sequence order shall be explicitly handled by the application client
734 * through the selection of appropriate ommands and task attributes.
736 p[3] = (dev->dev_attrib.emulate_rest_reord == 1) ? 0x00 : 0x10;
738 * From spc4r17, section 7.4.6 Control mode Page
740 * Unit Attention interlocks control (UN_INTLCK_CTRL) to code 00b
742 * 00b: The logical unit shall clear any unit attention condition
743 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
744 * status and shall not establish a unit attention condition when a com-
745 * mand is completed with BUSY, TASK SET FULL, or RESERVATION CONFLICT
748 * 10b: The logical unit shall not clear any unit attention condition
749 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
750 * status and shall not establish a unit attention condition when
751 * a command is completed with BUSY, TASK SET FULL, or RESERVATION
754 * 11b a The logical unit shall not clear any unit attention condition
755 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
756 * status and shall establish a unit attention condition for the
757 * initiator port associated with the I_T nexus on which the BUSY,
758 * TASK SET FULL, or RESERVATION CONFLICT status is being returned.
759 * Depending on the status, the additional sense code shall be set to
760 * PREVIOUS BUSY STATUS, PREVIOUS TASK SET FULL STATUS, or PREVIOUS
761 * RESERVATION CONFLICT STATUS. Until it is cleared by a REQUEST SENSE
762 * command, a unit attention condition shall be established only once
763 * for a BUSY, TASK SET FULL, or RESERVATION CONFLICT status regardless
764 * to the number of commands completed with one of those status codes.
766 p[4] = (dev->dev_attrib.emulate_ua_intlck_ctrl == 2) ? 0x30 :
767 (dev->dev_attrib.emulate_ua_intlck_ctrl == 1) ? 0x20 : 0x00;
769 * From spc4r17, section 7.4.6 Control mode Page
771 * Task Aborted Status (TAS) bit set to zero.
773 * A task aborted status (TAS) bit set to zero specifies that aborted
774 * tasks shall be terminated by the device server without any response
775 * to the application client. A TAS bit set to one specifies that tasks
776 * aborted by the actions of an I_T nexus other than the I_T nexus on
777 * which the command was received shall be completed with TASK ABORTED
778 * status (see SAM-4).
780 p[5] = (dev->dev_attrib.emulate_tas) ? 0x40 : 0x00;
789 static int spc_modesense_caching(struct se_device *dev, u8 pc, u8 *p)
794 /* No changeable values for now */
798 if (spc_check_dev_wce(dev))
799 p[2] = 0x04; /* Write Cache Enable */
800 p[12] = 0x20; /* Disabled Read Ahead */
806 static int spc_modesense_informational_exceptions(struct se_device *dev, u8 pc, unsigned char *p)
811 /* No changeable values for now */
822 int (*emulate)(struct se_device *, u8, unsigned char *);
823 } modesense_handlers[] = {
824 { .page = 0x01, .subpage = 0x00, .emulate = spc_modesense_rwrecovery },
825 { .page = 0x08, .subpage = 0x00, .emulate = spc_modesense_caching },
826 { .page = 0x0a, .subpage = 0x00, .emulate = spc_modesense_control },
827 { .page = 0x1c, .subpage = 0x00, .emulate = spc_modesense_informational_exceptions },
830 static void spc_modesense_write_protect(unsigned char *buf, int type)
833 * I believe that the WP bit (bit 7) in the mode header is the same for
840 buf[0] |= 0x80; /* WP bit */
845 static void spc_modesense_dpofua(unsigned char *buf, int type)
849 buf[0] |= 0x10; /* DPOFUA bit */
856 static int spc_modesense_blockdesc(unsigned char *buf, u64 blocks, u32 block_size)
859 put_unaligned_be32(min(blocks, 0xffffffffull), buf);
861 put_unaligned_be32(block_size, buf);
865 static int spc_modesense_long_blockdesc(unsigned char *buf, u64 blocks, u32 block_size)
867 if (blocks <= 0xffffffff)
868 return spc_modesense_blockdesc(buf + 3, blocks, block_size) + 3;
870 *buf++ = 1; /* LONGLBA */
873 put_unaligned_be64(blocks, buf);
875 put_unaligned_be32(block_size, buf);
880 static sense_reason_t spc_emulate_modesense(struct se_cmd *cmd)
882 struct se_device *dev = cmd->se_dev;
883 char *cdb = cmd->t_task_cdb;
884 unsigned char buf[SE_MODE_PAGE_BUF], *rbuf;
885 int type = dev->transport->get_device_type(dev);
886 int ten = (cmd->t_task_cdb[0] == MODE_SENSE_10);
887 bool dbd = !!(cdb[1] & 0x08);
888 bool llba = ten ? !!(cdb[1] & 0x10) : false;
890 u8 page = cdb[2] & 0x3f;
896 memset(buf, 0, SE_MODE_PAGE_BUF);
899 * Skip over MODE DATA LENGTH + MEDIUM TYPE fields to byte 3 for
900 * MODE_SENSE_10 and byte 2 for MODE_SENSE (6).
902 length = ten ? 3 : 2;
904 /* DEVICE-SPECIFIC PARAMETER */
905 if ((cmd->se_lun->lun_access & TRANSPORT_LUNFLAGS_READ_ONLY) ||
907 (cmd->se_deve->lun_flags & TRANSPORT_LUNFLAGS_READ_ONLY)))
908 spc_modesense_write_protect(&buf[length], type);
910 if ((spc_check_dev_wce(dev)) &&
911 (dev->dev_attrib.emulate_fua_write > 0))
912 spc_modesense_dpofua(&buf[length], type);
916 /* BLOCK DESCRIPTOR */
919 * For now we only include a block descriptor for disk (SBC)
920 * devices; other command sets use a slightly different format.
922 if (!dbd && type == TYPE_DISK) {
923 u64 blocks = dev->transport->get_blocks(dev);
924 u32 block_size = dev->dev_attrib.block_size;
928 length += spc_modesense_long_blockdesc(&buf[length],
932 length += spc_modesense_blockdesc(&buf[length],
936 length += spc_modesense_blockdesc(&buf[length], blocks,
947 if (subpage != 0x00 && subpage != 0xff) {
948 pr_warn("MODE_SENSE: Invalid subpage code: 0x%02x\n", subpage);
949 return TCM_INVALID_CDB_FIELD;
952 for (i = 0; i < ARRAY_SIZE(modesense_handlers); ++i) {
954 * Tricky way to say all subpage 00h for
955 * subpage==0, all subpages for subpage==0xff
956 * (and we just checked above that those are
957 * the only two possibilities).
959 if ((modesense_handlers[i].subpage & ~subpage) == 0) {
960 ret = modesense_handlers[i].emulate(dev, pc, &buf[length]);
961 if (!ten && length + ret >= 255)
970 for (i = 0; i < ARRAY_SIZE(modesense_handlers); ++i)
971 if (modesense_handlers[i].page == page &&
972 modesense_handlers[i].subpage == subpage) {
973 length += modesense_handlers[i].emulate(dev, pc, &buf[length]);
978 * We don't intend to implement:
979 * - obsolete page 03h "format parameters" (checked by Solaris)
982 pr_err("MODE SENSE: unimplemented page/subpage: 0x%02x/0x%02x\n",
985 return TCM_UNKNOWN_MODE_PAGE;
989 put_unaligned_be16(length - 2, buf);
993 rbuf = transport_kmap_data_sg(cmd);
995 memcpy(rbuf, buf, min_t(u32, SE_MODE_PAGE_BUF, cmd->data_length));
996 transport_kunmap_data_sg(cmd);
999 target_complete_cmd(cmd, GOOD);
1003 static sense_reason_t spc_emulate_modeselect(struct se_cmd *cmd)
1005 struct se_device *dev = cmd->se_dev;
1006 char *cdb = cmd->t_task_cdb;
1007 bool ten = cdb[0] == MODE_SELECT_10;
1008 int off = ten ? 8 : 4;
1009 bool pf = !!(cdb[1] & 0x10);
1012 unsigned char tbuf[SE_MODE_PAGE_BUF];
1017 if (!cmd->data_length) {
1018 target_complete_cmd(cmd, GOOD);
1022 if (cmd->data_length < off + 2)
1023 return TCM_PARAMETER_LIST_LENGTH_ERROR;
1025 buf = transport_kmap_data_sg(cmd);
1027 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1030 ret = TCM_INVALID_CDB_FIELD;
1034 page = buf[off] & 0x3f;
1035 subpage = buf[off] & 0x40 ? buf[off + 1] : 0;
1037 for (i = 0; i < ARRAY_SIZE(modesense_handlers); ++i)
1038 if (modesense_handlers[i].page == page &&
1039 modesense_handlers[i].subpage == subpage) {
1040 memset(tbuf, 0, SE_MODE_PAGE_BUF);
1041 length = modesense_handlers[i].emulate(dev, 0, tbuf);
1042 goto check_contents;
1045 ret = TCM_UNKNOWN_MODE_PAGE;
1049 if (cmd->data_length < off + length) {
1050 ret = TCM_PARAMETER_LIST_LENGTH_ERROR;
1054 if (memcmp(buf + off, tbuf, length))
1055 ret = TCM_INVALID_PARAMETER_LIST;
1058 transport_kunmap_data_sg(cmd);
1061 target_complete_cmd(cmd, GOOD);
1065 static sense_reason_t spc_emulate_request_sense(struct se_cmd *cmd)
1067 unsigned char *cdb = cmd->t_task_cdb;
1068 unsigned char *rbuf;
1069 u8 ua_asc = 0, ua_ascq = 0;
1070 unsigned char buf[SE_SENSE_BUF];
1072 memset(buf, 0, SE_SENSE_BUF);
1074 if (cdb[1] & 0x01) {
1075 pr_err("REQUEST_SENSE description emulation not"
1077 return TCM_INVALID_CDB_FIELD;
1080 rbuf = transport_kmap_data_sg(cmd);
1082 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1084 if (!core_scsi3_ua_clear_for_request_sense(cmd, &ua_asc, &ua_ascq)) {
1086 * CURRENT ERROR, UNIT ATTENTION
1089 buf[SPC_SENSE_KEY_OFFSET] = UNIT_ATTENTION;
1092 * The Additional Sense Code (ASC) from the UNIT ATTENTION
1094 buf[SPC_ASC_KEY_OFFSET] = ua_asc;
1095 buf[SPC_ASCQ_KEY_OFFSET] = ua_ascq;
1099 * CURRENT ERROR, NO SENSE
1102 buf[SPC_SENSE_KEY_OFFSET] = NO_SENSE;
1105 * NO ADDITIONAL SENSE INFORMATION
1107 buf[SPC_ASC_KEY_OFFSET] = 0x00;
1111 memcpy(rbuf, buf, min_t(u32, sizeof(buf), cmd->data_length));
1112 transport_kunmap_data_sg(cmd);
1114 target_complete_cmd(cmd, GOOD);
1118 sense_reason_t spc_emulate_report_luns(struct se_cmd *cmd)
1120 struct se_dev_entry *deve;
1121 struct se_session *sess = cmd->se_sess;
1123 u32 lun_count = 0, offset = 8, i;
1125 if (cmd->data_length < 16) {
1126 pr_warn("REPORT LUNS allocation length %u too small\n",
1128 return TCM_INVALID_CDB_FIELD;
1131 buf = transport_kmap_data_sg(cmd);
1133 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1136 * If no struct se_session pointer is present, this struct se_cmd is
1137 * coming via a target_core_mod PASSTHROUGH op, and not through
1138 * a $FABRIC_MOD. In that case, report LUN=0 only.
1141 int_to_scsilun(0, (struct scsi_lun *)&buf[offset]);
1146 spin_lock_irq(&sess->se_node_acl->device_list_lock);
1147 for (i = 0; i < TRANSPORT_MAX_LUNS_PER_TPG; i++) {
1148 deve = sess->se_node_acl->device_list[i];
1149 if (!(deve->lun_flags & TRANSPORT_LUNFLAGS_INITIATOR_ACCESS))
1152 * We determine the correct LUN LIST LENGTH even once we
1153 * have reached the initial allocation length.
1154 * See SPC2-R20 7.19.
1157 if ((offset + 8) > cmd->data_length)
1160 int_to_scsilun(deve->mapped_lun, (struct scsi_lun *)&buf[offset]);
1163 spin_unlock_irq(&sess->se_node_acl->device_list_lock);
1166 * See SPC3 r07, page 159.
1170 buf[0] = ((lun_count >> 24) & 0xff);
1171 buf[1] = ((lun_count >> 16) & 0xff);
1172 buf[2] = ((lun_count >> 8) & 0xff);
1173 buf[3] = (lun_count & 0xff);
1174 transport_kunmap_data_sg(cmd);
1176 target_complete_cmd(cmd, GOOD);
1179 EXPORT_SYMBOL(spc_emulate_report_luns);
1181 static sense_reason_t
1182 spc_emulate_testunitready(struct se_cmd *cmd)
1184 target_complete_cmd(cmd, GOOD);
1189 spc_parse_cdb(struct se_cmd *cmd, unsigned int *size)
1191 struct se_device *dev = cmd->se_dev;
1192 unsigned char *cdb = cmd->t_task_cdb;
1197 cmd->execute_cmd = spc_emulate_modeselect;
1199 case MODE_SELECT_10:
1200 *size = (cdb[7] << 8) + cdb[8];
1201 cmd->execute_cmd = spc_emulate_modeselect;
1205 cmd->execute_cmd = spc_emulate_modesense;
1208 *size = (cdb[7] << 8) + cdb[8];
1209 cmd->execute_cmd = spc_emulate_modesense;
1213 *size = (cdb[7] << 8) + cdb[8];
1215 case PERSISTENT_RESERVE_IN:
1216 *size = (cdb[7] << 8) + cdb[8];
1217 cmd->execute_cmd = target_scsi3_emulate_pr_in;
1219 case PERSISTENT_RESERVE_OUT:
1220 *size = (cdb[7] << 8) + cdb[8];
1221 cmd->execute_cmd = target_scsi3_emulate_pr_out;
1225 if (cdb[0] == RELEASE_10)
1226 *size = (cdb[7] << 8) | cdb[8];
1228 *size = cmd->data_length;
1230 cmd->execute_cmd = target_scsi2_reservation_release;
1235 * The SPC-2 RESERVE does not contain a size in the SCSI CDB.
1236 * Assume the passthrough or $FABRIC_MOD will tell us about it.
1238 if (cdb[0] == RESERVE_10)
1239 *size = (cdb[7] << 8) | cdb[8];
1241 *size = cmd->data_length;
1243 cmd->execute_cmd = target_scsi2_reservation_reserve;
1247 cmd->execute_cmd = spc_emulate_request_sense;
1250 *size = (cdb[3] << 8) + cdb[4];
1253 * Do implict HEAD_OF_QUEUE processing for INQUIRY.
1254 * See spc4r17 section 5.3
1256 cmd->sam_task_attr = MSG_HEAD_TAG;
1257 cmd->execute_cmd = spc_emulate_inquiry;
1259 case SECURITY_PROTOCOL_IN:
1260 case SECURITY_PROTOCOL_OUT:
1261 *size = (cdb[6] << 24) | (cdb[7] << 16) | (cdb[8] << 8) | cdb[9];
1264 *size = get_unaligned_be32(&cdb[10]);
1265 cmd->execute_cmd = target_do_xcopy;
1267 case RECEIVE_COPY_RESULTS:
1268 *size = get_unaligned_be32(&cdb[10]);
1269 cmd->execute_cmd = target_do_receive_copy_results;
1271 case READ_ATTRIBUTE:
1272 case WRITE_ATTRIBUTE:
1273 *size = (cdb[10] << 24) | (cdb[11] << 16) |
1274 (cdb[12] << 8) | cdb[13];
1276 case RECEIVE_DIAGNOSTIC:
1277 case SEND_DIAGNOSTIC:
1278 *size = (cdb[3] << 8) | cdb[4];
1281 *size = (cdb[6] << 16) + (cdb[7] << 8) + cdb[8];
1284 cmd->execute_cmd = spc_emulate_report_luns;
1285 *size = (cdb[6] << 24) | (cdb[7] << 16) | (cdb[8] << 8) | cdb[9];
1287 * Do implict HEAD_OF_QUEUE processing for REPORT_LUNS
1288 * See spc4r17 section 5.3
1290 cmd->sam_task_attr = MSG_HEAD_TAG;
1292 case TEST_UNIT_READY:
1293 cmd->execute_cmd = spc_emulate_testunitready;
1296 case MAINTENANCE_IN:
1297 if (dev->transport->get_device_type(dev) != TYPE_ROM) {
1299 * MAINTENANCE_IN from SCC-2
1300 * Check for emulated MI_REPORT_TARGET_PGS
1302 if ((cdb[1] & 0x1f) == MI_REPORT_TARGET_PGS) {
1304 target_emulate_report_target_port_groups;
1306 *size = get_unaligned_be32(&cdb[6]);
1309 * GPCMD_SEND_KEY from multi media commands
1311 *size = get_unaligned_be16(&cdb[8]);
1314 case MAINTENANCE_OUT:
1315 if (dev->transport->get_device_type(dev) != TYPE_ROM) {
1317 * MAINTENANCE_OUT from SCC-2
1318 * Check for emulated MO_SET_TARGET_PGS.
1320 if (cdb[1] == MO_SET_TARGET_PGS) {
1322 target_emulate_set_target_port_groups;
1324 *size = get_unaligned_be32(&cdb[6]);
1327 * GPCMD_SEND_KEY from multi media commands
1329 *size = get_unaligned_be16(&cdb[8]);
1333 pr_warn("TARGET_CORE[%s]: Unsupported SCSI Opcode"
1334 " 0x%02x, sending CHECK_CONDITION.\n",
1335 cmd->se_tfo->get_fabric_name(), cdb[0]);
1336 return TCM_UNSUPPORTED_SCSI_OPCODE;
1341 EXPORT_SYMBOL(spc_parse_cdb);