2 * SCSI Primary Commands (SPC) parsing and emulation.
4 * Copyright (c) 2002, 2003, 2004, 2005 PyX Technologies, Inc.
5 * Copyright (c) 2005, 2006, 2007 SBE, Inc.
6 * Copyright (c) 2007-2010 Rising Tide Systems
7 * Copyright (c) 2008-2010 Linux-iSCSI.org
9 * Nicholas A. Bellinger <nab@kernel.org>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
26 #include <linux/kernel.h>
27 #include <linux/module.h>
28 #include <asm/unaligned.h>
30 #include <scsi/scsi.h>
31 #include <scsi/scsi_tcq.h>
33 #include <target/target_core_base.h>
34 #include <target/target_core_backend.h>
35 #include <target/target_core_fabric.h>
37 #include "target_core_internal.h"
38 #include "target_core_alua.h"
39 #include "target_core_pr.h"
40 #include "target_core_ua.h"
43 static void spc_fill_alua_data(struct se_port *port, unsigned char *buf)
45 struct t10_alua_tg_pt_gp *tg_pt_gp;
46 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
49 * Set SCCS for MAINTENANCE_IN + REPORT_TARGET_PORT_GROUPS.
54 * Set TPGS field for explict and/or implict ALUA access type
57 * See spc4r17 section 6.4.2 Table 135
61 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
65 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
66 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
68 buf[5] |= tg_pt_gp->tg_pt_gp_alua_access_type;
69 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
73 spc_emulate_inquiry_std(struct se_cmd *cmd, char *buf)
75 struct se_lun *lun = cmd->se_lun;
76 struct se_device *dev = cmd->se_dev;
78 /* Set RMB (removable media) for tape devices */
79 if (dev->transport->get_device_type(dev) == TYPE_TAPE)
82 buf[2] = 0x05; /* SPC-3 */
85 * NORMACA and HISUP = 0, RESPONSE DATA FORMAT = 2
88 * A RESPONSE DATA FORMAT field set to 2h indicates that the
89 * standard INQUIRY data is in the format defined in this
90 * standard. Response data format values less than 2h are
91 * obsolete. Response data format values greater than 2h are
97 * Enable SCCS and TPGS fields for Emulated ALUA
99 spc_fill_alua_data(lun->lun_sep, buf);
101 buf[7] = 0x2; /* CmdQue=1 */
103 snprintf(&buf[8], 8, "LIO-ORG");
104 snprintf(&buf[16], 16, "%s", dev->t10_wwn.model);
105 snprintf(&buf[32], 4, "%s", dev->t10_wwn.revision);
106 buf[4] = 31; /* Set additional length to 31 */
111 /* unit serial number */
112 static sense_reason_t
113 spc_emulate_evpd_80(struct se_cmd *cmd, unsigned char *buf)
115 struct se_device *dev = cmd->se_dev;
118 if (dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL) {
121 unit_serial_len = strlen(dev->t10_wwn.unit_serial);
122 unit_serial_len++; /* For NULL Terminator */
124 len += sprintf(&buf[4], "%s", dev->t10_wwn.unit_serial);
125 len++; /* Extra Byte for NULL Terminator */
131 static void spc_parse_naa_6h_vendor_specific(struct se_device *dev,
134 unsigned char *p = &dev->t10_wwn.unit_serial[0];
139 * Generate up to 36 bits of VENDOR SPECIFIC IDENTIFIER starting on
140 * byte 3 bit 3-0 for NAA IEEE Registered Extended DESIGNATOR field
141 * format, followed by 64 bits of VENDOR SPECIFIC IDENTIFIER EXTENSION
142 * to complete the payload. These are based from VPD=0x80 PRODUCT SERIAL
143 * NUMBER set via vpd_unit_serial in target_core_configfs.c to ensure
144 * per device uniqeness.
146 for (cnt = 0; *p && cnt < 13; p++) {
147 int val = hex_to_bin(*p);
163 * Device identification VPD, for a complete list of
164 * DESIGNATOR TYPEs see spc4r17 Table 459.
166 static sense_reason_t
167 spc_emulate_evpd_83(struct se_cmd *cmd, unsigned char *buf)
169 struct se_device *dev = cmd->se_dev;
170 struct se_lun *lun = cmd->se_lun;
171 struct se_port *port = NULL;
172 struct se_portal_group *tpg = NULL;
173 struct t10_alua_lu_gp_member *lu_gp_mem;
174 struct t10_alua_tg_pt_gp *tg_pt_gp;
175 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
176 unsigned char *prod = &dev->t10_wwn.model[0];
178 u32 unit_serial_len, off = 0;
184 * NAA IEEE Registered Extended Assigned designator format, see
185 * spc4r17 section 7.7.3.6.5
187 * We depend upon a target_core_mod/ConfigFS provided
188 * /sys/kernel/config/target/core/$HBA/$DEV/wwn/vpd_unit_serial
189 * value in order to return the NAA id.
191 if (!(dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL))
192 goto check_t10_vend_desc;
194 /* CODE SET == Binary */
197 /* Set ASSOCIATION == addressed logical unit: 0)b */
200 /* Identifier/Designator type == NAA identifier */
204 /* Identifier/Designator length */
208 * Start NAA IEEE Registered Extended Identifier/Designator
210 buf[off++] = (0x6 << 4);
213 * Use OpenFabrics IEEE Company ID: 00 14 05
217 buf[off] = (0x5 << 4);
220 * Return ConfigFS Unit Serial Number information for
221 * VENDOR_SPECIFIC_IDENTIFIER and
222 * VENDOR_SPECIFIC_IDENTIFIER_EXTENTION
224 spc_parse_naa_6h_vendor_specific(dev, &buf[off]);
231 * T10 Vendor Identifier Page, see spc4r17 section 7.7.3.4
233 id_len = 8; /* For Vendor field */
234 prod_len = 4; /* For VPD Header */
235 prod_len += 8; /* For Vendor field */
236 prod_len += strlen(prod);
237 prod_len++; /* For : */
239 if (dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL) {
240 unit_serial_len = strlen(&dev->t10_wwn.unit_serial[0]);
241 unit_serial_len++; /* For NULL Terminator */
243 id_len += sprintf(&buf[off+12], "%s:%s", prod,
244 &dev->t10_wwn.unit_serial[0]);
246 buf[off] = 0x2; /* ASCII */
247 buf[off+1] = 0x1; /* T10 Vendor ID */
249 memcpy(&buf[off+4], "LIO-ORG", 8);
250 /* Extra Byte for NULL Terminator */
252 /* Identifier Length */
254 /* Header size for Designation descriptor */
258 * struct se_port is only set for INQUIRY VPD=1 through $FABRIC_MOD
262 struct t10_alua_lu_gp *lu_gp;
263 u32 padding, scsi_name_len;
270 * Relative target port identifer, see spc4r17
273 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
274 * section 7.5.1 Table 362
277 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
278 buf[off++] |= 0x1; /* CODE SET == Binary */
279 buf[off] = 0x80; /* Set PIV=1 */
280 /* Set ASSOCIATION == target port: 01b */
282 /* DESIGNATOR TYPE == Relative target port identifer */
284 off++; /* Skip over Reserved */
285 buf[off++] = 4; /* DESIGNATOR LENGTH */
286 /* Skip over Obsolete field in RTPI payload
289 buf[off++] = ((port->sep_rtpi >> 8) & 0xff);
290 buf[off++] = (port->sep_rtpi & 0xff);
291 len += 8; /* Header size + Designation descriptor */
293 * Target port group identifier, see spc4r17
296 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
297 * section 7.5.1 Table 362
299 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
303 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
304 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
306 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
309 tg_pt_gp_id = tg_pt_gp->tg_pt_gp_id;
310 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
313 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
314 buf[off++] |= 0x1; /* CODE SET == Binary */
315 buf[off] = 0x80; /* Set PIV=1 */
316 /* Set ASSOCIATION == target port: 01b */
318 /* DESIGNATOR TYPE == Target port group identifier */
320 off++; /* Skip over Reserved */
321 buf[off++] = 4; /* DESIGNATOR LENGTH */
322 off += 2; /* Skip over Reserved Field */
323 buf[off++] = ((tg_pt_gp_id >> 8) & 0xff);
324 buf[off++] = (tg_pt_gp_id & 0xff);
325 len += 8; /* Header size + Designation descriptor */
327 * Logical Unit Group identifier, see spc4r17
331 lu_gp_mem = dev->dev_alua_lu_gp_mem;
333 goto check_scsi_name;
335 spin_lock(&lu_gp_mem->lu_gp_mem_lock);
336 lu_gp = lu_gp_mem->lu_gp;
338 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
339 goto check_scsi_name;
341 lu_gp_id = lu_gp->lu_gp_id;
342 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
344 buf[off++] |= 0x1; /* CODE SET == Binary */
345 /* DESIGNATOR TYPE == Logical Unit Group identifier */
347 off++; /* Skip over Reserved */
348 buf[off++] = 4; /* DESIGNATOR LENGTH */
349 off += 2; /* Skip over Reserved Field */
350 buf[off++] = ((lu_gp_id >> 8) & 0xff);
351 buf[off++] = (lu_gp_id & 0xff);
352 len += 8; /* Header size + Designation descriptor */
354 * SCSI name string designator, see spc4r17
357 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
358 * section 7.5.1 Table 362
361 scsi_name_len = strlen(tpg->se_tpg_tfo->tpg_get_wwn(tpg));
362 /* UTF-8 ",t,0x<16-bit TPGT>" + NULL Terminator */
364 /* Check for 4-byte padding */
365 padding = ((-scsi_name_len) & 3);
367 scsi_name_len += padding;
368 /* Header size + Designation descriptor */
372 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
373 buf[off++] |= 0x3; /* CODE SET == UTF-8 */
374 buf[off] = 0x80; /* Set PIV=1 */
375 /* Set ASSOCIATION == target port: 01b */
377 /* DESIGNATOR TYPE == SCSI name string */
379 off += 2; /* Skip over Reserved and length */
381 * SCSI name string identifer containing, $FABRIC_MOD
382 * dependent information. For LIO-Target and iSCSI
383 * Target Port, this means "<iSCSI name>,t,0x<TPGT> in
386 tpgt = tpg->se_tpg_tfo->tpg_get_tag(tpg);
387 scsi_name_len = sprintf(&buf[off], "%s,t,0x%04x",
388 tpg->se_tpg_tfo->tpg_get_wwn(tpg), tpgt);
389 scsi_name_len += 1 /* Include NULL terminator */;
391 * The null-terminated, null-padded (see 4.4.2) SCSI
392 * NAME STRING field contains a UTF-8 format string.
393 * The number of bytes in the SCSI NAME STRING field
394 * (i.e., the value in the DESIGNATOR LENGTH field)
395 * shall be no larger than 256 and shall be a multiple
399 scsi_name_len += padding;
401 buf[off-1] = scsi_name_len;
402 off += scsi_name_len;
403 /* Header size + Designation descriptor */
404 len += (scsi_name_len + 4);
406 buf[2] = ((len >> 8) & 0xff);
407 buf[3] = (len & 0xff); /* Page Length for VPD 0x83 */
411 /* Extended INQUIRY Data VPD Page */
412 static sense_reason_t
413 spc_emulate_evpd_86(struct se_cmd *cmd, unsigned char *buf)
416 /* Set HEADSUP, ORDSUP, SIMPSUP */
419 /* If WriteCache emulation is enabled, set V_SUP */
420 if (cmd->se_dev->dev_attrib.emulate_write_cache > 0)
425 /* Block Limits VPD page */
426 static sense_reason_t
427 spc_emulate_evpd_b0(struct se_cmd *cmd, unsigned char *buf)
429 struct se_device *dev = cmd->se_dev;
434 * Following spc3r22 section 6.5.3 Block Limits VPD page, when
435 * emulate_tpu=1 or emulate_tpws=1 we will be expect a
436 * different page length for Thin Provisioning.
438 if (dev->dev_attrib.emulate_tpu || dev->dev_attrib.emulate_tpws)
441 buf[0] = dev->transport->get_device_type(dev);
442 buf[3] = have_tp ? 0x3c : 0x10;
448 * Set OPTIMAL TRANSFER LENGTH GRANULARITY
450 put_unaligned_be16(1, &buf[6]);
453 * Set MAXIMUM TRANSFER LENGTH
455 max_sectors = min(dev->dev_attrib.fabric_max_sectors,
456 dev->dev_attrib.hw_max_sectors);
457 put_unaligned_be32(max_sectors, &buf[8]);
460 * Set OPTIMAL TRANSFER LENGTH
462 put_unaligned_be32(dev->dev_attrib.optimal_sectors, &buf[12]);
465 * Exit now if we don't support TP.
471 * Set MAXIMUM UNMAP LBA COUNT
473 put_unaligned_be32(dev->dev_attrib.max_unmap_lba_count, &buf[20]);
476 * Set MAXIMUM UNMAP BLOCK DESCRIPTOR COUNT
478 put_unaligned_be32(dev->dev_attrib.max_unmap_block_desc_count,
482 * Set OPTIMAL UNMAP GRANULARITY
484 put_unaligned_be32(dev->dev_attrib.unmap_granularity, &buf[28]);
487 * UNMAP GRANULARITY ALIGNMENT
489 put_unaligned_be32(dev->dev_attrib.unmap_granularity_alignment,
491 if (dev->dev_attrib.unmap_granularity_alignment != 0)
492 buf[32] |= 0x80; /* Set the UGAVALID bit */
497 /* Block Device Characteristics VPD page */
498 static sense_reason_t
499 spc_emulate_evpd_b1(struct se_cmd *cmd, unsigned char *buf)
501 struct se_device *dev = cmd->se_dev;
503 buf[0] = dev->transport->get_device_type(dev);
505 buf[5] = dev->dev_attrib.is_nonrot ? 1 : 0;
510 /* Thin Provisioning VPD */
511 static sense_reason_t
512 spc_emulate_evpd_b2(struct se_cmd *cmd, unsigned char *buf)
514 struct se_device *dev = cmd->se_dev;
517 * From spc3r22 section 6.5.4 Thin Provisioning VPD page:
519 * The PAGE LENGTH field is defined in SPC-4. If the DP bit is set to
520 * zero, then the page length shall be set to 0004h. If the DP bit
521 * is set to one, then the page length shall be set to the value
522 * defined in table 162.
524 buf[0] = dev->transport->get_device_type(dev);
527 * Set Hardcoded length mentioned above for DP=0
529 put_unaligned_be16(0x0004, &buf[2]);
532 * The THRESHOLD EXPONENT field indicates the threshold set size in
533 * LBAs as a power of 2 (i.e., the threshold set size is equal to
534 * 2(threshold exponent)).
536 * Note that this is currently set to 0x00 as mkp says it will be
537 * changing again. We can enable this once it has settled in T10
538 * and is actually used by Linux/SCSI ML code.
543 * A TPU bit set to one indicates that the device server supports
544 * the UNMAP command (see 5.25). A TPU bit set to zero indicates
545 * that the device server does not support the UNMAP command.
547 if (dev->dev_attrib.emulate_tpu != 0)
551 * A TPWS bit set to one indicates that the device server supports
552 * the use of the WRITE SAME (16) command (see 5.42) to unmap LBAs.
553 * A TPWS bit set to zero indicates that the device server does not
554 * support the use of the WRITE SAME (16) command to unmap LBAs.
556 if (dev->dev_attrib.emulate_tpws != 0)
562 static sense_reason_t
563 spc_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf);
567 sense_reason_t (*emulate)(struct se_cmd *, unsigned char *);
568 } evpd_handlers[] = {
569 { .page = 0x00, .emulate = spc_emulate_evpd_00 },
570 { .page = 0x80, .emulate = spc_emulate_evpd_80 },
571 { .page = 0x83, .emulate = spc_emulate_evpd_83 },
572 { .page = 0x86, .emulate = spc_emulate_evpd_86 },
573 { .page = 0xb0, .emulate = spc_emulate_evpd_b0 },
574 { .page = 0xb1, .emulate = spc_emulate_evpd_b1 },
575 { .page = 0xb2, .emulate = spc_emulate_evpd_b2 },
578 /* supported vital product data pages */
579 static sense_reason_t
580 spc_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf)
585 * Only report the INQUIRY EVPD=1 pages after a valid NAA
586 * Registered Extended LUN WWN has been set via ConfigFS
587 * during device creation/restart.
589 if (cmd->se_dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL) {
590 buf[3] = ARRAY_SIZE(evpd_handlers);
591 for (p = 0; p < ARRAY_SIZE(evpd_handlers); ++p)
592 buf[p + 4] = evpd_handlers[p].page;
598 static sense_reason_t
599 spc_emulate_inquiry(struct se_cmd *cmd)
601 struct se_device *dev = cmd->se_dev;
602 struct se_portal_group *tpg = cmd->se_lun->lun_sep->sep_tpg;
604 unsigned char *cdb = cmd->t_task_cdb;
605 unsigned char buf[SE_INQUIRY_BUF];
609 memset(buf, 0, SE_INQUIRY_BUF);
611 if (dev == tpg->tpg_virt_lun0.lun_se_dev)
612 buf[0] = 0x3f; /* Not connected */
614 buf[0] = dev->transport->get_device_type(dev);
616 if (!(cdb[1] & 0x1)) {
618 pr_err("INQUIRY with EVPD==0 but PAGE CODE=%02x\n",
620 ret = TCM_INVALID_CDB_FIELD;
624 ret = spc_emulate_inquiry_std(cmd, buf);
628 for (p = 0; p < ARRAY_SIZE(evpd_handlers); ++p) {
629 if (cdb[2] == evpd_handlers[p].page) {
631 ret = evpd_handlers[p].emulate(cmd, buf);
636 pr_err("Unknown VPD Code: 0x%02x\n", cdb[2]);
637 ret = TCM_INVALID_CDB_FIELD;
640 rbuf = transport_kmap_data_sg(cmd);
642 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
644 memcpy(rbuf, buf, min_t(u32, sizeof(buf), cmd->data_length));
645 transport_kunmap_data_sg(cmd);
648 target_complete_cmd(cmd, GOOD);
652 static int spc_modesense_rwrecovery(struct se_device *dev, u8 pc, u8 *p)
657 /* No changeable values for now */
665 static int spc_modesense_control(struct se_device *dev, u8 pc, u8 *p)
670 /* No changeable values for now */
676 * From spc4r23, 7.4.7 Control mode page
678 * The QUEUE ALGORITHM MODIFIER field (see table 368) specifies
679 * restrictions on the algorithm used for reordering commands
680 * having the SIMPLE task attribute (see SAM-4).
682 * Table 368 -- QUEUE ALGORITHM MODIFIER field
684 * 0h Restricted reordering
685 * 1h Unrestricted reordering allowed
687 * 8h to Fh Vendor specific
689 * A value of zero in the QUEUE ALGORITHM MODIFIER field specifies that
690 * the device server shall order the processing sequence of commands
691 * having the SIMPLE task attribute such that data integrity is maintained
692 * for that I_T nexus (i.e., if the transmission of new SCSI transport protocol
693 * requests is halted at any time, the final value of all data observable
694 * on the medium shall be the same as if all the commands had been processed
695 * with the ORDERED task attribute).
697 * A value of one in the QUEUE ALGORITHM MODIFIER field specifies that the
698 * device server may reorder the processing sequence of commands having the
699 * SIMPLE task attribute in any manner. Any data integrity exposures related to
700 * command sequence order shall be explicitly handled by the application client
701 * through the selection of appropriate ommands and task attributes.
703 p[3] = (dev->dev_attrib.emulate_rest_reord == 1) ? 0x00 : 0x10;
705 * From spc4r17, section 7.4.6 Control mode Page
707 * Unit Attention interlocks control (UN_INTLCK_CTRL) to code 00b
709 * 00b: The logical unit shall clear any unit attention condition
710 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
711 * status and shall not establish a unit attention condition when a com-
712 * mand is completed with BUSY, TASK SET FULL, or RESERVATION CONFLICT
715 * 10b: The logical unit shall not clear any unit attention condition
716 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
717 * status and shall not establish a unit attention condition when
718 * a command is completed with BUSY, TASK SET FULL, or RESERVATION
721 * 11b a The logical unit shall not clear any unit attention condition
722 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
723 * status and shall establish a unit attention condition for the
724 * initiator port associated with the I_T nexus on which the BUSY,
725 * TASK SET FULL, or RESERVATION CONFLICT status is being returned.
726 * Depending on the status, the additional sense code shall be set to
727 * PREVIOUS BUSY STATUS, PREVIOUS TASK SET FULL STATUS, or PREVIOUS
728 * RESERVATION CONFLICT STATUS. Until it is cleared by a REQUEST SENSE
729 * command, a unit attention condition shall be established only once
730 * for a BUSY, TASK SET FULL, or RESERVATION CONFLICT status regardless
731 * to the number of commands completed with one of those status codes.
733 p[4] = (dev->dev_attrib.emulate_ua_intlck_ctrl == 2) ? 0x30 :
734 (dev->dev_attrib.emulate_ua_intlck_ctrl == 1) ? 0x20 : 0x00;
736 * From spc4r17, section 7.4.6 Control mode Page
738 * Task Aborted Status (TAS) bit set to zero.
740 * A task aborted status (TAS) bit set to zero specifies that aborted
741 * tasks shall be terminated by the device server without any response
742 * to the application client. A TAS bit set to one specifies that tasks
743 * aborted by the actions of an I_T nexus other than the I_T nexus on
744 * which the command was received shall be completed with TASK ABORTED
745 * status (see SAM-4).
747 p[5] = (dev->dev_attrib.emulate_tas) ? 0x40 : 0x00;
756 static int spc_modesense_caching(struct se_device *dev, u8 pc, u8 *p)
761 /* No changeable values for now */
765 if (dev->dev_attrib.emulate_write_cache > 0)
766 p[2] = 0x04; /* Write Cache Enable */
767 p[12] = 0x20; /* Disabled Read Ahead */
773 static int spc_modesense_informational_exceptions(struct se_device *dev, u8 pc, unsigned char *p)
778 /* No changeable values for now */
789 int (*emulate)(struct se_device *, u8, unsigned char *);
790 } modesense_handlers[] = {
791 { .page = 0x01, .subpage = 0x00, .emulate = spc_modesense_rwrecovery },
792 { .page = 0x08, .subpage = 0x00, .emulate = spc_modesense_caching },
793 { .page = 0x0a, .subpage = 0x00, .emulate = spc_modesense_control },
794 { .page = 0x1c, .subpage = 0x00, .emulate = spc_modesense_informational_exceptions },
797 static void spc_modesense_write_protect(unsigned char *buf, int type)
800 * I believe that the WP bit (bit 7) in the mode header is the same for
807 buf[0] |= 0x80; /* WP bit */
812 static void spc_modesense_dpofua(unsigned char *buf, int type)
816 buf[0] |= 0x10; /* DPOFUA bit */
823 static int spc_modesense_blockdesc(unsigned char *buf, u64 blocks, u32 block_size)
826 put_unaligned_be32(min(blocks, 0xffffffffull), buf);
828 put_unaligned_be32(block_size, buf);
832 static int spc_modesense_long_blockdesc(unsigned char *buf, u64 blocks, u32 block_size)
834 if (blocks <= 0xffffffff)
835 return spc_modesense_blockdesc(buf + 3, blocks, block_size) + 3;
837 *buf++ = 1; /* LONGLBA */
840 put_unaligned_be64(blocks, buf);
842 put_unaligned_be32(block_size, buf);
847 static sense_reason_t spc_emulate_modesense(struct se_cmd *cmd)
849 struct se_device *dev = cmd->se_dev;
850 char *cdb = cmd->t_task_cdb;
851 unsigned char *buf, *map_buf;
852 int type = dev->transport->get_device_type(dev);
853 int ten = (cmd->t_task_cdb[0] == MODE_SENSE_10);
854 bool dbd = !!(cdb[1] & 0x08);
855 bool llba = ten ? !!(cdb[1] & 0x10) : false;
857 u8 page = cdb[2] & 0x3f;
863 map_buf = transport_kmap_data_sg(cmd);
865 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
867 * If SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC is not set, then we
868 * know we actually allocated a full page. Otherwise, if the
869 * data buffer is too small, allocate a temporary buffer so we
870 * don't have to worry about overruns in all our INQUIRY
871 * emulation handling.
873 if (cmd->data_length < SE_MODE_PAGE_BUF &&
874 (cmd->se_cmd_flags & SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC)) {
875 buf = kzalloc(SE_MODE_PAGE_BUF, GFP_KERNEL);
877 transport_kunmap_data_sg(cmd);
878 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
884 * Skip over MODE DATA LENGTH + MEDIUM TYPE fields to byte 3 for
885 * MODE_SENSE_10 and byte 2 for MODE_SENSE (6).
887 length = ten ? 3 : 2;
889 /* DEVICE-SPECIFIC PARAMETER */
890 if ((cmd->se_lun->lun_access & TRANSPORT_LUNFLAGS_READ_ONLY) ||
892 (cmd->se_deve->lun_flags & TRANSPORT_LUNFLAGS_READ_ONLY)))
893 spc_modesense_write_protect(&buf[length], type);
895 if ((dev->dev_attrib.emulate_write_cache > 0) &&
896 (dev->dev_attrib.emulate_fua_write > 0))
897 spc_modesense_dpofua(&buf[length], type);
901 /* BLOCK DESCRIPTOR */
904 * For now we only include a block descriptor for disk (SBC)
905 * devices; other command sets use a slightly different format.
907 if (!dbd && type == TYPE_DISK) {
908 u64 blocks = dev->transport->get_blocks(dev);
909 u32 block_size = dev->dev_attrib.block_size;
913 length += spc_modesense_long_blockdesc(&buf[length],
917 length += spc_modesense_blockdesc(&buf[length],
921 length += spc_modesense_blockdesc(&buf[length], blocks,
932 if (subpage != 0x00 && subpage != 0xff) {
933 pr_warn("MODE_SENSE: Invalid subpage code: 0x%02x\n", subpage);
935 transport_kunmap_data_sg(cmd);
936 return TCM_INVALID_CDB_FIELD;
939 for (i = 0; i < ARRAY_SIZE(modesense_handlers); ++i) {
941 * Tricky way to say all subpage 00h for
942 * subpage==0, all subpages for subpage==0xff
943 * (and we just checked above that those are
944 * the only two possibilities).
946 if ((modesense_handlers[i].subpage & ~subpage) == 0) {
947 ret = modesense_handlers[i].emulate(dev, pc, &buf[length]);
948 if (!ten && length + ret >= 255)
957 for (i = 0; i < ARRAY_SIZE(modesense_handlers); ++i)
958 if (modesense_handlers[i].page == page &&
959 modesense_handlers[i].subpage == subpage) {
960 length += modesense_handlers[i].emulate(dev, pc, &buf[length]);
965 * We don't intend to implement:
966 * - obsolete page 03h "format parameters" (checked by Solaris)
969 pr_err("MODE SENSE: unimplemented page/subpage: 0x%02x/0x%02x\n",
972 transport_kunmap_data_sg(cmd);
973 return TCM_UNKNOWN_MODE_PAGE;
977 put_unaligned_be16(length - 2, buf);
981 if (buf != map_buf) {
982 memcpy(map_buf, buf, cmd->data_length);
986 transport_kunmap_data_sg(cmd);
987 target_complete_cmd(cmd, GOOD);
991 static sense_reason_t spc_emulate_modeselect(struct se_cmd *cmd)
993 struct se_device *dev = cmd->se_dev;
994 char *cdb = cmd->t_task_cdb;
995 bool ten = cdb[0] == MODE_SELECT_10;
996 int off = ten ? 8 : 4;
997 bool pf = !!(cdb[1] & 0x10);
1000 unsigned char tbuf[SE_MODE_PAGE_BUF];
1005 buf = transport_kmap_data_sg(cmd);
1007 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1010 ret = TCM_INVALID_CDB_FIELD;
1014 page = buf[off] & 0x3f;
1015 subpage = buf[off] & 0x40 ? buf[off + 1] : 0;
1017 for (i = 0; i < ARRAY_SIZE(modesense_handlers); ++i)
1018 if (modesense_handlers[i].page == page &&
1019 modesense_handlers[i].subpage == subpage) {
1020 memset(tbuf, 0, SE_MODE_PAGE_BUF);
1021 length = modesense_handlers[i].emulate(dev, 0, tbuf);
1022 goto check_contents;
1025 ret = TCM_UNKNOWN_MODE_PAGE;
1029 if (memcmp(buf + off, tbuf, length))
1030 ret = TCM_INVALID_PARAMETER_LIST;
1033 transport_kunmap_data_sg(cmd);
1036 target_complete_cmd(cmd, GOOD);
1040 static sense_reason_t spc_emulate_request_sense(struct se_cmd *cmd)
1042 unsigned char *cdb = cmd->t_task_cdb;
1043 unsigned char *rbuf;
1044 u8 ua_asc = 0, ua_ascq = 0;
1045 unsigned char buf[SE_SENSE_BUF];
1047 memset(buf, 0, SE_SENSE_BUF);
1049 if (cdb[1] & 0x01) {
1050 pr_err("REQUEST_SENSE description emulation not"
1052 return TCM_INVALID_CDB_FIELD;
1055 rbuf = transport_kmap_data_sg(cmd);
1057 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1059 if (!core_scsi3_ua_clear_for_request_sense(cmd, &ua_asc, &ua_ascq)) {
1061 * CURRENT ERROR, UNIT ATTENTION
1064 buf[SPC_SENSE_KEY_OFFSET] = UNIT_ATTENTION;
1067 * The Additional Sense Code (ASC) from the UNIT ATTENTION
1069 buf[SPC_ASC_KEY_OFFSET] = ua_asc;
1070 buf[SPC_ASCQ_KEY_OFFSET] = ua_ascq;
1074 * CURRENT ERROR, NO SENSE
1077 buf[SPC_SENSE_KEY_OFFSET] = NO_SENSE;
1080 * NO ADDITIONAL SENSE INFORMATION
1082 buf[SPC_ASC_KEY_OFFSET] = 0x00;
1086 memcpy(rbuf, buf, min_t(u32, sizeof(buf), cmd->data_length));
1087 transport_kunmap_data_sg(cmd);
1089 target_complete_cmd(cmd, GOOD);
1093 sense_reason_t spc_emulate_report_luns(struct se_cmd *cmd)
1095 struct se_dev_entry *deve;
1096 struct se_session *sess = cmd->se_sess;
1098 u32 lun_count = 0, offset = 8, i;
1100 if (cmd->data_length < 16) {
1101 pr_warn("REPORT LUNS allocation length %u too small\n",
1103 return TCM_INVALID_CDB_FIELD;
1106 buf = transport_kmap_data_sg(cmd);
1108 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1111 * If no struct se_session pointer is present, this struct se_cmd is
1112 * coming via a target_core_mod PASSTHROUGH op, and not through
1113 * a $FABRIC_MOD. In that case, report LUN=0 only.
1116 int_to_scsilun(0, (struct scsi_lun *)&buf[offset]);
1121 spin_lock_irq(&sess->se_node_acl->device_list_lock);
1122 for (i = 0; i < TRANSPORT_MAX_LUNS_PER_TPG; i++) {
1123 deve = sess->se_node_acl->device_list[i];
1124 if (!(deve->lun_flags & TRANSPORT_LUNFLAGS_INITIATOR_ACCESS))
1127 * We determine the correct LUN LIST LENGTH even once we
1128 * have reached the initial allocation length.
1129 * See SPC2-R20 7.19.
1132 if ((offset + 8) > cmd->data_length)
1135 int_to_scsilun(deve->mapped_lun, (struct scsi_lun *)&buf[offset]);
1138 spin_unlock_irq(&sess->se_node_acl->device_list_lock);
1141 * See SPC3 r07, page 159.
1145 buf[0] = ((lun_count >> 24) & 0xff);
1146 buf[1] = ((lun_count >> 16) & 0xff);
1147 buf[2] = ((lun_count >> 8) & 0xff);
1148 buf[3] = (lun_count & 0xff);
1149 transport_kunmap_data_sg(cmd);
1151 target_complete_cmd(cmd, GOOD);
1154 EXPORT_SYMBOL(spc_emulate_report_luns);
1156 static sense_reason_t
1157 spc_emulate_testunitready(struct se_cmd *cmd)
1159 target_complete_cmd(cmd, GOOD);
1164 spc_parse_cdb(struct se_cmd *cmd, unsigned int *size)
1166 struct se_device *dev = cmd->se_dev;
1167 unsigned char *cdb = cmd->t_task_cdb;
1172 cmd->execute_cmd = spc_emulate_modeselect;
1174 case MODE_SELECT_10:
1175 *size = (cdb[7] << 8) + cdb[8];
1176 cmd->execute_cmd = spc_emulate_modeselect;
1180 cmd->execute_cmd = spc_emulate_modesense;
1183 *size = (cdb[7] << 8) + cdb[8];
1184 cmd->execute_cmd = spc_emulate_modesense;
1188 *size = (cdb[7] << 8) + cdb[8];
1190 case PERSISTENT_RESERVE_IN:
1191 *size = (cdb[7] << 8) + cdb[8];
1192 cmd->execute_cmd = target_scsi3_emulate_pr_in;
1194 case PERSISTENT_RESERVE_OUT:
1195 *size = (cdb[7] << 8) + cdb[8];
1196 cmd->execute_cmd = target_scsi3_emulate_pr_out;
1200 if (cdb[0] == RELEASE_10)
1201 *size = (cdb[7] << 8) | cdb[8];
1203 *size = cmd->data_length;
1205 cmd->execute_cmd = target_scsi2_reservation_release;
1210 * The SPC-2 RESERVE does not contain a size in the SCSI CDB.
1211 * Assume the passthrough or $FABRIC_MOD will tell us about it.
1213 if (cdb[0] == RESERVE_10)
1214 *size = (cdb[7] << 8) | cdb[8];
1216 *size = cmd->data_length;
1218 cmd->execute_cmd = target_scsi2_reservation_reserve;
1222 cmd->execute_cmd = spc_emulate_request_sense;
1225 *size = (cdb[3] << 8) + cdb[4];
1228 * Do implict HEAD_OF_QUEUE processing for INQUIRY.
1229 * See spc4r17 section 5.3
1231 cmd->sam_task_attr = MSG_HEAD_TAG;
1232 cmd->execute_cmd = spc_emulate_inquiry;
1234 case SECURITY_PROTOCOL_IN:
1235 case SECURITY_PROTOCOL_OUT:
1236 *size = (cdb[6] << 24) | (cdb[7] << 16) | (cdb[8] << 8) | cdb[9];
1239 case READ_ATTRIBUTE:
1240 case RECEIVE_COPY_RESULTS:
1241 case WRITE_ATTRIBUTE:
1242 *size = (cdb[10] << 24) | (cdb[11] << 16) |
1243 (cdb[12] << 8) | cdb[13];
1245 case RECEIVE_DIAGNOSTIC:
1246 case SEND_DIAGNOSTIC:
1247 *size = (cdb[3] << 8) | cdb[4];
1250 *size = (cdb[6] << 16) + (cdb[7] << 8) + cdb[8];
1253 cmd->execute_cmd = spc_emulate_report_luns;
1254 *size = (cdb[6] << 24) | (cdb[7] << 16) | (cdb[8] << 8) | cdb[9];
1256 * Do implict HEAD_OF_QUEUE processing for REPORT_LUNS
1257 * See spc4r17 section 5.3
1259 cmd->sam_task_attr = MSG_HEAD_TAG;
1261 case TEST_UNIT_READY:
1262 cmd->execute_cmd = spc_emulate_testunitready;
1265 case MAINTENANCE_IN:
1266 if (dev->transport->get_device_type(dev) != TYPE_ROM) {
1268 * MAINTENANCE_IN from SCC-2
1269 * Check for emulated MI_REPORT_TARGET_PGS
1271 if ((cdb[1] & 0x1f) == MI_REPORT_TARGET_PGS) {
1273 target_emulate_report_target_port_groups;
1275 *size = get_unaligned_be32(&cdb[6]);
1278 * GPCMD_SEND_KEY from multi media commands
1280 *size = get_unaligned_be16(&cdb[8]);
1283 case MAINTENANCE_OUT:
1284 if (dev->transport->get_device_type(dev) != TYPE_ROM) {
1286 * MAINTENANCE_OUT from SCC-2
1287 * Check for emulated MO_SET_TARGET_PGS.
1289 if (cdb[1] == MO_SET_TARGET_PGS) {
1291 target_emulate_set_target_port_groups;
1293 *size = get_unaligned_be32(&cdb[6]);
1296 * GPCMD_SEND_KEY from multi media commands
1298 *size = get_unaligned_be16(&cdb[8]);
1302 pr_warn("TARGET_CORE[%s]: Unsupported SCSI Opcode"
1303 " 0x%02x, sending CHECK_CONDITION.\n",
1304 cmd->se_tfo->get_fabric_name(), cdb[0]);
1305 return TCM_UNSUPPORTED_SCSI_OPCODE;
1310 EXPORT_SYMBOL(spc_parse_cdb);