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);
72 static int spc_emulate_inquiry_std(struct se_cmd *cmd, char *buf)
74 struct se_lun *lun = cmd->se_lun;
75 struct se_device *dev = cmd->se_dev;
77 /* Set RMB (removable media) for tape devices */
78 if (dev->transport->get_device_type(dev) == TYPE_TAPE)
81 buf[2] = 0x05; /* SPC-3 */
84 * NORMACA and HISUP = 0, RESPONSE DATA FORMAT = 2
87 * A RESPONSE DATA FORMAT field set to 2h indicates that the
88 * standard INQUIRY data is in the format defined in this
89 * standard. Response data format values less than 2h are
90 * obsolete. Response data format values greater than 2h are
96 * Enable SCCS and TPGS fields for Emulated ALUA
98 spc_fill_alua_data(lun->lun_sep, buf);
100 buf[7] = 0x2; /* CmdQue=1 */
102 snprintf(&buf[8], 8, "LIO-ORG");
103 snprintf(&buf[16], 16, "%s", dev->t10_wwn.model);
104 snprintf(&buf[32], 4, "%s", dev->t10_wwn.revision);
105 buf[4] = 31; /* Set additional length to 31 */
110 /* unit serial number */
111 static int spc_emulate_evpd_80(struct se_cmd *cmd, unsigned char *buf)
113 struct se_device *dev = cmd->se_dev;
116 if (dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL) {
119 unit_serial_len = strlen(dev->t10_wwn.unit_serial);
120 unit_serial_len++; /* For NULL Terminator */
122 len += sprintf(&buf[4], "%s", dev->t10_wwn.unit_serial);
123 len++; /* Extra Byte for NULL Terminator */
129 static void spc_parse_naa_6h_vendor_specific(struct se_device *dev,
132 unsigned char *p = &dev->t10_wwn.unit_serial[0];
137 * Generate up to 36 bits of VENDOR SPECIFIC IDENTIFIER starting on
138 * byte 3 bit 3-0 for NAA IEEE Registered Extended DESIGNATOR field
139 * format, followed by 64 bits of VENDOR SPECIFIC IDENTIFIER EXTENSION
140 * to complete the payload. These are based from VPD=0x80 PRODUCT SERIAL
141 * NUMBER set via vpd_unit_serial in target_core_configfs.c to ensure
142 * per device uniqeness.
144 for (cnt = 0; *p && cnt < 13; p++) {
145 int val = hex_to_bin(*p);
161 * Device identification VPD, for a complete list of
162 * DESIGNATOR TYPEs see spc4r17 Table 459.
164 static int spc_emulate_evpd_83(struct se_cmd *cmd, unsigned char *buf)
166 struct se_device *dev = cmd->se_dev;
167 struct se_lun *lun = cmd->se_lun;
168 struct se_port *port = NULL;
169 struct se_portal_group *tpg = NULL;
170 struct t10_alua_lu_gp_member *lu_gp_mem;
171 struct t10_alua_tg_pt_gp *tg_pt_gp;
172 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
173 unsigned char *prod = &dev->t10_wwn.model[0];
175 u32 unit_serial_len, off = 0;
181 * NAA IEEE Registered Extended Assigned designator format, see
182 * spc4r17 section 7.7.3.6.5
184 * We depend upon a target_core_mod/ConfigFS provided
185 * /sys/kernel/config/target/core/$HBA/$DEV/wwn/vpd_unit_serial
186 * value in order to return the NAA id.
188 if (!(dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL))
189 goto check_t10_vend_desc;
191 /* CODE SET == Binary */
194 /* Set ASSOCIATION == addressed logical unit: 0)b */
197 /* Identifier/Designator type == NAA identifier */
201 /* Identifier/Designator length */
205 * Start NAA IEEE Registered Extended Identifier/Designator
207 buf[off++] = (0x6 << 4);
210 * Use OpenFabrics IEEE Company ID: 00 14 05
214 buf[off] = (0x5 << 4);
217 * Return ConfigFS Unit Serial Number information for
218 * VENDOR_SPECIFIC_IDENTIFIER and
219 * VENDOR_SPECIFIC_IDENTIFIER_EXTENTION
221 spc_parse_naa_6h_vendor_specific(dev, &buf[off]);
228 * T10 Vendor Identifier Page, see spc4r17 section 7.7.3.4
230 id_len = 8; /* For Vendor field */
231 prod_len = 4; /* For VPD Header */
232 prod_len += 8; /* For Vendor field */
233 prod_len += strlen(prod);
234 prod_len++; /* For : */
236 if (dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL) {
237 unit_serial_len = strlen(&dev->t10_wwn.unit_serial[0]);
238 unit_serial_len++; /* For NULL Terminator */
240 id_len += sprintf(&buf[off+12], "%s:%s", prod,
241 &dev->t10_wwn.unit_serial[0]);
243 buf[off] = 0x2; /* ASCII */
244 buf[off+1] = 0x1; /* T10 Vendor ID */
246 memcpy(&buf[off+4], "LIO-ORG", 8);
247 /* Extra Byte for NULL Terminator */
249 /* Identifier Length */
251 /* Header size for Designation descriptor */
255 * struct se_port is only set for INQUIRY VPD=1 through $FABRIC_MOD
259 struct t10_alua_lu_gp *lu_gp;
260 u32 padding, scsi_name_len;
267 * Relative target port identifer, see spc4r17
270 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
271 * section 7.5.1 Table 362
274 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
275 buf[off++] |= 0x1; /* CODE SET == Binary */
276 buf[off] = 0x80; /* Set PIV=1 */
277 /* Set ASSOCIATION == target port: 01b */
279 /* DESIGNATOR TYPE == Relative target port identifer */
281 off++; /* Skip over Reserved */
282 buf[off++] = 4; /* DESIGNATOR LENGTH */
283 /* Skip over Obsolete field in RTPI payload
286 buf[off++] = ((port->sep_rtpi >> 8) & 0xff);
287 buf[off++] = (port->sep_rtpi & 0xff);
288 len += 8; /* Header size + Designation descriptor */
290 * Target port group identifier, see spc4r17
293 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
294 * section 7.5.1 Table 362
296 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
300 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
301 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
303 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
306 tg_pt_gp_id = tg_pt_gp->tg_pt_gp_id;
307 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
310 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
311 buf[off++] |= 0x1; /* CODE SET == Binary */
312 buf[off] = 0x80; /* Set PIV=1 */
313 /* Set ASSOCIATION == target port: 01b */
315 /* DESIGNATOR TYPE == Target port group identifier */
317 off++; /* Skip over Reserved */
318 buf[off++] = 4; /* DESIGNATOR LENGTH */
319 off += 2; /* Skip over Reserved Field */
320 buf[off++] = ((tg_pt_gp_id >> 8) & 0xff);
321 buf[off++] = (tg_pt_gp_id & 0xff);
322 len += 8; /* Header size + Designation descriptor */
324 * Logical Unit Group identifier, see spc4r17
328 lu_gp_mem = dev->dev_alua_lu_gp_mem;
330 goto check_scsi_name;
332 spin_lock(&lu_gp_mem->lu_gp_mem_lock);
333 lu_gp = lu_gp_mem->lu_gp;
335 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
336 goto check_scsi_name;
338 lu_gp_id = lu_gp->lu_gp_id;
339 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
341 buf[off++] |= 0x1; /* CODE SET == Binary */
342 /* DESIGNATOR TYPE == Logical Unit Group identifier */
344 off++; /* Skip over Reserved */
345 buf[off++] = 4; /* DESIGNATOR LENGTH */
346 off += 2; /* Skip over Reserved Field */
347 buf[off++] = ((lu_gp_id >> 8) & 0xff);
348 buf[off++] = (lu_gp_id & 0xff);
349 len += 8; /* Header size + Designation descriptor */
351 * SCSI name string designator, see spc4r17
354 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
355 * section 7.5.1 Table 362
358 scsi_name_len = strlen(tpg->se_tpg_tfo->tpg_get_wwn(tpg));
359 /* UTF-8 ",t,0x<16-bit TPGT>" + NULL Terminator */
361 /* Check for 4-byte padding */
362 padding = ((-scsi_name_len) & 3);
364 scsi_name_len += padding;
365 /* Header size + Designation descriptor */
369 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
370 buf[off++] |= 0x3; /* CODE SET == UTF-8 */
371 buf[off] = 0x80; /* Set PIV=1 */
372 /* Set ASSOCIATION == target port: 01b */
374 /* DESIGNATOR TYPE == SCSI name string */
376 off += 2; /* Skip over Reserved and length */
378 * SCSI name string identifer containing, $FABRIC_MOD
379 * dependent information. For LIO-Target and iSCSI
380 * Target Port, this means "<iSCSI name>,t,0x<TPGT> in
383 tpgt = tpg->se_tpg_tfo->tpg_get_tag(tpg);
384 scsi_name_len = sprintf(&buf[off], "%s,t,0x%04x",
385 tpg->se_tpg_tfo->tpg_get_wwn(tpg), tpgt);
386 scsi_name_len += 1 /* Include NULL terminator */;
388 * The null-terminated, null-padded (see 4.4.2) SCSI
389 * NAME STRING field contains a UTF-8 format string.
390 * The number of bytes in the SCSI NAME STRING field
391 * (i.e., the value in the DESIGNATOR LENGTH field)
392 * shall be no larger than 256 and shall be a multiple
396 scsi_name_len += padding;
398 buf[off-1] = scsi_name_len;
399 off += scsi_name_len;
400 /* Header size + Designation descriptor */
401 len += (scsi_name_len + 4);
403 buf[2] = ((len >> 8) & 0xff);
404 buf[3] = (len & 0xff); /* Page Length for VPD 0x83 */
408 /* Extended INQUIRY Data VPD Page */
409 static int spc_emulate_evpd_86(struct se_cmd *cmd, unsigned char *buf)
412 /* Set HEADSUP, ORDSUP, SIMPSUP */
415 /* If WriteCache emulation is enabled, set V_SUP */
416 if (cmd->se_dev->dev_attrib.emulate_write_cache > 0)
421 /* Block Limits VPD page */
422 static int spc_emulate_evpd_b0(struct se_cmd *cmd, unsigned char *buf)
424 struct se_device *dev = cmd->se_dev;
429 * Following spc3r22 section 6.5.3 Block Limits VPD page, when
430 * emulate_tpu=1 or emulate_tpws=1 we will be expect a
431 * different page length for Thin Provisioning.
433 if (dev->dev_attrib.emulate_tpu || dev->dev_attrib.emulate_tpws)
436 buf[0] = dev->transport->get_device_type(dev);
437 buf[3] = have_tp ? 0x3c : 0x10;
443 * Set OPTIMAL TRANSFER LENGTH GRANULARITY
445 put_unaligned_be16(1, &buf[6]);
448 * Set MAXIMUM TRANSFER LENGTH
450 max_sectors = min(dev->dev_attrib.fabric_max_sectors,
451 dev->dev_attrib.hw_max_sectors);
452 put_unaligned_be32(max_sectors, &buf[8]);
455 * Set OPTIMAL TRANSFER LENGTH
457 put_unaligned_be32(dev->dev_attrib.optimal_sectors, &buf[12]);
460 * Exit now if we don't support TP.
466 * Set MAXIMUM UNMAP LBA COUNT
468 put_unaligned_be32(dev->dev_attrib.max_unmap_lba_count, &buf[20]);
471 * Set MAXIMUM UNMAP BLOCK DESCRIPTOR COUNT
473 put_unaligned_be32(dev->dev_attrib.max_unmap_block_desc_count,
477 * Set OPTIMAL UNMAP GRANULARITY
479 put_unaligned_be32(dev->dev_attrib.unmap_granularity, &buf[28]);
482 * UNMAP GRANULARITY ALIGNMENT
484 put_unaligned_be32(dev->dev_attrib.unmap_granularity_alignment,
486 if (dev->dev_attrib.unmap_granularity_alignment != 0)
487 buf[32] |= 0x80; /* Set the UGAVALID bit */
492 /* Block Device Characteristics VPD page */
493 static int spc_emulate_evpd_b1(struct se_cmd *cmd, unsigned char *buf)
495 struct se_device *dev = cmd->se_dev;
497 buf[0] = dev->transport->get_device_type(dev);
499 buf[5] = dev->dev_attrib.is_nonrot ? 1 : 0;
504 /* Thin Provisioning VPD */
505 static int spc_emulate_evpd_b2(struct se_cmd *cmd, unsigned char *buf)
507 struct se_device *dev = cmd->se_dev;
510 * From spc3r22 section 6.5.4 Thin Provisioning VPD page:
512 * The PAGE LENGTH field is defined in SPC-4. If the DP bit is set to
513 * zero, then the page length shall be set to 0004h. If the DP bit
514 * is set to one, then the page length shall be set to the value
515 * defined in table 162.
517 buf[0] = dev->transport->get_device_type(dev);
520 * Set Hardcoded length mentioned above for DP=0
522 put_unaligned_be16(0x0004, &buf[2]);
525 * The THRESHOLD EXPONENT field indicates the threshold set size in
526 * LBAs as a power of 2 (i.e., the threshold set size is equal to
527 * 2(threshold exponent)).
529 * Note that this is currently set to 0x00 as mkp says it will be
530 * changing again. We can enable this once it has settled in T10
531 * and is actually used by Linux/SCSI ML code.
536 * A TPU bit set to one indicates that the device server supports
537 * the UNMAP command (see 5.25). A TPU bit set to zero indicates
538 * that the device server does not support the UNMAP command.
540 if (dev->dev_attrib.emulate_tpu != 0)
544 * A TPWS bit set to one indicates that the device server supports
545 * the use of the WRITE SAME (16) command (see 5.42) to unmap LBAs.
546 * A TPWS bit set to zero indicates that the device server does not
547 * support the use of the WRITE SAME (16) command to unmap LBAs.
549 if (dev->dev_attrib.emulate_tpws != 0)
555 static int spc_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf);
559 int (*emulate)(struct se_cmd *, unsigned char *);
560 } evpd_handlers[] = {
561 { .page = 0x00, .emulate = spc_emulate_evpd_00 },
562 { .page = 0x80, .emulate = spc_emulate_evpd_80 },
563 { .page = 0x83, .emulate = spc_emulate_evpd_83 },
564 { .page = 0x86, .emulate = spc_emulate_evpd_86 },
565 { .page = 0xb0, .emulate = spc_emulate_evpd_b0 },
566 { .page = 0xb1, .emulate = spc_emulate_evpd_b1 },
567 { .page = 0xb2, .emulate = spc_emulate_evpd_b2 },
570 /* supported vital product data pages */
571 static int spc_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf)
576 * Only report the INQUIRY EVPD=1 pages after a valid NAA
577 * Registered Extended LUN WWN has been set via ConfigFS
578 * during device creation/restart.
580 if (cmd->se_dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL) {
581 buf[3] = ARRAY_SIZE(evpd_handlers);
582 for (p = 0; p < ARRAY_SIZE(evpd_handlers); ++p)
583 buf[p + 4] = evpd_handlers[p].page;
589 static int spc_emulate_inquiry(struct se_cmd *cmd)
591 struct se_device *dev = cmd->se_dev;
592 struct se_portal_group *tpg = cmd->se_lun->lun_sep->sep_tpg;
594 unsigned char *cdb = cmd->t_task_cdb;
595 unsigned char buf[SE_INQUIRY_BUF];
598 memset(buf, 0, SE_INQUIRY_BUF);
600 if (dev == tpg->tpg_virt_lun0.lun_se_dev)
601 buf[0] = 0x3f; /* Not connected */
603 buf[0] = dev->transport->get_device_type(dev);
605 if (!(cdb[1] & 0x1)) {
607 pr_err("INQUIRY with EVPD==0 but PAGE CODE=%02x\n",
609 cmd->scsi_sense_reason = TCM_INVALID_CDB_FIELD;
614 ret = spc_emulate_inquiry_std(cmd, buf);
618 for (p = 0; p < ARRAY_SIZE(evpd_handlers); ++p) {
619 if (cdb[2] == evpd_handlers[p].page) {
621 ret = evpd_handlers[p].emulate(cmd, buf);
626 pr_err("Unknown VPD Code: 0x%02x\n", cdb[2]);
627 cmd->scsi_sense_reason = TCM_INVALID_CDB_FIELD;
631 rbuf = transport_kmap_data_sg(cmd);
633 memcpy(rbuf, buf, min_t(u32, sizeof(buf), cmd->data_length));
634 transport_kunmap_data_sg(cmd);
638 target_complete_cmd(cmd, GOOD);
642 static int spc_modesense_rwrecovery(struct se_device *dev, u8 pc, u8 *p)
647 /* No changeable values for now */
655 static int spc_modesense_control(struct se_device *dev, u8 pc, u8 *p)
660 /* No changeable values for now */
666 * From spc4r23, 7.4.7 Control mode page
668 * The QUEUE ALGORITHM MODIFIER field (see table 368) specifies
669 * restrictions on the algorithm used for reordering commands
670 * having the SIMPLE task attribute (see SAM-4).
672 * Table 368 -- QUEUE ALGORITHM MODIFIER field
674 * 0h Restricted reordering
675 * 1h Unrestricted reordering allowed
677 * 8h to Fh Vendor specific
679 * A value of zero in the QUEUE ALGORITHM MODIFIER field specifies that
680 * the device server shall order the processing sequence of commands
681 * having the SIMPLE task attribute such that data integrity is maintained
682 * for that I_T nexus (i.e., if the transmission of new SCSI transport protocol
683 * requests is halted at any time, the final value of all data observable
684 * on the medium shall be the same as if all the commands had been processed
685 * with the ORDERED task attribute).
687 * A value of one in the QUEUE ALGORITHM MODIFIER field specifies that the
688 * device server may reorder the processing sequence of commands having the
689 * SIMPLE task attribute in any manner. Any data integrity exposures related to
690 * command sequence order shall be explicitly handled by the application client
691 * through the selection of appropriate ommands and task attributes.
693 p[3] = (dev->dev_attrib.emulate_rest_reord == 1) ? 0x00 : 0x10;
695 * From spc4r17, section 7.4.6 Control mode Page
697 * Unit Attention interlocks control (UN_INTLCK_CTRL) to code 00b
699 * 00b: The logical unit shall clear any unit attention condition
700 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
701 * status and shall not establish a unit attention condition when a com-
702 * mand is completed with BUSY, TASK SET FULL, or RESERVATION CONFLICT
705 * 10b: The logical unit shall not clear any unit attention condition
706 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
707 * status and shall not establish a unit attention condition when
708 * a command is completed with BUSY, TASK SET FULL, or RESERVATION
711 * 11b a The logical unit shall not clear any unit attention condition
712 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
713 * status and shall establish a unit attention condition for the
714 * initiator port associated with the I_T nexus on which the BUSY,
715 * TASK SET FULL, or RESERVATION CONFLICT status is being returned.
716 * Depending on the status, the additional sense code shall be set to
717 * PREVIOUS BUSY STATUS, PREVIOUS TASK SET FULL STATUS, or PREVIOUS
718 * RESERVATION CONFLICT STATUS. Until it is cleared by a REQUEST SENSE
719 * command, a unit attention condition shall be established only once
720 * for a BUSY, TASK SET FULL, or RESERVATION CONFLICT status regardless
721 * to the number of commands completed with one of those status codes.
723 p[4] = (dev->dev_attrib.emulate_ua_intlck_ctrl == 2) ? 0x30 :
724 (dev->dev_attrib.emulate_ua_intlck_ctrl == 1) ? 0x20 : 0x00;
726 * From spc4r17, section 7.4.6 Control mode Page
728 * Task Aborted Status (TAS) bit set to zero.
730 * A task aborted status (TAS) bit set to zero specifies that aborted
731 * tasks shall be terminated by the device server without any response
732 * to the application client. A TAS bit set to one specifies that tasks
733 * aborted by the actions of an I_T nexus other than the I_T nexus on
734 * which the command was received shall be completed with TASK ABORTED
735 * status (see SAM-4).
737 p[5] = (dev->dev_attrib.emulate_tas) ? 0x40 : 0x00;
746 static int spc_modesense_caching(struct se_device *dev, u8 pc, u8 *p)
751 /* No changeable values for now */
755 if (dev->dev_attrib.emulate_write_cache > 0)
756 p[2] = 0x04; /* Write Cache Enable */
757 p[12] = 0x20; /* Disabled Read Ahead */
763 static int spc_modesense_informational_exceptions(struct se_device *dev, u8 pc, unsigned char *p)
768 /* No changeable values for now */
779 int (*emulate)(struct se_device *, u8, unsigned char *);
780 } modesense_handlers[] = {
781 { .page = 0x01, .subpage = 0x00, .emulate = spc_modesense_rwrecovery },
782 { .page = 0x08, .subpage = 0x00, .emulate = spc_modesense_caching },
783 { .page = 0x0a, .subpage = 0x00, .emulate = spc_modesense_control },
784 { .page = 0x1c, .subpage = 0x00, .emulate = spc_modesense_informational_exceptions },
787 static void spc_modesense_write_protect(unsigned char *buf, int type)
790 * I believe that the WP bit (bit 7) in the mode header is the same for
797 buf[0] |= 0x80; /* WP bit */
802 static void spc_modesense_dpofua(unsigned char *buf, int type)
806 buf[0] |= 0x10; /* DPOFUA bit */
813 static int spc_modesense_blockdesc(unsigned char *buf, u64 blocks, u32 block_size)
816 put_unaligned_be32(min(blocks, 0xffffffffull), buf);
818 put_unaligned_be32(block_size, buf);
822 static int spc_modesense_long_blockdesc(unsigned char *buf, u64 blocks, u32 block_size)
824 if (blocks <= 0xffffffff)
825 return spc_modesense_blockdesc(buf + 3, blocks, block_size) + 3;
827 *buf++ = 1; /* LONGLBA */
830 put_unaligned_be64(blocks, buf);
832 put_unaligned_be32(block_size, buf);
837 static int spc_emulate_modesense(struct se_cmd *cmd)
839 struct se_device *dev = cmd->se_dev;
840 char *cdb = cmd->t_task_cdb;
841 unsigned char *buf, *map_buf;
842 int type = dev->transport->get_device_type(dev);
843 int ten = (cmd->t_task_cdb[0] == MODE_SENSE_10);
844 bool dbd = !!(cdb[1] & 0x08);
845 bool llba = ten ? !!(cdb[1] & 0x10) : false;
847 u8 page = cdb[2] & 0x3f;
853 map_buf = transport_kmap_data_sg(cmd);
856 * If SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC is not set, then we
857 * know we actually allocated a full page. Otherwise, if the
858 * data buffer is too small, allocate a temporary buffer so we
859 * don't have to worry about overruns in all our INQUIRY
860 * emulation handling.
862 if (cmd->data_length < SE_MODE_PAGE_BUF &&
863 (cmd->se_cmd_flags & SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC)) {
864 buf = kzalloc(SE_MODE_PAGE_BUF, GFP_KERNEL);
866 transport_kunmap_data_sg(cmd);
867 cmd->scsi_sense_reason = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
874 * Skip over MODE DATA LENGTH + MEDIUM TYPE fields to byte 3 for
875 * MODE_SENSE_10 and byte 2 for MODE_SENSE (6).
877 length = ten ? 3 : 2;
879 /* DEVICE-SPECIFIC PARAMETER */
880 if ((cmd->se_lun->lun_access & TRANSPORT_LUNFLAGS_READ_ONLY) ||
882 (cmd->se_deve->lun_flags & TRANSPORT_LUNFLAGS_READ_ONLY)))
883 spc_modesense_write_protect(&buf[length], type);
885 if ((dev->dev_attrib.emulate_write_cache > 0) &&
886 (dev->dev_attrib.emulate_fua_write > 0))
887 spc_modesense_dpofua(&buf[length], type);
891 /* BLOCK DESCRIPTOR */
894 * For now we only include a block descriptor for disk (SBC)
895 * devices; other command sets use a slightly different format.
897 if (!dbd && type == TYPE_DISK) {
898 u64 blocks = dev->transport->get_blocks(dev);
899 u32 block_size = dev->dev_attrib.block_size;
903 length += spc_modesense_long_blockdesc(&buf[length],
907 length += spc_modesense_blockdesc(&buf[length],
911 length += spc_modesense_blockdesc(&buf[length], blocks,
922 if (subpage != 0x00 && subpage != 0xff) {
923 cmd->scsi_sense_reason = TCM_INVALID_CDB_FIELD;
928 for (i = 0; i < ARRAY_SIZE(modesense_handlers); ++i) {
930 * Tricky way to say all subpage 00h for
931 * subpage==0, all subpages for subpage==0xff
932 * (and we just checked above that those are
933 * the only two possibilities).
935 if ((modesense_handlers[i].subpage & ~subpage) == 0) {
936 ret = modesense_handlers[i].emulate(dev, pc, &buf[length]);
937 if (!ten && length + ret >= 255)
946 for (i = 0; i < ARRAY_SIZE(modesense_handlers); ++i)
947 if (modesense_handlers[i].page == page &&
948 modesense_handlers[i].subpage == subpage) {
949 length += modesense_handlers[i].emulate(dev, pc, &buf[length]);
954 * We don't intend to implement:
955 * - obsolete page 03h "format parameters" (checked by Solaris)
958 pr_err("MODE SENSE: unimplemented page/subpage: 0x%02x/0x%02x\n",
961 cmd->scsi_sense_reason = TCM_UNKNOWN_MODE_PAGE;
966 put_unaligned_be16(length - 2, buf);
971 if (buf != map_buf) {
972 memcpy(map_buf, buf, cmd->data_length);
976 transport_kunmap_data_sg(cmd);
977 target_complete_cmd(cmd, GOOD);
981 static int spc_emulate_modeselect(struct se_cmd *cmd)
983 struct se_device *dev = cmd->se_dev;
984 char *cdb = cmd->t_task_cdb;
985 bool ten = cdb[0] == MODE_SELECT_10;
986 int off = ten ? 8 : 4;
987 bool pf = !!(cdb[1] & 0x10);
990 unsigned char tbuf[SE_MODE_PAGE_BUF];
995 buf = transport_kmap_data_sg(cmd);
998 cmd->scsi_sense_reason = TCM_INVALID_CDB_FIELD;
1003 page = buf[off] & 0x3f;
1004 subpage = buf[off] & 0x40 ? buf[off + 1] : 0;
1006 for (i = 0; i < ARRAY_SIZE(modesense_handlers); ++i)
1007 if (modesense_handlers[i].page == page &&
1008 modesense_handlers[i].subpage == subpage) {
1009 memset(tbuf, 0, SE_MODE_PAGE_BUF);
1010 length = modesense_handlers[i].emulate(dev, 0, tbuf);
1011 goto check_contents;
1014 cmd->scsi_sense_reason = TCM_UNKNOWN_MODE_PAGE;
1019 if (memcmp(buf + off, tbuf, length)) {
1020 cmd->scsi_sense_reason = TCM_INVALID_PARAMETER_LIST;
1025 transport_kunmap_data_sg(cmd);
1028 target_complete_cmd(cmd, GOOD);
1032 static int spc_emulate_request_sense(struct se_cmd *cmd)
1034 unsigned char *cdb = cmd->t_task_cdb;
1035 unsigned char *rbuf;
1036 u8 ua_asc = 0, ua_ascq = 0;
1037 unsigned char buf[SE_SENSE_BUF];
1039 memset(buf, 0, SE_SENSE_BUF);
1041 if (cdb[1] & 0x01) {
1042 pr_err("REQUEST_SENSE description emulation not"
1044 cmd->scsi_sense_reason = TCM_INVALID_CDB_FIELD;
1048 rbuf = transport_kmap_data_sg(cmd);
1049 if (cmd->scsi_sense_reason != 0) {
1051 * Out of memory. We will fail with CHECK CONDITION, so
1052 * we must not clear the unit attention condition.
1054 target_complete_cmd(cmd, CHECK_CONDITION);
1056 } else if (!core_scsi3_ua_clear_for_request_sense(cmd, &ua_asc, &ua_ascq)) {
1058 * CURRENT ERROR, UNIT ATTENTION
1061 buf[SPC_SENSE_KEY_OFFSET] = UNIT_ATTENTION;
1064 * The Additional Sense Code (ASC) from the UNIT ATTENTION
1066 buf[SPC_ASC_KEY_OFFSET] = ua_asc;
1067 buf[SPC_ASCQ_KEY_OFFSET] = ua_ascq;
1071 * CURRENT ERROR, NO SENSE
1074 buf[SPC_SENSE_KEY_OFFSET] = NO_SENSE;
1077 * NO ADDITIONAL SENSE INFORMATION
1079 buf[SPC_ASC_KEY_OFFSET] = 0x00;
1084 memcpy(rbuf, buf, min_t(u32, sizeof(buf), cmd->data_length));
1085 transport_kunmap_data_sg(cmd);
1088 target_complete_cmd(cmd, GOOD);
1092 int spc_emulate_report_luns(struct se_cmd *cmd)
1094 struct se_dev_entry *deve;
1095 struct se_session *sess = cmd->se_sess;
1097 u32 lun_count = 0, offset = 8, i;
1099 if (cmd->data_length < 16) {
1100 pr_warn("REPORT LUNS allocation length %u too small\n",
1102 cmd->scsi_sense_reason = TCM_INVALID_CDB_FIELD;
1106 buf = transport_kmap_data_sg(cmd);
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 int spc_emulate_testunitready(struct se_cmd *cmd)
1158 target_complete_cmd(cmd, GOOD);
1162 int spc_parse_cdb(struct se_cmd *cmd, unsigned int *size)
1164 struct se_device *dev = cmd->se_dev;
1165 unsigned char *cdb = cmd->t_task_cdb;
1170 cmd->execute_cmd = spc_emulate_modeselect;
1172 case MODE_SELECT_10:
1173 *size = (cdb[7] << 8) + cdb[8];
1174 cmd->execute_cmd = spc_emulate_modeselect;
1178 cmd->execute_cmd = spc_emulate_modesense;
1181 *size = (cdb[7] << 8) + cdb[8];
1182 cmd->execute_cmd = spc_emulate_modesense;
1186 *size = (cdb[7] << 8) + cdb[8];
1188 case PERSISTENT_RESERVE_IN:
1189 *size = (cdb[7] << 8) + cdb[8];
1190 cmd->execute_cmd = target_scsi3_emulate_pr_in;
1192 case PERSISTENT_RESERVE_OUT:
1193 *size = (cdb[7] << 8) + cdb[8];
1194 cmd->execute_cmd = target_scsi3_emulate_pr_out;
1198 if (cdb[0] == RELEASE_10)
1199 *size = (cdb[7] << 8) | cdb[8];
1201 *size = cmd->data_length;
1203 cmd->execute_cmd = target_scsi2_reservation_release;
1208 * The SPC-2 RESERVE does not contain a size in the SCSI CDB.
1209 * Assume the passthrough or $FABRIC_MOD will tell us about it.
1211 if (cdb[0] == RESERVE_10)
1212 *size = (cdb[7] << 8) | cdb[8];
1214 *size = cmd->data_length;
1216 cmd->execute_cmd = target_scsi2_reservation_reserve;
1220 cmd->execute_cmd = spc_emulate_request_sense;
1223 *size = (cdb[3] << 8) + cdb[4];
1226 * Do implict HEAD_OF_QUEUE processing for INQUIRY.
1227 * See spc4r17 section 5.3
1229 cmd->sam_task_attr = MSG_HEAD_TAG;
1230 cmd->execute_cmd = spc_emulate_inquiry;
1232 case SECURITY_PROTOCOL_IN:
1233 case SECURITY_PROTOCOL_OUT:
1234 *size = (cdb[6] << 24) | (cdb[7] << 16) | (cdb[8] << 8) | cdb[9];
1237 case READ_ATTRIBUTE:
1238 case RECEIVE_COPY_RESULTS:
1239 case WRITE_ATTRIBUTE:
1240 *size = (cdb[10] << 24) | (cdb[11] << 16) |
1241 (cdb[12] << 8) | cdb[13];
1243 case RECEIVE_DIAGNOSTIC:
1244 case SEND_DIAGNOSTIC:
1245 *size = (cdb[3] << 8) | cdb[4];
1248 *size = (cdb[6] << 16) + (cdb[7] << 8) + cdb[8];
1251 cmd->execute_cmd = spc_emulate_report_luns;
1252 *size = (cdb[6] << 24) | (cdb[7] << 16) | (cdb[8] << 8) | cdb[9];
1254 * Do implict HEAD_OF_QUEUE processing for REPORT_LUNS
1255 * See spc4r17 section 5.3
1257 cmd->sam_task_attr = MSG_HEAD_TAG;
1259 case TEST_UNIT_READY:
1260 cmd->execute_cmd = spc_emulate_testunitready;
1263 case MAINTENANCE_IN:
1264 if (dev->transport->get_device_type(dev) != TYPE_ROM) {
1266 * MAINTENANCE_IN from SCC-2
1267 * Check for emulated MI_REPORT_TARGET_PGS
1269 if ((cdb[1] & 0x1f) == MI_REPORT_TARGET_PGS) {
1271 target_emulate_report_target_port_groups;
1273 *size = get_unaligned_be32(&cdb[6]);
1276 * GPCMD_SEND_KEY from multi media commands
1278 *size = get_unaligned_be16(&cdb[8]);
1281 case MAINTENANCE_OUT:
1282 if (dev->transport->get_device_type(dev) != TYPE_ROM) {
1284 * MAINTENANCE_OUT from SCC-2
1285 * Check for emulated MO_SET_TARGET_PGS.
1287 if (cdb[1] == MO_SET_TARGET_PGS) {
1289 target_emulate_set_target_port_groups;
1291 *size = get_unaligned_be32(&cdb[6]);
1294 * GPCMD_SEND_KEY from multi media commands
1296 *size = get_unaligned_be16(&cdb[8]);
1300 pr_warn("TARGET_CORE[%s]: Unsupported SCSI Opcode"
1301 " 0x%02x, sending CHECK_CONDITION.\n",
1302 cmd->se_tfo->get_fabric_name(), cdb[0]);
1303 cmd->se_cmd_flags |= SCF_SCSI_CDB_EXCEPTION;
1304 cmd->scsi_sense_reason = TCM_UNSUPPORTED_SCSI_OPCODE;
1310 EXPORT_SYMBOL(spc_parse_cdb);