2 * SCSI Primary Commands (SPC) parsing and emulation.
4 * (c) Copyright 2002-2013 Datera, Inc.
6 * Nicholas A. Bellinger <nab@kernel.org>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 #include <linux/kernel.h>
24 #include <linux/module.h>
25 #include <asm/unaligned.h>
27 #include <scsi/scsi.h>
28 #include <scsi/scsi_tcq.h>
30 #include <target/target_core_base.h>
31 #include <target/target_core_backend.h>
32 #include <target/target_core_fabric.h>
34 #include "target_core_internal.h"
35 #include "target_core_alua.h"
36 #include "target_core_pr.h"
37 #include "target_core_ua.h"
38 #include "target_core_xcopy.h"
40 static void spc_fill_alua_data(struct se_port
*port
, unsigned char *buf
)
42 struct t10_alua_tg_pt_gp
*tg_pt_gp
;
43 struct t10_alua_tg_pt_gp_member
*tg_pt_gp_mem
;
46 * Set SCCS for MAINTENANCE_IN + REPORT_TARGET_PORT_GROUPS.
51 * Set TPGS field for explicit and/or implicit ALUA access type
54 * See spc4r17 section 6.4.2 Table 135
58 tg_pt_gp_mem
= port
->sep_alua_tg_pt_gp_mem
;
62 spin_lock(&tg_pt_gp_mem
->tg_pt_gp_mem_lock
);
63 tg_pt_gp
= tg_pt_gp_mem
->tg_pt_gp
;
65 buf
[5] |= tg_pt_gp
->tg_pt_gp_alua_access_type
;
66 spin_unlock(&tg_pt_gp_mem
->tg_pt_gp_mem_lock
);
70 spc_emulate_inquiry_std(struct se_cmd
*cmd
, unsigned char *buf
)
72 struct se_lun
*lun
= cmd
->se_lun
;
73 struct se_device
*dev
= cmd
->se_dev
;
74 struct se_session
*sess
= cmd
->se_sess
;
76 /* Set RMB (removable media) for tape devices */
77 if (dev
->transport
->get_device_type(dev
) == TYPE_TAPE
)
80 buf
[2] = 0x05; /* SPC-3 */
83 * NORMACA and HISUP = 0, RESPONSE DATA FORMAT = 2
86 * A RESPONSE DATA FORMAT field set to 2h indicates that the
87 * standard INQUIRY data is in the format defined in this
88 * standard. Response data format values less than 2h are
89 * obsolete. Response data format values greater than 2h are
95 * Enable SCCS and TPGS fields for Emulated ALUA
97 spc_fill_alua_data(lun
->lun_sep
, buf
);
100 * Set Third-Party Copy (3PC) bit to indicate support for EXTENDED_COPY
102 if (dev
->dev_attrib
.emulate_3pc
)
105 * Set Protection (PROTECT) bit when DIF has been enabled on the
106 * device, and the fabric supports VERIFY + PASS. Also report
107 * PROTECT=1 if sess_prot_type has been configured to allow T10-PI
108 * to unprotected devices.
110 if (sess
->sup_prot_ops
& (TARGET_PROT_DIN_PASS
| TARGET_PROT_DOUT_PASS
)) {
111 if (dev
->dev_attrib
.pi_prot_type
|| cmd
->se_sess
->sess_prot_type
)
115 buf
[7] = 0x2; /* CmdQue=1 */
117 memcpy(&buf
[8], "LIO-ORG ", 8);
118 memset(&buf
[16], 0x20, 16);
119 memcpy(&buf
[16], dev
->t10_wwn
.model
,
120 min_t(size_t, strlen(dev
->t10_wwn
.model
), 16));
121 memcpy(&buf
[32], dev
->t10_wwn
.revision
,
122 min_t(size_t, strlen(dev
->t10_wwn
.revision
), 4));
123 buf
[4] = 31; /* Set additional length to 31 */
127 EXPORT_SYMBOL(spc_emulate_inquiry_std
);
129 /* unit serial number */
130 static sense_reason_t
131 spc_emulate_evpd_80(struct se_cmd
*cmd
, unsigned char *buf
)
133 struct se_device
*dev
= cmd
->se_dev
;
136 if (dev
->dev_flags
& DF_EMULATED_VPD_UNIT_SERIAL
) {
137 len
= sprintf(&buf
[4], "%s", dev
->t10_wwn
.unit_serial
);
138 len
++; /* Extra Byte for NULL Terminator */
144 void spc_parse_naa_6h_vendor_specific(struct se_device
*dev
,
147 unsigned char *p
= &dev
->t10_wwn
.unit_serial
[0];
152 * Generate up to 36 bits of VENDOR SPECIFIC IDENTIFIER starting on
153 * byte 3 bit 3-0 for NAA IEEE Registered Extended DESIGNATOR field
154 * format, followed by 64 bits of VENDOR SPECIFIC IDENTIFIER EXTENSION
155 * to complete the payload. These are based from VPD=0x80 PRODUCT SERIAL
156 * NUMBER set via vpd_unit_serial in target_core_configfs.c to ensure
157 * per device uniqeness.
159 for (cnt
= 0; *p
&& cnt
< 13; p
++) {
160 int val
= hex_to_bin(*p
);
176 * Device identification VPD, for a complete list of
177 * DESIGNATOR TYPEs see spc4r17 Table 459.
180 spc_emulate_evpd_83(struct se_cmd
*cmd
, unsigned char *buf
)
182 struct se_device
*dev
= cmd
->se_dev
;
183 struct se_lun
*lun
= cmd
->se_lun
;
184 struct se_port
*port
= NULL
;
185 struct se_portal_group
*tpg
= NULL
;
186 struct t10_alua_lu_gp_member
*lu_gp_mem
;
187 struct t10_alua_tg_pt_gp
*tg_pt_gp
;
188 struct t10_alua_tg_pt_gp_member
*tg_pt_gp_mem
;
189 unsigned char *prod
= &dev
->t10_wwn
.model
[0];
191 u32 unit_serial_len
, off
= 0;
197 * NAA IEEE Registered Extended Assigned designator format, see
198 * spc4r17 section 7.7.3.6.5
200 * We depend upon a target_core_mod/ConfigFS provided
201 * /sys/kernel/config/target/core/$HBA/$DEV/wwn/vpd_unit_serial
202 * value in order to return the NAA id.
204 if (!(dev
->dev_flags
& DF_EMULATED_VPD_UNIT_SERIAL
))
205 goto check_t10_vend_desc
;
207 /* CODE SET == Binary */
210 /* Set ASSOCIATION == addressed logical unit: 0)b */
213 /* Identifier/Designator type == NAA identifier */
217 /* Identifier/Designator length */
221 * Start NAA IEEE Registered Extended Identifier/Designator
223 buf
[off
++] = (0x6 << 4);
226 * Use OpenFabrics IEEE Company ID: 00 14 05
230 buf
[off
] = (0x5 << 4);
233 * Return ConfigFS Unit Serial Number information for
234 * VENDOR_SPECIFIC_IDENTIFIER and
235 * VENDOR_SPECIFIC_IDENTIFIER_EXTENTION
237 spc_parse_naa_6h_vendor_specific(dev
, &buf
[off
]);
244 * T10 Vendor Identifier Page, see spc4r17 section 7.7.3.4
246 id_len
= 8; /* For Vendor field */
247 prod_len
= 4; /* For VPD Header */
248 prod_len
+= 8; /* For Vendor field */
249 prod_len
+= strlen(prod
);
250 prod_len
++; /* For : */
252 if (dev
->dev_flags
& DF_EMULATED_VPD_UNIT_SERIAL
) {
253 unit_serial_len
= strlen(&dev
->t10_wwn
.unit_serial
[0]);
254 unit_serial_len
++; /* For NULL Terminator */
256 id_len
+= sprintf(&buf
[off
+12], "%s:%s", prod
,
257 &dev
->t10_wwn
.unit_serial
[0]);
259 buf
[off
] = 0x2; /* ASCII */
260 buf
[off
+1] = 0x1; /* T10 Vendor ID */
262 memcpy(&buf
[off
+4], "LIO-ORG", 8);
263 /* Extra Byte for NULL Terminator */
265 /* Identifier Length */
267 /* Header size for Designation descriptor */
271 * struct se_port is only set for INQUIRY VPD=1 through $FABRIC_MOD
275 struct t10_alua_lu_gp
*lu_gp
;
276 u32 padding
, scsi_name_len
, scsi_target_len
;
283 * Relative target port identifer, see spc4r17
286 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
287 * section 7.5.1 Table 362
290 (tpg
->se_tpg_tfo
->get_fabric_proto_ident(tpg
) << 4);
291 buf
[off
++] |= 0x1; /* CODE SET == Binary */
292 buf
[off
] = 0x80; /* Set PIV=1 */
293 /* Set ASSOCIATION == target port: 01b */
295 /* DESIGNATOR TYPE == Relative target port identifer */
297 off
++; /* Skip over Reserved */
298 buf
[off
++] = 4; /* DESIGNATOR LENGTH */
299 /* Skip over Obsolete field in RTPI payload
302 buf
[off
++] = ((port
->sep_rtpi
>> 8) & 0xff);
303 buf
[off
++] = (port
->sep_rtpi
& 0xff);
304 len
+= 8; /* Header size + Designation descriptor */
306 * Target port group identifier, see spc4r17
309 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
310 * section 7.5.1 Table 362
312 tg_pt_gp_mem
= port
->sep_alua_tg_pt_gp_mem
;
316 spin_lock(&tg_pt_gp_mem
->tg_pt_gp_mem_lock
);
317 tg_pt_gp
= tg_pt_gp_mem
->tg_pt_gp
;
319 spin_unlock(&tg_pt_gp_mem
->tg_pt_gp_mem_lock
);
322 tg_pt_gp_id
= tg_pt_gp
->tg_pt_gp_id
;
323 spin_unlock(&tg_pt_gp_mem
->tg_pt_gp_mem_lock
);
326 (tpg
->se_tpg_tfo
->get_fabric_proto_ident(tpg
) << 4);
327 buf
[off
++] |= 0x1; /* CODE SET == Binary */
328 buf
[off
] = 0x80; /* Set PIV=1 */
329 /* Set ASSOCIATION == target port: 01b */
331 /* DESIGNATOR TYPE == Target port group identifier */
333 off
++; /* Skip over Reserved */
334 buf
[off
++] = 4; /* DESIGNATOR LENGTH */
335 off
+= 2; /* Skip over Reserved Field */
336 buf
[off
++] = ((tg_pt_gp_id
>> 8) & 0xff);
337 buf
[off
++] = (tg_pt_gp_id
& 0xff);
338 len
+= 8; /* Header size + Designation descriptor */
340 * Logical Unit Group identifier, see spc4r17
344 lu_gp_mem
= dev
->dev_alua_lu_gp_mem
;
346 goto check_scsi_name
;
348 spin_lock(&lu_gp_mem
->lu_gp_mem_lock
);
349 lu_gp
= lu_gp_mem
->lu_gp
;
351 spin_unlock(&lu_gp_mem
->lu_gp_mem_lock
);
352 goto check_scsi_name
;
354 lu_gp_id
= lu_gp
->lu_gp_id
;
355 spin_unlock(&lu_gp_mem
->lu_gp_mem_lock
);
357 buf
[off
++] |= 0x1; /* CODE SET == Binary */
358 /* DESIGNATOR TYPE == Logical Unit Group identifier */
360 off
++; /* Skip over Reserved */
361 buf
[off
++] = 4; /* DESIGNATOR LENGTH */
362 off
+= 2; /* Skip over Reserved Field */
363 buf
[off
++] = ((lu_gp_id
>> 8) & 0xff);
364 buf
[off
++] = (lu_gp_id
& 0xff);
365 len
+= 8; /* Header size + Designation descriptor */
367 * SCSI name string designator, see spc4r17
370 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
371 * section 7.5.1 Table 362
375 (tpg
->se_tpg_tfo
->get_fabric_proto_ident(tpg
) << 4);
376 buf
[off
++] |= 0x3; /* CODE SET == UTF-8 */
377 buf
[off
] = 0x80; /* Set PIV=1 */
378 /* Set ASSOCIATION == target port: 01b */
380 /* DESIGNATOR TYPE == SCSI name string */
382 off
+= 2; /* Skip over Reserved and length */
384 * SCSI name string identifer containing, $FABRIC_MOD
385 * dependent information. For LIO-Target and iSCSI
386 * Target Port, this means "<iSCSI name>,t,0x<TPGT> in
389 tpgt
= tpg
->se_tpg_tfo
->tpg_get_tag(tpg
);
390 scsi_name_len
= sprintf(&buf
[off
], "%s,t,0x%04x",
391 tpg
->se_tpg_tfo
->tpg_get_wwn(tpg
), tpgt
);
392 scsi_name_len
+= 1 /* Include NULL terminator */;
394 * The null-terminated, null-padded (see 4.4.2) SCSI
395 * NAME STRING field contains a UTF-8 format string.
396 * The number of bytes in the SCSI NAME STRING field
397 * (i.e., the value in the DESIGNATOR LENGTH field)
398 * shall be no larger than 256 and shall be a multiple
401 padding
= ((-scsi_name_len
) & 3);
403 scsi_name_len
+= padding
;
404 if (scsi_name_len
> 256)
407 buf
[off
-1] = scsi_name_len
;
408 off
+= scsi_name_len
;
409 /* Header size + Designation descriptor */
410 len
+= (scsi_name_len
+ 4);
413 * Target device designator
416 (tpg
->se_tpg_tfo
->get_fabric_proto_ident(tpg
) << 4);
417 buf
[off
++] |= 0x3; /* CODE SET == UTF-8 */
418 buf
[off
] = 0x80; /* Set PIV=1 */
419 /* Set ASSOCIATION == target device: 10b */
421 /* DESIGNATOR TYPE == SCSI name string */
423 off
+= 2; /* Skip over Reserved and length */
425 * SCSI name string identifer containing, $FABRIC_MOD
426 * dependent information. For LIO-Target and iSCSI
427 * Target Port, this means "<iSCSI name>" in
430 scsi_target_len
= sprintf(&buf
[off
], "%s",
431 tpg
->se_tpg_tfo
->tpg_get_wwn(tpg
));
432 scsi_target_len
+= 1 /* Include NULL terminator */;
434 * The null-terminated, null-padded (see 4.4.2) SCSI
435 * NAME STRING field contains a UTF-8 format string.
436 * The number of bytes in the SCSI NAME STRING field
437 * (i.e., the value in the DESIGNATOR LENGTH field)
438 * shall be no larger than 256 and shall be a multiple
441 padding
= ((-scsi_target_len
) & 3);
443 scsi_target_len
+= padding
;
444 if (scsi_target_len
> 256)
445 scsi_target_len
= 256;
447 buf
[off
-1] = scsi_target_len
;
448 off
+= scsi_target_len
;
450 /* Header size + Designation descriptor */
451 len
+= (scsi_target_len
+ 4);
453 buf
[2] = ((len
>> 8) & 0xff);
454 buf
[3] = (len
& 0xff); /* Page Length for VPD 0x83 */
457 EXPORT_SYMBOL(spc_emulate_evpd_83
);
459 /* Extended INQUIRY Data VPD Page */
460 static sense_reason_t
461 spc_emulate_evpd_86(struct se_cmd
*cmd
, unsigned char *buf
)
463 struct se_device
*dev
= cmd
->se_dev
;
464 struct se_session
*sess
= cmd
->se_sess
;
468 * Set GRD_CHK + REF_CHK for TYPE1 protection, or GRD_CHK
469 * only for TYPE3 protection.
471 if (sess
->sup_prot_ops
& (TARGET_PROT_DIN_PASS
| TARGET_PROT_DOUT_PASS
)) {
472 if (dev
->dev_attrib
.pi_prot_type
== TARGET_DIF_TYPE1_PROT
||
473 cmd
->se_sess
->sess_prot_type
== TARGET_DIF_TYPE1_PROT
)
475 else if (dev
->dev_attrib
.pi_prot_type
== TARGET_DIF_TYPE3_PROT
||
476 cmd
->se_sess
->sess_prot_type
== TARGET_DIF_TYPE3_PROT
)
480 /* Set HEADSUP, ORDSUP, SIMPSUP */
483 /* If WriteCache emulation is enabled, set V_SUP */
484 if (se_dev_check_wce(dev
))
486 /* If an LBA map is present set R_SUP */
487 spin_lock(&cmd
->se_dev
->t10_alua
.lba_map_lock
);
488 if (!list_empty(&dev
->t10_alua
.lba_map_list
))
490 spin_unlock(&cmd
->se_dev
->t10_alua
.lba_map_lock
);
494 /* Block Limits VPD page */
495 static sense_reason_t
496 spc_emulate_evpd_b0(struct se_cmd
*cmd
, unsigned char *buf
)
498 struct se_device
*dev
= cmd
->se_dev
;
503 * Following spc3r22 section 6.5.3 Block Limits VPD page, when
504 * emulate_tpu=1 or emulate_tpws=1 we will be expect a
505 * different page length for Thin Provisioning.
507 if (dev
->dev_attrib
.emulate_tpu
|| dev
->dev_attrib
.emulate_tpws
)
510 buf
[0] = dev
->transport
->get_device_type(dev
);
511 buf
[3] = have_tp
? 0x3c : 0x10;
516 * Set MAXIMUM COMPARE AND WRITE LENGTH
518 if (dev
->dev_attrib
.emulate_caw
)
522 * Set OPTIMAL TRANSFER LENGTH GRANULARITY
524 if (dev
->transport
->get_io_min
&& (min
= dev
->transport
->get_io_min(dev
)))
525 put_unaligned_be16(min
/ dev
->dev_attrib
.block_size
, &buf
[6]);
527 put_unaligned_be16(1, &buf
[6]);
530 * Set MAXIMUM TRANSFER LENGTH
532 put_unaligned_be32(dev
->dev_attrib
.hw_max_sectors
, &buf
[8]);
535 * Set OPTIMAL TRANSFER LENGTH
537 if (dev
->transport
->get_io_opt
&& (opt
= dev
->transport
->get_io_opt(dev
)))
538 put_unaligned_be32(opt
/ dev
->dev_attrib
.block_size
, &buf
[12]);
540 put_unaligned_be32(dev
->dev_attrib
.optimal_sectors
, &buf
[12]);
543 * Exit now if we don't support TP.
549 * Set MAXIMUM UNMAP LBA COUNT
551 put_unaligned_be32(dev
->dev_attrib
.max_unmap_lba_count
, &buf
[20]);
554 * Set MAXIMUM UNMAP BLOCK DESCRIPTOR COUNT
556 put_unaligned_be32(dev
->dev_attrib
.max_unmap_block_desc_count
,
560 * Set OPTIMAL UNMAP GRANULARITY
562 put_unaligned_be32(dev
->dev_attrib
.unmap_granularity
, &buf
[28]);
565 * UNMAP GRANULARITY ALIGNMENT
567 put_unaligned_be32(dev
->dev_attrib
.unmap_granularity_alignment
,
569 if (dev
->dev_attrib
.unmap_granularity_alignment
!= 0)
570 buf
[32] |= 0x80; /* Set the UGAVALID bit */
573 * MAXIMUM WRITE SAME LENGTH
576 put_unaligned_be64(dev
->dev_attrib
.max_write_same_len
, &buf
[36]);
581 /* Block Device Characteristics VPD page */
582 static sense_reason_t
583 spc_emulate_evpd_b1(struct se_cmd
*cmd
, unsigned char *buf
)
585 struct se_device
*dev
= cmd
->se_dev
;
587 buf
[0] = dev
->transport
->get_device_type(dev
);
589 buf
[5] = dev
->dev_attrib
.is_nonrot
? 1 : 0;
594 /* Thin Provisioning VPD */
595 static sense_reason_t
596 spc_emulate_evpd_b2(struct se_cmd
*cmd
, unsigned char *buf
)
598 struct se_device
*dev
= cmd
->se_dev
;
601 * From spc3r22 section 6.5.4 Thin Provisioning VPD page:
603 * The PAGE LENGTH field is defined in SPC-4. If the DP bit is set to
604 * zero, then the page length shall be set to 0004h. If the DP bit
605 * is set to one, then the page length shall be set to the value
606 * defined in table 162.
608 buf
[0] = dev
->transport
->get_device_type(dev
);
611 * Set Hardcoded length mentioned above for DP=0
613 put_unaligned_be16(0x0004, &buf
[2]);
616 * The THRESHOLD EXPONENT field indicates the threshold set size in
617 * LBAs as a power of 2 (i.e., the threshold set size is equal to
618 * 2(threshold exponent)).
620 * Note that this is currently set to 0x00 as mkp says it will be
621 * changing again. We can enable this once it has settled in T10
622 * and is actually used by Linux/SCSI ML code.
627 * A TPU bit set to one indicates that the device server supports
628 * the UNMAP command (see 5.25). A TPU bit set to zero indicates
629 * that the device server does not support the UNMAP command.
631 if (dev
->dev_attrib
.emulate_tpu
!= 0)
635 * A TPWS bit set to one indicates that the device server supports
636 * the use of the WRITE SAME (16) command (see 5.42) to unmap LBAs.
637 * A TPWS bit set to zero indicates that the device server does not
638 * support the use of the WRITE SAME (16) command to unmap LBAs.
640 if (dev
->dev_attrib
.emulate_tpws
!= 0)
641 buf
[5] |= 0x40 | 0x20;
646 /* Referrals VPD page */
647 static sense_reason_t
648 spc_emulate_evpd_b3(struct se_cmd
*cmd
, unsigned char *buf
)
650 struct se_device
*dev
= cmd
->se_dev
;
652 buf
[0] = dev
->transport
->get_device_type(dev
);
654 put_unaligned_be32(dev
->t10_alua
.lba_map_segment_size
, &buf
[8]);
655 put_unaligned_be32(dev
->t10_alua
.lba_map_segment_multiplier
, &buf
[12]);
660 static sense_reason_t
661 spc_emulate_evpd_00(struct se_cmd
*cmd
, unsigned char *buf
);
665 sense_reason_t (*emulate
)(struct se_cmd
*, unsigned char *);
666 } evpd_handlers
[] = {
667 { .page
= 0x00, .emulate
= spc_emulate_evpd_00
},
668 { .page
= 0x80, .emulate
= spc_emulate_evpd_80
},
669 { .page
= 0x83, .emulate
= spc_emulate_evpd_83
},
670 { .page
= 0x86, .emulate
= spc_emulate_evpd_86
},
671 { .page
= 0xb0, .emulate
= spc_emulate_evpd_b0
},
672 { .page
= 0xb1, .emulate
= spc_emulate_evpd_b1
},
673 { .page
= 0xb2, .emulate
= spc_emulate_evpd_b2
},
674 { .page
= 0xb3, .emulate
= spc_emulate_evpd_b3
},
677 /* supported vital product data pages */
678 static sense_reason_t
679 spc_emulate_evpd_00(struct se_cmd
*cmd
, unsigned char *buf
)
684 * Only report the INQUIRY EVPD=1 pages after a valid NAA
685 * Registered Extended LUN WWN has been set via ConfigFS
686 * during device creation/restart.
688 if (cmd
->se_dev
->dev_flags
& DF_EMULATED_VPD_UNIT_SERIAL
) {
689 buf
[3] = ARRAY_SIZE(evpd_handlers
);
690 for (p
= 0; p
< ARRAY_SIZE(evpd_handlers
); ++p
)
691 buf
[p
+ 4] = evpd_handlers
[p
].page
;
697 static sense_reason_t
698 spc_emulate_inquiry(struct se_cmd
*cmd
)
700 struct se_device
*dev
= cmd
->se_dev
;
701 struct se_portal_group
*tpg
= cmd
->se_lun
->lun_sep
->sep_tpg
;
703 unsigned char *cdb
= cmd
->t_task_cdb
;
709 buf
= kzalloc(SE_INQUIRY_BUF
, GFP_KERNEL
);
711 pr_err("Unable to allocate response buffer for INQUIRY\n");
712 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
715 if (dev
== tpg
->tpg_virt_lun0
.lun_se_dev
)
716 buf
[0] = 0x3f; /* Not connected */
718 buf
[0] = dev
->transport
->get_device_type(dev
);
720 if (!(cdb
[1] & 0x1)) {
722 pr_err("INQUIRY with EVPD==0 but PAGE CODE=%02x\n",
724 ret
= TCM_INVALID_CDB_FIELD
;
728 ret
= spc_emulate_inquiry_std(cmd
, buf
);
733 for (p
= 0; p
< ARRAY_SIZE(evpd_handlers
); ++p
) {
734 if (cdb
[2] == evpd_handlers
[p
].page
) {
736 ret
= evpd_handlers
[p
].emulate(cmd
, buf
);
737 len
= get_unaligned_be16(&buf
[2]) + 4;
742 pr_err("Unknown VPD Code: 0x%02x\n", cdb
[2]);
743 ret
= TCM_INVALID_CDB_FIELD
;
746 rbuf
= transport_kmap_data_sg(cmd
);
748 memcpy(rbuf
, buf
, min_t(u32
, SE_INQUIRY_BUF
, cmd
->data_length
));
749 transport_kunmap_data_sg(cmd
);
754 target_complete_cmd_with_length(cmd
, GOOD
, len
);
758 static int spc_modesense_rwrecovery(struct se_cmd
*cmd
, u8 pc
, u8
*p
)
763 /* No changeable values for now */
771 static int spc_modesense_control(struct se_cmd
*cmd
, u8 pc
, u8
*p
)
773 struct se_device
*dev
= cmd
->se_dev
;
774 struct se_session
*sess
= cmd
->se_sess
;
779 /* No changeable values for now */
785 * From spc4r23, 7.4.7 Control mode page
787 * The QUEUE ALGORITHM MODIFIER field (see table 368) specifies
788 * restrictions on the algorithm used for reordering commands
789 * having the SIMPLE task attribute (see SAM-4).
791 * Table 368 -- QUEUE ALGORITHM MODIFIER field
793 * 0h Restricted reordering
794 * 1h Unrestricted reordering allowed
796 * 8h to Fh Vendor specific
798 * A value of zero in the QUEUE ALGORITHM MODIFIER field specifies that
799 * the device server shall order the processing sequence of commands
800 * having the SIMPLE task attribute such that data integrity is maintained
801 * for that I_T nexus (i.e., if the transmission of new SCSI transport protocol
802 * requests is halted at any time, the final value of all data observable
803 * on the medium shall be the same as if all the commands had been processed
804 * with the ORDERED task attribute).
806 * A value of one in the QUEUE ALGORITHM MODIFIER field specifies that the
807 * device server may reorder the processing sequence of commands having the
808 * SIMPLE task attribute in any manner. Any data integrity exposures related to
809 * command sequence order shall be explicitly handled by the application client
810 * through the selection of appropriate ommands and task attributes.
812 p
[3] = (dev
->dev_attrib
.emulate_rest_reord
== 1) ? 0x00 : 0x10;
814 * From spc4r17, section 7.4.6 Control mode Page
816 * Unit Attention interlocks control (UN_INTLCK_CTRL) to code 00b
818 * 00b: The logical unit shall clear any unit attention condition
819 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
820 * status and shall not establish a unit attention condition when a com-
821 * mand is completed with BUSY, TASK SET FULL, or RESERVATION CONFLICT
824 * 10b: The logical unit shall not clear any unit attention condition
825 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
826 * status and shall not establish a unit attention condition when
827 * a command is completed with BUSY, TASK SET FULL, or RESERVATION
830 * 11b a The logical unit shall not clear any unit attention condition
831 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
832 * status and shall establish a unit attention condition for the
833 * initiator port associated with the I_T nexus on which the BUSY,
834 * TASK SET FULL, or RESERVATION CONFLICT status is being returned.
835 * Depending on the status, the additional sense code shall be set to
836 * PREVIOUS BUSY STATUS, PREVIOUS TASK SET FULL STATUS, or PREVIOUS
837 * RESERVATION CONFLICT STATUS. Until it is cleared by a REQUEST SENSE
838 * command, a unit attention condition shall be established only once
839 * for a BUSY, TASK SET FULL, or RESERVATION CONFLICT status regardless
840 * to the number of commands completed with one of those status codes.
842 p
[4] = (dev
->dev_attrib
.emulate_ua_intlck_ctrl
== 2) ? 0x30 :
843 (dev
->dev_attrib
.emulate_ua_intlck_ctrl
== 1) ? 0x20 : 0x00;
845 * From spc4r17, section 7.4.6 Control mode Page
847 * Task Aborted Status (TAS) bit set to zero.
849 * A task aborted status (TAS) bit set to zero specifies that aborted
850 * tasks shall be terminated by the device server without any response
851 * to the application client. A TAS bit set to one specifies that tasks
852 * aborted by the actions of an I_T nexus other than the I_T nexus on
853 * which the command was received shall be completed with TASK ABORTED
854 * status (see SAM-4).
856 p
[5] = (dev
->dev_attrib
.emulate_tas
) ? 0x40 : 0x00;
858 * From spc4r30, section 7.5.7 Control mode page
860 * Application Tag Owner (ATO) bit set to one.
862 * If the ATO bit is set to one the device server shall not modify the
863 * LOGICAL BLOCK APPLICATION TAG field and, depending on the protection
864 * type, shall not modify the contents of the LOGICAL BLOCK REFERENCE
867 if (sess
->sup_prot_ops
& (TARGET_PROT_DIN_PASS
| TARGET_PROT_DOUT_PASS
)) {
868 if (dev
->dev_attrib
.pi_prot_type
|| sess
->sess_prot_type
)
880 static int spc_modesense_caching(struct se_cmd
*cmd
, u8 pc
, u8
*p
)
882 struct se_device
*dev
= cmd
->se_dev
;
887 /* No changeable values for now */
891 if (se_dev_check_wce(dev
))
892 p
[2] = 0x04; /* Write Cache Enable */
893 p
[12] = 0x20; /* Disabled Read Ahead */
899 static int spc_modesense_informational_exceptions(struct se_cmd
*cmd
, u8 pc
, unsigned char *p
)
904 /* No changeable values for now */
915 int (*emulate
)(struct se_cmd
*, u8
, unsigned char *);
916 } modesense_handlers
[] = {
917 { .page
= 0x01, .subpage
= 0x00, .emulate
= spc_modesense_rwrecovery
},
918 { .page
= 0x08, .subpage
= 0x00, .emulate
= spc_modesense_caching
},
919 { .page
= 0x0a, .subpage
= 0x00, .emulate
= spc_modesense_control
},
920 { .page
= 0x1c, .subpage
= 0x00, .emulate
= spc_modesense_informational_exceptions
},
923 static void spc_modesense_write_protect(unsigned char *buf
, int type
)
926 * I believe that the WP bit (bit 7) in the mode header is the same for
933 buf
[0] |= 0x80; /* WP bit */
938 static void spc_modesense_dpofua(unsigned char *buf
, int type
)
942 buf
[0] |= 0x10; /* DPOFUA bit */
949 static int spc_modesense_blockdesc(unsigned char *buf
, u64 blocks
, u32 block_size
)
952 put_unaligned_be32(min(blocks
, 0xffffffffull
), buf
);
954 put_unaligned_be32(block_size
, buf
);
958 static int spc_modesense_long_blockdesc(unsigned char *buf
, u64 blocks
, u32 block_size
)
960 if (blocks
<= 0xffffffff)
961 return spc_modesense_blockdesc(buf
+ 3, blocks
, block_size
) + 3;
963 *buf
++ = 1; /* LONGLBA */
966 put_unaligned_be64(blocks
, buf
);
968 put_unaligned_be32(block_size
, buf
);
973 static sense_reason_t
spc_emulate_modesense(struct se_cmd
*cmd
)
975 struct se_device
*dev
= cmd
->se_dev
;
976 char *cdb
= cmd
->t_task_cdb
;
977 unsigned char buf
[SE_MODE_PAGE_BUF
], *rbuf
;
978 int type
= dev
->transport
->get_device_type(dev
);
979 int ten
= (cmd
->t_task_cdb
[0] == MODE_SENSE_10
);
980 bool dbd
= !!(cdb
[1] & 0x08);
981 bool llba
= ten
? !!(cdb
[1] & 0x10) : false;
983 u8 page
= cdb
[2] & 0x3f;
989 memset(buf
, 0, SE_MODE_PAGE_BUF
);
992 * Skip over MODE DATA LENGTH + MEDIUM TYPE fields to byte 3 for
993 * MODE_SENSE_10 and byte 2 for MODE_SENSE (6).
995 length
= ten
? 3 : 2;
997 /* DEVICE-SPECIFIC PARAMETER */
998 if ((cmd
->se_lun
->lun_access
& TRANSPORT_LUNFLAGS_READ_ONLY
) ||
1000 (cmd
->se_deve
->lun_flags
& TRANSPORT_LUNFLAGS_READ_ONLY
)))
1001 spc_modesense_write_protect(&buf
[length
], type
);
1003 if ((se_dev_check_wce(dev
)) &&
1004 (dev
->dev_attrib
.emulate_fua_write
> 0))
1005 spc_modesense_dpofua(&buf
[length
], type
);
1009 /* BLOCK DESCRIPTOR */
1012 * For now we only include a block descriptor for disk (SBC)
1013 * devices; other command sets use a slightly different format.
1015 if (!dbd
&& type
== TYPE_DISK
) {
1016 u64 blocks
= dev
->transport
->get_blocks(dev
);
1017 u32 block_size
= dev
->dev_attrib
.block_size
;
1021 length
+= spc_modesense_long_blockdesc(&buf
[length
],
1022 blocks
, block_size
);
1025 length
+= spc_modesense_blockdesc(&buf
[length
],
1026 blocks
, block_size
);
1029 length
+= spc_modesense_blockdesc(&buf
[length
], blocks
,
1040 if (subpage
!= 0x00 && subpage
!= 0xff) {
1041 pr_warn("MODE_SENSE: Invalid subpage code: 0x%02x\n", subpage
);
1042 return TCM_INVALID_CDB_FIELD
;
1045 for (i
= 0; i
< ARRAY_SIZE(modesense_handlers
); ++i
) {
1047 * Tricky way to say all subpage 00h for
1048 * subpage==0, all subpages for subpage==0xff
1049 * (and we just checked above that those are
1050 * the only two possibilities).
1052 if ((modesense_handlers
[i
].subpage
& ~subpage
) == 0) {
1053 ret
= modesense_handlers
[i
].emulate(cmd
, pc
, &buf
[length
]);
1054 if (!ten
&& length
+ ret
>= 255)
1063 for (i
= 0; i
< ARRAY_SIZE(modesense_handlers
); ++i
)
1064 if (modesense_handlers
[i
].page
== page
&&
1065 modesense_handlers
[i
].subpage
== subpage
) {
1066 length
+= modesense_handlers
[i
].emulate(cmd
, pc
, &buf
[length
]);
1071 * We don't intend to implement:
1072 * - obsolete page 03h "format parameters" (checked by Solaris)
1075 pr_err("MODE SENSE: unimplemented page/subpage: 0x%02x/0x%02x\n",
1078 return TCM_UNKNOWN_MODE_PAGE
;
1082 put_unaligned_be16(length
- 2, buf
);
1084 buf
[0] = length
- 1;
1086 rbuf
= transport_kmap_data_sg(cmd
);
1088 memcpy(rbuf
, buf
, min_t(u32
, SE_MODE_PAGE_BUF
, cmd
->data_length
));
1089 transport_kunmap_data_sg(cmd
);
1092 target_complete_cmd_with_length(cmd
, GOOD
, length
);
1096 static sense_reason_t
spc_emulate_modeselect(struct se_cmd
*cmd
)
1098 char *cdb
= cmd
->t_task_cdb
;
1099 bool ten
= cdb
[0] == MODE_SELECT_10
;
1100 int off
= ten
? 8 : 4;
1101 bool pf
= !!(cdb
[1] & 0x10);
1104 unsigned char tbuf
[SE_MODE_PAGE_BUF
];
1106 sense_reason_t ret
= 0;
1109 if (!cmd
->data_length
) {
1110 target_complete_cmd(cmd
, GOOD
);
1114 if (cmd
->data_length
< off
+ 2)
1115 return TCM_PARAMETER_LIST_LENGTH_ERROR
;
1117 buf
= transport_kmap_data_sg(cmd
);
1119 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1122 ret
= TCM_INVALID_CDB_FIELD
;
1126 page
= buf
[off
] & 0x3f;
1127 subpage
= buf
[off
] & 0x40 ? buf
[off
+ 1] : 0;
1129 for (i
= 0; i
< ARRAY_SIZE(modesense_handlers
); ++i
)
1130 if (modesense_handlers
[i
].page
== page
&&
1131 modesense_handlers
[i
].subpage
== subpage
) {
1132 memset(tbuf
, 0, SE_MODE_PAGE_BUF
);
1133 length
= modesense_handlers
[i
].emulate(cmd
, 0, tbuf
);
1134 goto check_contents
;
1137 ret
= TCM_UNKNOWN_MODE_PAGE
;
1141 if (cmd
->data_length
< off
+ length
) {
1142 ret
= TCM_PARAMETER_LIST_LENGTH_ERROR
;
1146 if (memcmp(buf
+ off
, tbuf
, length
))
1147 ret
= TCM_INVALID_PARAMETER_LIST
;
1150 transport_kunmap_data_sg(cmd
);
1153 target_complete_cmd(cmd
, GOOD
);
1157 static sense_reason_t
spc_emulate_request_sense(struct se_cmd
*cmd
)
1159 unsigned char *cdb
= cmd
->t_task_cdb
;
1160 unsigned char *rbuf
;
1161 u8 ua_asc
= 0, ua_ascq
= 0;
1162 unsigned char buf
[SE_SENSE_BUF
];
1164 memset(buf
, 0, SE_SENSE_BUF
);
1166 if (cdb
[1] & 0x01) {
1167 pr_err("REQUEST_SENSE description emulation not"
1169 return TCM_INVALID_CDB_FIELD
;
1172 rbuf
= transport_kmap_data_sg(cmd
);
1174 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1176 if (!core_scsi3_ua_clear_for_request_sense(cmd
, &ua_asc
, &ua_ascq
)) {
1178 * CURRENT ERROR, UNIT ATTENTION
1181 buf
[SPC_SENSE_KEY_OFFSET
] = UNIT_ATTENTION
;
1184 * The Additional Sense Code (ASC) from the UNIT ATTENTION
1186 buf
[SPC_ASC_KEY_OFFSET
] = ua_asc
;
1187 buf
[SPC_ASCQ_KEY_OFFSET
] = ua_ascq
;
1191 * CURRENT ERROR, NO SENSE
1194 buf
[SPC_SENSE_KEY_OFFSET
] = NO_SENSE
;
1197 * NO ADDITIONAL SENSE INFORMATION
1199 buf
[SPC_ASC_KEY_OFFSET
] = 0x00;
1203 memcpy(rbuf
, buf
, min_t(u32
, sizeof(buf
), cmd
->data_length
));
1204 transport_kunmap_data_sg(cmd
);
1206 target_complete_cmd(cmd
, GOOD
);
1210 sense_reason_t
spc_emulate_report_luns(struct se_cmd
*cmd
)
1212 struct se_dev_entry
*deve
;
1213 struct se_session
*sess
= cmd
->se_sess
;
1215 u32 lun_count
= 0, offset
= 8, i
;
1217 if (cmd
->data_length
< 16) {
1218 pr_warn("REPORT LUNS allocation length %u too small\n",
1220 return TCM_INVALID_CDB_FIELD
;
1223 buf
= transport_kmap_data_sg(cmd
);
1225 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1228 * If no struct se_session pointer is present, this struct se_cmd is
1229 * coming via a target_core_mod PASSTHROUGH op, and not through
1230 * a $FABRIC_MOD. In that case, report LUN=0 only.
1233 int_to_scsilun(0, (struct scsi_lun
*)&buf
[offset
]);
1238 spin_lock_irq(&sess
->se_node_acl
->device_list_lock
);
1239 for (i
= 0; i
< TRANSPORT_MAX_LUNS_PER_TPG
; i
++) {
1240 deve
= sess
->se_node_acl
->device_list
[i
];
1241 if (!(deve
->lun_flags
& TRANSPORT_LUNFLAGS_INITIATOR_ACCESS
))
1244 * We determine the correct LUN LIST LENGTH even once we
1245 * have reached the initial allocation length.
1246 * See SPC2-R20 7.19.
1249 if ((offset
+ 8) > cmd
->data_length
)
1252 int_to_scsilun(deve
->mapped_lun
, (struct scsi_lun
*)&buf
[offset
]);
1255 spin_unlock_irq(&sess
->se_node_acl
->device_list_lock
);
1258 * See SPC3 r07, page 159.
1262 buf
[0] = ((lun_count
>> 24) & 0xff);
1263 buf
[1] = ((lun_count
>> 16) & 0xff);
1264 buf
[2] = ((lun_count
>> 8) & 0xff);
1265 buf
[3] = (lun_count
& 0xff);
1266 transport_kunmap_data_sg(cmd
);
1268 target_complete_cmd_with_length(cmd
, GOOD
, 8 + lun_count
* 8);
1271 EXPORT_SYMBOL(spc_emulate_report_luns
);
1273 static sense_reason_t
1274 spc_emulate_testunitready(struct se_cmd
*cmd
)
1276 target_complete_cmd(cmd
, GOOD
);
1281 spc_parse_cdb(struct se_cmd
*cmd
, unsigned int *size
)
1283 struct se_device
*dev
= cmd
->se_dev
;
1284 unsigned char *cdb
= cmd
->t_task_cdb
;
1289 cmd
->execute_cmd
= spc_emulate_modeselect
;
1291 case MODE_SELECT_10
:
1292 *size
= (cdb
[7] << 8) + cdb
[8];
1293 cmd
->execute_cmd
= spc_emulate_modeselect
;
1297 cmd
->execute_cmd
= spc_emulate_modesense
;
1300 *size
= (cdb
[7] << 8) + cdb
[8];
1301 cmd
->execute_cmd
= spc_emulate_modesense
;
1305 *size
= (cdb
[7] << 8) + cdb
[8];
1307 case PERSISTENT_RESERVE_IN
:
1308 *size
= (cdb
[7] << 8) + cdb
[8];
1309 cmd
->execute_cmd
= target_scsi3_emulate_pr_in
;
1311 case PERSISTENT_RESERVE_OUT
:
1312 *size
= (cdb
[7] << 8) + cdb
[8];
1313 cmd
->execute_cmd
= target_scsi3_emulate_pr_out
;
1317 if (cdb
[0] == RELEASE_10
)
1318 *size
= (cdb
[7] << 8) | cdb
[8];
1320 *size
= cmd
->data_length
;
1322 cmd
->execute_cmd
= target_scsi2_reservation_release
;
1327 * The SPC-2 RESERVE does not contain a size in the SCSI CDB.
1328 * Assume the passthrough or $FABRIC_MOD will tell us about it.
1330 if (cdb
[0] == RESERVE_10
)
1331 *size
= (cdb
[7] << 8) | cdb
[8];
1333 *size
= cmd
->data_length
;
1335 cmd
->execute_cmd
= target_scsi2_reservation_reserve
;
1339 cmd
->execute_cmd
= spc_emulate_request_sense
;
1342 *size
= (cdb
[3] << 8) + cdb
[4];
1345 * Do implicit HEAD_OF_QUEUE processing for INQUIRY.
1346 * See spc4r17 section 5.3
1348 cmd
->sam_task_attr
= TCM_HEAD_TAG
;
1349 cmd
->execute_cmd
= spc_emulate_inquiry
;
1351 case SECURITY_PROTOCOL_IN
:
1352 case SECURITY_PROTOCOL_OUT
:
1353 *size
= (cdb
[6] << 24) | (cdb
[7] << 16) | (cdb
[8] << 8) | cdb
[9];
1356 *size
= get_unaligned_be32(&cdb
[10]);
1357 cmd
->execute_cmd
= target_do_xcopy
;
1359 case RECEIVE_COPY_RESULTS
:
1360 *size
= get_unaligned_be32(&cdb
[10]);
1361 cmd
->execute_cmd
= target_do_receive_copy_results
;
1363 case READ_ATTRIBUTE
:
1364 case WRITE_ATTRIBUTE
:
1365 *size
= (cdb
[10] << 24) | (cdb
[11] << 16) |
1366 (cdb
[12] << 8) | cdb
[13];
1368 case RECEIVE_DIAGNOSTIC
:
1369 case SEND_DIAGNOSTIC
:
1370 *size
= (cdb
[3] << 8) | cdb
[4];
1373 *size
= (cdb
[6] << 16) + (cdb
[7] << 8) + cdb
[8];
1376 cmd
->execute_cmd
= spc_emulate_report_luns
;
1377 *size
= (cdb
[6] << 24) | (cdb
[7] << 16) | (cdb
[8] << 8) | cdb
[9];
1379 * Do implicit HEAD_OF_QUEUE processing for REPORT_LUNS
1380 * See spc4r17 section 5.3
1382 cmd
->sam_task_attr
= TCM_HEAD_TAG
;
1384 case TEST_UNIT_READY
:
1385 cmd
->execute_cmd
= spc_emulate_testunitready
;
1388 case MAINTENANCE_IN
:
1389 if (dev
->transport
->get_device_type(dev
) != TYPE_ROM
) {
1391 * MAINTENANCE_IN from SCC-2
1392 * Check for emulated MI_REPORT_TARGET_PGS
1394 if ((cdb
[1] & 0x1f) == MI_REPORT_TARGET_PGS
) {
1396 target_emulate_report_target_port_groups
;
1398 *size
= get_unaligned_be32(&cdb
[6]);
1401 * GPCMD_SEND_KEY from multi media commands
1403 *size
= get_unaligned_be16(&cdb
[8]);
1406 case MAINTENANCE_OUT
:
1407 if (dev
->transport
->get_device_type(dev
) != TYPE_ROM
) {
1409 * MAINTENANCE_OUT from SCC-2
1410 * Check for emulated MO_SET_TARGET_PGS.
1412 if (cdb
[1] == MO_SET_TARGET_PGS
) {
1414 target_emulate_set_target_port_groups
;
1416 *size
= get_unaligned_be32(&cdb
[6]);
1419 * GPCMD_SEND_KEY from multi media commands
1421 *size
= get_unaligned_be16(&cdb
[8]);
1425 pr_warn("TARGET_CORE[%s]: Unsupported SCSI Opcode"
1426 " 0x%02x, sending CHECK_CONDITION.\n",
1427 cmd
->se_tfo
->get_fabric_name(), cdb
[0]);
1428 return TCM_UNSUPPORTED_SCSI_OPCODE
;
1433 EXPORT_SYMBOL(spc_parse_cdb
);