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_proto.h>
28 #include <scsi/scsi_common.h>
29 #include <scsi/scsi_tcq.h>
31 #include <target/target_core_base.h>
32 #include <target/target_core_backend.h>
33 #include <target/target_core_fabric.h>
35 #include "target_core_internal.h"
36 #include "target_core_alua.h"
37 #include "target_core_pr.h"
38 #include "target_core_ua.h"
39 #include "target_core_xcopy.h"
41 static void spc_fill_alua_data(struct se_port
*port
, unsigned char *buf
)
43 struct t10_alua_tg_pt_gp
*tg_pt_gp
;
44 struct t10_alua_tg_pt_gp_member
*tg_pt_gp_mem
;
47 * Set SCCS for MAINTENANCE_IN + REPORT_TARGET_PORT_GROUPS.
52 * Set TPGS field for explicit and/or implicit ALUA access type
55 * See spc4r17 section 6.4.2 Table 135
59 tg_pt_gp_mem
= port
->sep_alua_tg_pt_gp_mem
;
63 spin_lock(&tg_pt_gp_mem
->tg_pt_gp_mem_lock
);
64 tg_pt_gp
= tg_pt_gp_mem
->tg_pt_gp
;
66 buf
[5] |= tg_pt_gp
->tg_pt_gp_alua_access_type
;
67 spin_unlock(&tg_pt_gp_mem
->tg_pt_gp_mem_lock
);
71 spc_emulate_inquiry_std(struct se_cmd
*cmd
, unsigned char *buf
)
73 struct se_lun
*lun
= cmd
->se_lun
;
74 struct se_device
*dev
= cmd
->se_dev
;
75 struct se_session
*sess
= cmd
->se_sess
;
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
);
101 * Set Third-Party Copy (3PC) bit to indicate support for EXTENDED_COPY
103 if (dev
->dev_attrib
.emulate_3pc
)
106 * Set Protection (PROTECT) bit when DIF has been enabled on the
107 * device, and the fabric supports VERIFY + PASS. Also report
108 * PROTECT=1 if sess_prot_type has been configured to allow T10-PI
109 * to unprotected devices.
111 if (sess
->sup_prot_ops
& (TARGET_PROT_DIN_PASS
| TARGET_PROT_DOUT_PASS
)) {
112 if (dev
->dev_attrib
.pi_prot_type
|| cmd
->se_sess
->sess_prot_type
)
116 buf
[7] = 0x2; /* CmdQue=1 */
118 memcpy(&buf
[8], "LIO-ORG ", 8);
119 memset(&buf
[16], 0x20, 16);
120 memcpy(&buf
[16], dev
->t10_wwn
.model
,
121 min_t(size_t, strlen(dev
->t10_wwn
.model
), 16));
122 memcpy(&buf
[32], dev
->t10_wwn
.revision
,
123 min_t(size_t, strlen(dev
->t10_wwn
.revision
), 4));
124 buf
[4] = 31; /* Set additional length to 31 */
128 EXPORT_SYMBOL(spc_emulate_inquiry_std
);
130 /* unit serial number */
131 static sense_reason_t
132 spc_emulate_evpd_80(struct se_cmd
*cmd
, unsigned char *buf
)
134 struct se_device
*dev
= cmd
->se_dev
;
137 if (dev
->dev_flags
& DF_EMULATED_VPD_UNIT_SERIAL
) {
138 len
= sprintf(&buf
[4], "%s", dev
->t10_wwn
.unit_serial
);
139 len
++; /* Extra Byte for NULL Terminator */
145 void spc_parse_naa_6h_vendor_specific(struct se_device
*dev
,
148 unsigned char *p
= &dev
->t10_wwn
.unit_serial
[0];
153 * Generate up to 36 bits of VENDOR SPECIFIC IDENTIFIER starting on
154 * byte 3 bit 3-0 for NAA IEEE Registered Extended DESIGNATOR field
155 * format, followed by 64 bits of VENDOR SPECIFIC IDENTIFIER EXTENSION
156 * to complete the payload. These are based from VPD=0x80 PRODUCT SERIAL
157 * NUMBER set via vpd_unit_serial in target_core_configfs.c to ensure
158 * per device uniqeness.
160 for (cnt
= 0; *p
&& cnt
< 13; p
++) {
161 int val
= hex_to_bin(*p
);
177 * Device identification VPD, for a complete list of
178 * DESIGNATOR TYPEs see spc4r17 Table 459.
181 spc_emulate_evpd_83(struct se_cmd
*cmd
, unsigned char *buf
)
183 struct se_device
*dev
= cmd
->se_dev
;
184 struct se_lun
*lun
= cmd
->se_lun
;
185 struct se_port
*port
= NULL
;
186 struct se_portal_group
*tpg
= NULL
;
187 struct t10_alua_lu_gp_member
*lu_gp_mem
;
188 struct t10_alua_tg_pt_gp
*tg_pt_gp
;
189 struct t10_alua_tg_pt_gp_member
*tg_pt_gp_mem
;
190 unsigned char *prod
= &dev
->t10_wwn
.model
[0];
192 u32 unit_serial_len
, off
= 0;
198 * NAA IEEE Registered Extended Assigned designator format, see
199 * spc4r17 section 7.7.3.6.5
201 * We depend upon a target_core_mod/ConfigFS provided
202 * /sys/kernel/config/target/core/$HBA/$DEV/wwn/vpd_unit_serial
203 * value in order to return the NAA id.
205 if (!(dev
->dev_flags
& DF_EMULATED_VPD_UNIT_SERIAL
))
206 goto check_t10_vend_desc
;
208 /* CODE SET == Binary */
211 /* Set ASSOCIATION == addressed logical unit: 0)b */
214 /* Identifier/Designator type == NAA identifier */
218 /* Identifier/Designator length */
222 * Start NAA IEEE Registered Extended Identifier/Designator
224 buf
[off
++] = (0x6 << 4);
227 * Use OpenFabrics IEEE Company ID: 00 14 05
231 buf
[off
] = (0x5 << 4);
234 * Return ConfigFS Unit Serial Number information for
235 * VENDOR_SPECIFIC_IDENTIFIER and
236 * VENDOR_SPECIFIC_IDENTIFIER_EXTENTION
238 spc_parse_naa_6h_vendor_specific(dev
, &buf
[off
]);
245 * T10 Vendor Identifier Page, see spc4r17 section 7.7.3.4
247 id_len
= 8; /* For Vendor field */
248 prod_len
= 4; /* For VPD Header */
249 prod_len
+= 8; /* For Vendor field */
250 prod_len
+= strlen(prod
);
251 prod_len
++; /* For : */
253 if (dev
->dev_flags
& DF_EMULATED_VPD_UNIT_SERIAL
) {
254 unit_serial_len
= strlen(&dev
->t10_wwn
.unit_serial
[0]);
255 unit_serial_len
++; /* For NULL Terminator */
257 id_len
+= sprintf(&buf
[off
+12], "%s:%s", prod
,
258 &dev
->t10_wwn
.unit_serial
[0]);
260 buf
[off
] = 0x2; /* ASCII */
261 buf
[off
+1] = 0x1; /* T10 Vendor ID */
263 memcpy(&buf
[off
+4], "LIO-ORG", 8);
264 /* Extra Byte for NULL Terminator */
266 /* Identifier Length */
268 /* Header size for Designation descriptor */
272 * struct se_port is only set for INQUIRY VPD=1 through $FABRIC_MOD
276 struct t10_alua_lu_gp
*lu_gp
;
277 u32 padding
, scsi_name_len
, scsi_target_len
;
284 * Relative target port identifer, see spc4r17
287 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
288 * section 7.5.1 Table 362
291 (tpg
->se_tpg_tfo
->get_fabric_proto_ident(tpg
) << 4);
292 buf
[off
++] |= 0x1; /* CODE SET == Binary */
293 buf
[off
] = 0x80; /* Set PIV=1 */
294 /* Set ASSOCIATION == target port: 01b */
296 /* DESIGNATOR TYPE == Relative target port identifer */
298 off
++; /* Skip over Reserved */
299 buf
[off
++] = 4; /* DESIGNATOR LENGTH */
300 /* Skip over Obsolete field in RTPI payload
303 buf
[off
++] = ((port
->sep_rtpi
>> 8) & 0xff);
304 buf
[off
++] = (port
->sep_rtpi
& 0xff);
305 len
+= 8; /* Header size + Designation descriptor */
307 * Target port group identifier, see spc4r17
310 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
311 * section 7.5.1 Table 362
313 tg_pt_gp_mem
= port
->sep_alua_tg_pt_gp_mem
;
317 spin_lock(&tg_pt_gp_mem
->tg_pt_gp_mem_lock
);
318 tg_pt_gp
= tg_pt_gp_mem
->tg_pt_gp
;
320 spin_unlock(&tg_pt_gp_mem
->tg_pt_gp_mem_lock
);
323 tg_pt_gp_id
= tg_pt_gp
->tg_pt_gp_id
;
324 spin_unlock(&tg_pt_gp_mem
->tg_pt_gp_mem_lock
);
327 (tpg
->se_tpg_tfo
->get_fabric_proto_ident(tpg
) << 4);
328 buf
[off
++] |= 0x1; /* CODE SET == Binary */
329 buf
[off
] = 0x80; /* Set PIV=1 */
330 /* Set ASSOCIATION == target port: 01b */
332 /* DESIGNATOR TYPE == Target port group identifier */
334 off
++; /* Skip over Reserved */
335 buf
[off
++] = 4; /* DESIGNATOR LENGTH */
336 off
+= 2; /* Skip over Reserved Field */
337 buf
[off
++] = ((tg_pt_gp_id
>> 8) & 0xff);
338 buf
[off
++] = (tg_pt_gp_id
& 0xff);
339 len
+= 8; /* Header size + Designation descriptor */
341 * Logical Unit Group identifier, see spc4r17
345 lu_gp_mem
= dev
->dev_alua_lu_gp_mem
;
347 goto check_scsi_name
;
349 spin_lock(&lu_gp_mem
->lu_gp_mem_lock
);
350 lu_gp
= lu_gp_mem
->lu_gp
;
352 spin_unlock(&lu_gp_mem
->lu_gp_mem_lock
);
353 goto check_scsi_name
;
355 lu_gp_id
= lu_gp
->lu_gp_id
;
356 spin_unlock(&lu_gp_mem
->lu_gp_mem_lock
);
358 buf
[off
++] |= 0x1; /* CODE SET == Binary */
359 /* DESIGNATOR TYPE == Logical Unit Group identifier */
361 off
++; /* Skip over Reserved */
362 buf
[off
++] = 4; /* DESIGNATOR LENGTH */
363 off
+= 2; /* Skip over Reserved Field */
364 buf
[off
++] = ((lu_gp_id
>> 8) & 0xff);
365 buf
[off
++] = (lu_gp_id
& 0xff);
366 len
+= 8; /* Header size + Designation descriptor */
368 * SCSI name string designator, see spc4r17
371 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
372 * section 7.5.1 Table 362
376 (tpg
->se_tpg_tfo
->get_fabric_proto_ident(tpg
) << 4);
377 buf
[off
++] |= 0x3; /* CODE SET == UTF-8 */
378 buf
[off
] = 0x80; /* Set PIV=1 */
379 /* Set ASSOCIATION == target port: 01b */
381 /* DESIGNATOR TYPE == SCSI name string */
383 off
+= 2; /* Skip over Reserved and length */
385 * SCSI name string identifer containing, $FABRIC_MOD
386 * dependent information. For LIO-Target and iSCSI
387 * Target Port, this means "<iSCSI name>,t,0x<TPGT> in
390 tpgt
= tpg
->se_tpg_tfo
->tpg_get_tag(tpg
);
391 scsi_name_len
= sprintf(&buf
[off
], "%s,t,0x%04x",
392 tpg
->se_tpg_tfo
->tpg_get_wwn(tpg
), tpgt
);
393 scsi_name_len
+= 1 /* Include NULL terminator */;
395 * The null-terminated, null-padded (see 4.4.2) SCSI
396 * NAME STRING field contains a UTF-8 format string.
397 * The number of bytes in the SCSI NAME STRING field
398 * (i.e., the value in the DESIGNATOR LENGTH field)
399 * shall be no larger than 256 and shall be a multiple
402 padding
= ((-scsi_name_len
) & 3);
404 scsi_name_len
+= padding
;
405 if (scsi_name_len
> 256)
408 buf
[off
-1] = scsi_name_len
;
409 off
+= scsi_name_len
;
410 /* Header size + Designation descriptor */
411 len
+= (scsi_name_len
+ 4);
414 * Target device designator
417 (tpg
->se_tpg_tfo
->get_fabric_proto_ident(tpg
) << 4);
418 buf
[off
++] |= 0x3; /* CODE SET == UTF-8 */
419 buf
[off
] = 0x80; /* Set PIV=1 */
420 /* Set ASSOCIATION == target device: 10b */
422 /* DESIGNATOR TYPE == SCSI name string */
424 off
+= 2; /* Skip over Reserved and length */
426 * SCSI name string identifer containing, $FABRIC_MOD
427 * dependent information. For LIO-Target and iSCSI
428 * Target Port, this means "<iSCSI name>" in
431 scsi_target_len
= sprintf(&buf
[off
], "%s",
432 tpg
->se_tpg_tfo
->tpg_get_wwn(tpg
));
433 scsi_target_len
+= 1 /* Include NULL terminator */;
435 * The null-terminated, null-padded (see 4.4.2) SCSI
436 * NAME STRING field contains a UTF-8 format string.
437 * The number of bytes in the SCSI NAME STRING field
438 * (i.e., the value in the DESIGNATOR LENGTH field)
439 * shall be no larger than 256 and shall be a multiple
442 padding
= ((-scsi_target_len
) & 3);
444 scsi_target_len
+= padding
;
445 if (scsi_target_len
> 256)
446 scsi_target_len
= 256;
448 buf
[off
-1] = scsi_target_len
;
449 off
+= scsi_target_len
;
451 /* Header size + Designation descriptor */
452 len
+= (scsi_target_len
+ 4);
454 buf
[2] = ((len
>> 8) & 0xff);
455 buf
[3] = (len
& 0xff); /* Page Length for VPD 0x83 */
458 EXPORT_SYMBOL(spc_emulate_evpd_83
);
460 /* Extended INQUIRY Data VPD Page */
461 static sense_reason_t
462 spc_emulate_evpd_86(struct se_cmd
*cmd
, unsigned char *buf
)
464 struct se_device
*dev
= cmd
->se_dev
;
465 struct se_session
*sess
= cmd
->se_sess
;
469 * Set GRD_CHK + REF_CHK for TYPE1 protection, or GRD_CHK
470 * only for TYPE3 protection.
472 if (sess
->sup_prot_ops
& (TARGET_PROT_DIN_PASS
| TARGET_PROT_DOUT_PASS
)) {
473 if (dev
->dev_attrib
.pi_prot_type
== TARGET_DIF_TYPE1_PROT
||
474 cmd
->se_sess
->sess_prot_type
== TARGET_DIF_TYPE1_PROT
)
476 else if (dev
->dev_attrib
.pi_prot_type
== TARGET_DIF_TYPE3_PROT
||
477 cmd
->se_sess
->sess_prot_type
== TARGET_DIF_TYPE3_PROT
)
481 /* Set HEADSUP, ORDSUP, SIMPSUP */
484 /* If WriteCache emulation is enabled, set V_SUP */
485 if (se_dev_check_wce(dev
))
487 /* If an LBA map is present set R_SUP */
488 spin_lock(&cmd
->se_dev
->t10_alua
.lba_map_lock
);
489 if (!list_empty(&dev
->t10_alua
.lba_map_list
))
491 spin_unlock(&cmd
->se_dev
->t10_alua
.lba_map_lock
);
495 /* Block Limits VPD page */
496 static sense_reason_t
497 spc_emulate_evpd_b0(struct se_cmd
*cmd
, unsigned char *buf
)
499 struct se_device
*dev
= cmd
->se_dev
;
504 * Following spc3r22 section 6.5.3 Block Limits VPD page, when
505 * emulate_tpu=1 or emulate_tpws=1 we will be expect a
506 * different page length for Thin Provisioning.
508 if (dev
->dev_attrib
.emulate_tpu
|| dev
->dev_attrib
.emulate_tpws
)
511 buf
[0] = dev
->transport
->get_device_type(dev
);
512 buf
[3] = have_tp
? 0x3c : 0x10;
517 * Set MAXIMUM COMPARE AND WRITE LENGTH
519 if (dev
->dev_attrib
.emulate_caw
)
523 * Set OPTIMAL TRANSFER LENGTH GRANULARITY
525 if (dev
->transport
->get_io_min
&& (min
= dev
->transport
->get_io_min(dev
)))
526 put_unaligned_be16(min
/ dev
->dev_attrib
.block_size
, &buf
[6]);
528 put_unaligned_be16(1, &buf
[6]);
531 * Set MAXIMUM TRANSFER LENGTH
533 put_unaligned_be32(dev
->dev_attrib
.hw_max_sectors
, &buf
[8]);
536 * Set OPTIMAL TRANSFER LENGTH
538 if (dev
->transport
->get_io_opt
&& (opt
= dev
->transport
->get_io_opt(dev
)))
539 put_unaligned_be32(opt
/ dev
->dev_attrib
.block_size
, &buf
[12]);
541 put_unaligned_be32(dev
->dev_attrib
.optimal_sectors
, &buf
[12]);
544 * Exit now if we don't support TP.
550 * Set MAXIMUM UNMAP LBA COUNT
552 put_unaligned_be32(dev
->dev_attrib
.max_unmap_lba_count
, &buf
[20]);
555 * Set MAXIMUM UNMAP BLOCK DESCRIPTOR COUNT
557 put_unaligned_be32(dev
->dev_attrib
.max_unmap_block_desc_count
,
561 * Set OPTIMAL UNMAP GRANULARITY
563 put_unaligned_be32(dev
->dev_attrib
.unmap_granularity
, &buf
[28]);
566 * UNMAP GRANULARITY ALIGNMENT
568 put_unaligned_be32(dev
->dev_attrib
.unmap_granularity_alignment
,
570 if (dev
->dev_attrib
.unmap_granularity_alignment
!= 0)
571 buf
[32] |= 0x80; /* Set the UGAVALID bit */
574 * MAXIMUM WRITE SAME LENGTH
577 put_unaligned_be64(dev
->dev_attrib
.max_write_same_len
, &buf
[36]);
582 /* Block Device Characteristics VPD page */
583 static sense_reason_t
584 spc_emulate_evpd_b1(struct se_cmd
*cmd
, unsigned char *buf
)
586 struct se_device
*dev
= cmd
->se_dev
;
588 buf
[0] = dev
->transport
->get_device_type(dev
);
590 buf
[5] = dev
->dev_attrib
.is_nonrot
? 1 : 0;
595 /* Thin Provisioning VPD */
596 static sense_reason_t
597 spc_emulate_evpd_b2(struct se_cmd
*cmd
, unsigned char *buf
)
599 struct se_device
*dev
= cmd
->se_dev
;
602 * From spc3r22 section 6.5.4 Thin Provisioning VPD page:
604 * The PAGE LENGTH field is defined in SPC-4. If the DP bit is set to
605 * zero, then the page length shall be set to 0004h. If the DP bit
606 * is set to one, then the page length shall be set to the value
607 * defined in table 162.
609 buf
[0] = dev
->transport
->get_device_type(dev
);
612 * Set Hardcoded length mentioned above for DP=0
614 put_unaligned_be16(0x0004, &buf
[2]);
617 * The THRESHOLD EXPONENT field indicates the threshold set size in
618 * LBAs as a power of 2 (i.e., the threshold set size is equal to
619 * 2(threshold exponent)).
621 * Note that this is currently set to 0x00 as mkp says it will be
622 * changing again. We can enable this once it has settled in T10
623 * and is actually used by Linux/SCSI ML code.
628 * A TPU bit set to one indicates that the device server supports
629 * the UNMAP command (see 5.25). A TPU bit set to zero indicates
630 * that the device server does not support the UNMAP command.
632 if (dev
->dev_attrib
.emulate_tpu
!= 0)
636 * A TPWS bit set to one indicates that the device server supports
637 * the use of the WRITE SAME (16) command (see 5.42) to unmap LBAs.
638 * A TPWS bit set to zero indicates that the device server does not
639 * support the use of the WRITE SAME (16) command to unmap LBAs.
641 if (dev
->dev_attrib
.emulate_tpws
!= 0)
642 buf
[5] |= 0x40 | 0x20;
647 /* Referrals VPD page */
648 static sense_reason_t
649 spc_emulate_evpd_b3(struct se_cmd
*cmd
, unsigned char *buf
)
651 struct se_device
*dev
= cmd
->se_dev
;
653 buf
[0] = dev
->transport
->get_device_type(dev
);
655 put_unaligned_be32(dev
->t10_alua
.lba_map_segment_size
, &buf
[8]);
656 put_unaligned_be32(dev
->t10_alua
.lba_map_segment_multiplier
, &buf
[12]);
661 static sense_reason_t
662 spc_emulate_evpd_00(struct se_cmd
*cmd
, unsigned char *buf
);
666 sense_reason_t (*emulate
)(struct se_cmd
*, unsigned char *);
667 } evpd_handlers
[] = {
668 { .page
= 0x00, .emulate
= spc_emulate_evpd_00
},
669 { .page
= 0x80, .emulate
= spc_emulate_evpd_80
},
670 { .page
= 0x83, .emulate
= spc_emulate_evpd_83
},
671 { .page
= 0x86, .emulate
= spc_emulate_evpd_86
},
672 { .page
= 0xb0, .emulate
= spc_emulate_evpd_b0
},
673 { .page
= 0xb1, .emulate
= spc_emulate_evpd_b1
},
674 { .page
= 0xb2, .emulate
= spc_emulate_evpd_b2
},
675 { .page
= 0xb3, .emulate
= spc_emulate_evpd_b3
},
678 /* supported vital product data pages */
679 static sense_reason_t
680 spc_emulate_evpd_00(struct se_cmd
*cmd
, unsigned char *buf
)
685 * Only report the INQUIRY EVPD=1 pages after a valid NAA
686 * Registered Extended LUN WWN has been set via ConfigFS
687 * during device creation/restart.
689 if (cmd
->se_dev
->dev_flags
& DF_EMULATED_VPD_UNIT_SERIAL
) {
690 buf
[3] = ARRAY_SIZE(evpd_handlers
);
691 for (p
= 0; p
< ARRAY_SIZE(evpd_handlers
); ++p
)
692 buf
[p
+ 4] = evpd_handlers
[p
].page
;
698 static sense_reason_t
699 spc_emulate_inquiry(struct se_cmd
*cmd
)
701 struct se_device
*dev
= cmd
->se_dev
;
702 struct se_portal_group
*tpg
= cmd
->se_lun
->lun_sep
->sep_tpg
;
704 unsigned char *cdb
= cmd
->t_task_cdb
;
710 buf
= kzalloc(SE_INQUIRY_BUF
, GFP_KERNEL
);
712 pr_err("Unable to allocate response buffer for INQUIRY\n");
713 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
716 if (dev
== tpg
->tpg_virt_lun0
.lun_se_dev
)
717 buf
[0] = 0x3f; /* Not connected */
719 buf
[0] = dev
->transport
->get_device_type(dev
);
721 if (!(cdb
[1] & 0x1)) {
723 pr_err("INQUIRY with EVPD==0 but PAGE CODE=%02x\n",
725 ret
= TCM_INVALID_CDB_FIELD
;
729 ret
= spc_emulate_inquiry_std(cmd
, buf
);
734 for (p
= 0; p
< ARRAY_SIZE(evpd_handlers
); ++p
) {
735 if (cdb
[2] == evpd_handlers
[p
].page
) {
737 ret
= evpd_handlers
[p
].emulate(cmd
, buf
);
738 len
= get_unaligned_be16(&buf
[2]) + 4;
743 pr_err("Unknown VPD Code: 0x%02x\n", cdb
[2]);
744 ret
= TCM_INVALID_CDB_FIELD
;
747 rbuf
= transport_kmap_data_sg(cmd
);
749 memcpy(rbuf
, buf
, min_t(u32
, SE_INQUIRY_BUF
, cmd
->data_length
));
750 transport_kunmap_data_sg(cmd
);
755 target_complete_cmd_with_length(cmd
, GOOD
, len
);
759 static int spc_modesense_rwrecovery(struct se_cmd
*cmd
, u8 pc
, u8
*p
)
764 /* No changeable values for now */
772 static int spc_modesense_control(struct se_cmd
*cmd
, u8 pc
, u8
*p
)
774 struct se_device
*dev
= cmd
->se_dev
;
775 struct se_session
*sess
= cmd
->se_sess
;
780 /* No changeable values for now */
786 * From spc4r23, 7.4.7 Control mode page
788 * The QUEUE ALGORITHM MODIFIER field (see table 368) specifies
789 * restrictions on the algorithm used for reordering commands
790 * having the SIMPLE task attribute (see SAM-4).
792 * Table 368 -- QUEUE ALGORITHM MODIFIER field
794 * 0h Restricted reordering
795 * 1h Unrestricted reordering allowed
797 * 8h to Fh Vendor specific
799 * A value of zero in the QUEUE ALGORITHM MODIFIER field specifies that
800 * the device server shall order the processing sequence of commands
801 * having the SIMPLE task attribute such that data integrity is maintained
802 * for that I_T nexus (i.e., if the transmission of new SCSI transport protocol
803 * requests is halted at any time, the final value of all data observable
804 * on the medium shall be the same as if all the commands had been processed
805 * with the ORDERED task attribute).
807 * A value of one in the QUEUE ALGORITHM MODIFIER field specifies that the
808 * device server may reorder the processing sequence of commands having the
809 * SIMPLE task attribute in any manner. Any data integrity exposures related to
810 * command sequence order shall be explicitly handled by the application client
811 * through the selection of appropriate ommands and task attributes.
813 p
[3] = (dev
->dev_attrib
.emulate_rest_reord
== 1) ? 0x00 : 0x10;
815 * From spc4r17, section 7.4.6 Control mode Page
817 * Unit Attention interlocks control (UN_INTLCK_CTRL) to code 00b
819 * 00b: The logical unit shall clear any unit attention condition
820 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
821 * status and shall not establish a unit attention condition when a com-
822 * mand is completed with BUSY, TASK SET FULL, or RESERVATION CONFLICT
825 * 10b: The logical unit shall not clear any unit attention condition
826 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
827 * status and shall not establish a unit attention condition when
828 * a command is completed with BUSY, TASK SET FULL, or RESERVATION
831 * 11b a The logical unit shall not clear any unit attention condition
832 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
833 * status and shall establish a unit attention condition for the
834 * initiator port associated with the I_T nexus on which the BUSY,
835 * TASK SET FULL, or RESERVATION CONFLICT status is being returned.
836 * Depending on the status, the additional sense code shall be set to
837 * PREVIOUS BUSY STATUS, PREVIOUS TASK SET FULL STATUS, or PREVIOUS
838 * RESERVATION CONFLICT STATUS. Until it is cleared by a REQUEST SENSE
839 * command, a unit attention condition shall be established only once
840 * for a BUSY, TASK SET FULL, or RESERVATION CONFLICT status regardless
841 * to the number of commands completed with one of those status codes.
843 p
[4] = (dev
->dev_attrib
.emulate_ua_intlck_ctrl
== 2) ? 0x30 :
844 (dev
->dev_attrib
.emulate_ua_intlck_ctrl
== 1) ? 0x20 : 0x00;
846 * From spc4r17, section 7.4.6 Control mode Page
848 * Task Aborted Status (TAS) bit set to zero.
850 * A task aborted status (TAS) bit set to zero specifies that aborted
851 * tasks shall be terminated by the device server without any response
852 * to the application client. A TAS bit set to one specifies that tasks
853 * aborted by the actions of an I_T nexus other than the I_T nexus on
854 * which the command was received shall be completed with TASK ABORTED
855 * status (see SAM-4).
857 p
[5] = (dev
->dev_attrib
.emulate_tas
) ? 0x40 : 0x00;
859 * From spc4r30, section 7.5.7 Control mode page
861 * Application Tag Owner (ATO) bit set to one.
863 * If the ATO bit is set to one the device server shall not modify the
864 * LOGICAL BLOCK APPLICATION TAG field and, depending on the protection
865 * type, shall not modify the contents of the LOGICAL BLOCK REFERENCE
868 if (sess
->sup_prot_ops
& (TARGET_PROT_DIN_PASS
| TARGET_PROT_DOUT_PASS
)) {
869 if (dev
->dev_attrib
.pi_prot_type
|| sess
->sess_prot_type
)
881 static int spc_modesense_caching(struct se_cmd
*cmd
, u8 pc
, u8
*p
)
883 struct se_device
*dev
= cmd
->se_dev
;
888 /* No changeable values for now */
892 if (se_dev_check_wce(dev
))
893 p
[2] = 0x04; /* Write Cache Enable */
894 p
[12] = 0x20; /* Disabled Read Ahead */
900 static int spc_modesense_informational_exceptions(struct se_cmd
*cmd
, u8 pc
, unsigned char *p
)
905 /* No changeable values for now */
916 int (*emulate
)(struct se_cmd
*, u8
, unsigned char *);
917 } modesense_handlers
[] = {
918 { .page
= 0x01, .subpage
= 0x00, .emulate
= spc_modesense_rwrecovery
},
919 { .page
= 0x08, .subpage
= 0x00, .emulate
= spc_modesense_caching
},
920 { .page
= 0x0a, .subpage
= 0x00, .emulate
= spc_modesense_control
},
921 { .page
= 0x1c, .subpage
= 0x00, .emulate
= spc_modesense_informational_exceptions
},
924 static void spc_modesense_write_protect(unsigned char *buf
, int type
)
927 * I believe that the WP bit (bit 7) in the mode header is the same for
934 buf
[0] |= 0x80; /* WP bit */
939 static void spc_modesense_dpofua(unsigned char *buf
, int type
)
943 buf
[0] |= 0x10; /* DPOFUA bit */
950 static int spc_modesense_blockdesc(unsigned char *buf
, u64 blocks
, u32 block_size
)
953 put_unaligned_be32(min(blocks
, 0xffffffffull
), buf
);
955 put_unaligned_be32(block_size
, buf
);
959 static int spc_modesense_long_blockdesc(unsigned char *buf
, u64 blocks
, u32 block_size
)
961 if (blocks
<= 0xffffffff)
962 return spc_modesense_blockdesc(buf
+ 3, blocks
, block_size
) + 3;
964 *buf
++ = 1; /* LONGLBA */
967 put_unaligned_be64(blocks
, buf
);
969 put_unaligned_be32(block_size
, buf
);
974 static sense_reason_t
spc_emulate_modesense(struct se_cmd
*cmd
)
976 struct se_device
*dev
= cmd
->se_dev
;
977 char *cdb
= cmd
->t_task_cdb
;
978 unsigned char buf
[SE_MODE_PAGE_BUF
], *rbuf
;
979 int type
= dev
->transport
->get_device_type(dev
);
980 int ten
= (cmd
->t_task_cdb
[0] == MODE_SENSE_10
);
981 bool dbd
= !!(cdb
[1] & 0x08);
982 bool llba
= ten
? !!(cdb
[1] & 0x10) : false;
984 u8 page
= cdb
[2] & 0x3f;
990 memset(buf
, 0, SE_MODE_PAGE_BUF
);
993 * Skip over MODE DATA LENGTH + MEDIUM TYPE fields to byte 3 for
994 * MODE_SENSE_10 and byte 2 for MODE_SENSE (6).
996 length
= ten
? 3 : 2;
998 /* DEVICE-SPECIFIC PARAMETER */
999 if ((cmd
->se_lun
->lun_access
& TRANSPORT_LUNFLAGS_READ_ONLY
) ||
1001 (cmd
->se_deve
->lun_flags
& TRANSPORT_LUNFLAGS_READ_ONLY
)))
1002 spc_modesense_write_protect(&buf
[length
], type
);
1004 if ((se_dev_check_wce(dev
)) &&
1005 (dev
->dev_attrib
.emulate_fua_write
> 0))
1006 spc_modesense_dpofua(&buf
[length
], type
);
1010 /* BLOCK DESCRIPTOR */
1013 * For now we only include a block descriptor for disk (SBC)
1014 * devices; other command sets use a slightly different format.
1016 if (!dbd
&& type
== TYPE_DISK
) {
1017 u64 blocks
= dev
->transport
->get_blocks(dev
);
1018 u32 block_size
= dev
->dev_attrib
.block_size
;
1022 length
+= spc_modesense_long_blockdesc(&buf
[length
],
1023 blocks
, block_size
);
1026 length
+= spc_modesense_blockdesc(&buf
[length
],
1027 blocks
, block_size
);
1030 length
+= spc_modesense_blockdesc(&buf
[length
], blocks
,
1041 if (subpage
!= 0x00 && subpage
!= 0xff) {
1042 pr_warn("MODE_SENSE: Invalid subpage code: 0x%02x\n", subpage
);
1043 return TCM_INVALID_CDB_FIELD
;
1046 for (i
= 0; i
< ARRAY_SIZE(modesense_handlers
); ++i
) {
1048 * Tricky way to say all subpage 00h for
1049 * subpage==0, all subpages for subpage==0xff
1050 * (and we just checked above that those are
1051 * the only two possibilities).
1053 if ((modesense_handlers
[i
].subpage
& ~subpage
) == 0) {
1054 ret
= modesense_handlers
[i
].emulate(cmd
, pc
, &buf
[length
]);
1055 if (!ten
&& length
+ ret
>= 255)
1064 for (i
= 0; i
< ARRAY_SIZE(modesense_handlers
); ++i
)
1065 if (modesense_handlers
[i
].page
== page
&&
1066 modesense_handlers
[i
].subpage
== subpage
) {
1067 length
+= modesense_handlers
[i
].emulate(cmd
, pc
, &buf
[length
]);
1072 * We don't intend to implement:
1073 * - obsolete page 03h "format parameters" (checked by Solaris)
1076 pr_err("MODE SENSE: unimplemented page/subpage: 0x%02x/0x%02x\n",
1079 return TCM_UNKNOWN_MODE_PAGE
;
1083 put_unaligned_be16(length
- 2, buf
);
1085 buf
[0] = length
- 1;
1087 rbuf
= transport_kmap_data_sg(cmd
);
1089 memcpy(rbuf
, buf
, min_t(u32
, SE_MODE_PAGE_BUF
, cmd
->data_length
));
1090 transport_kunmap_data_sg(cmd
);
1093 target_complete_cmd_with_length(cmd
, GOOD
, length
);
1097 static sense_reason_t
spc_emulate_modeselect(struct se_cmd
*cmd
)
1099 char *cdb
= cmd
->t_task_cdb
;
1100 bool ten
= cdb
[0] == MODE_SELECT_10
;
1101 int off
= ten
? 8 : 4;
1102 bool pf
= !!(cdb
[1] & 0x10);
1105 unsigned char tbuf
[SE_MODE_PAGE_BUF
];
1107 sense_reason_t ret
= 0;
1110 if (!cmd
->data_length
) {
1111 target_complete_cmd(cmd
, GOOD
);
1115 if (cmd
->data_length
< off
+ 2)
1116 return TCM_PARAMETER_LIST_LENGTH_ERROR
;
1118 buf
= transport_kmap_data_sg(cmd
);
1120 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1123 ret
= TCM_INVALID_CDB_FIELD
;
1127 page
= buf
[off
] & 0x3f;
1128 subpage
= buf
[off
] & 0x40 ? buf
[off
+ 1] : 0;
1130 for (i
= 0; i
< ARRAY_SIZE(modesense_handlers
); ++i
)
1131 if (modesense_handlers
[i
].page
== page
&&
1132 modesense_handlers
[i
].subpage
== subpage
) {
1133 memset(tbuf
, 0, SE_MODE_PAGE_BUF
);
1134 length
= modesense_handlers
[i
].emulate(cmd
, 0, tbuf
);
1135 goto check_contents
;
1138 ret
= TCM_UNKNOWN_MODE_PAGE
;
1142 if (cmd
->data_length
< off
+ length
) {
1143 ret
= TCM_PARAMETER_LIST_LENGTH_ERROR
;
1147 if (memcmp(buf
+ off
, tbuf
, length
))
1148 ret
= TCM_INVALID_PARAMETER_LIST
;
1151 transport_kunmap_data_sg(cmd
);
1154 target_complete_cmd(cmd
, GOOD
);
1158 static sense_reason_t
spc_emulate_request_sense(struct se_cmd
*cmd
)
1160 unsigned char *cdb
= cmd
->t_task_cdb
;
1161 unsigned char *rbuf
;
1162 u8 ua_asc
= 0, ua_ascq
= 0;
1163 unsigned char buf
[SE_SENSE_BUF
];
1165 memset(buf
, 0, SE_SENSE_BUF
);
1167 if (cdb
[1] & 0x01) {
1168 pr_err("REQUEST_SENSE description emulation not"
1170 return TCM_INVALID_CDB_FIELD
;
1173 rbuf
= transport_kmap_data_sg(cmd
);
1175 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1177 if (!core_scsi3_ua_clear_for_request_sense(cmd
, &ua_asc
, &ua_ascq
)) {
1179 * CURRENT ERROR, UNIT ATTENTION
1182 buf
[SPC_SENSE_KEY_OFFSET
] = UNIT_ATTENTION
;
1185 * The Additional Sense Code (ASC) from the UNIT ATTENTION
1187 buf
[SPC_ASC_KEY_OFFSET
] = ua_asc
;
1188 buf
[SPC_ASCQ_KEY_OFFSET
] = ua_ascq
;
1192 * CURRENT ERROR, NO SENSE
1195 buf
[SPC_SENSE_KEY_OFFSET
] = NO_SENSE
;
1198 * NO ADDITIONAL SENSE INFORMATION
1200 buf
[SPC_ASC_KEY_OFFSET
] = 0x00;
1204 memcpy(rbuf
, buf
, min_t(u32
, sizeof(buf
), cmd
->data_length
));
1205 transport_kunmap_data_sg(cmd
);
1207 target_complete_cmd(cmd
, GOOD
);
1211 sense_reason_t
spc_emulate_report_luns(struct se_cmd
*cmd
)
1213 struct se_dev_entry
*deve
;
1214 struct se_session
*sess
= cmd
->se_sess
;
1216 u32 lun_count
= 0, offset
= 8, i
;
1218 if (cmd
->data_length
< 16) {
1219 pr_warn("REPORT LUNS allocation length %u too small\n",
1221 return TCM_INVALID_CDB_FIELD
;
1224 buf
= transport_kmap_data_sg(cmd
);
1226 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1229 * If no struct se_session pointer is present, this struct se_cmd is
1230 * coming via a target_core_mod PASSTHROUGH op, and not through
1231 * a $FABRIC_MOD. In that case, report LUN=0 only.
1234 int_to_scsilun(0, (struct scsi_lun
*)&buf
[offset
]);
1239 spin_lock_irq(&sess
->se_node_acl
->device_list_lock
);
1240 for (i
= 0; i
< TRANSPORT_MAX_LUNS_PER_TPG
; i
++) {
1241 deve
= sess
->se_node_acl
->device_list
[i
];
1242 if (!(deve
->lun_flags
& TRANSPORT_LUNFLAGS_INITIATOR_ACCESS
))
1245 * We determine the correct LUN LIST LENGTH even once we
1246 * have reached the initial allocation length.
1247 * See SPC2-R20 7.19.
1250 if ((offset
+ 8) > cmd
->data_length
)
1253 int_to_scsilun(deve
->mapped_lun
, (struct scsi_lun
*)&buf
[offset
]);
1256 spin_unlock_irq(&sess
->se_node_acl
->device_list_lock
);
1259 * See SPC3 r07, page 159.
1263 buf
[0] = ((lun_count
>> 24) & 0xff);
1264 buf
[1] = ((lun_count
>> 16) & 0xff);
1265 buf
[2] = ((lun_count
>> 8) & 0xff);
1266 buf
[3] = (lun_count
& 0xff);
1267 transport_kunmap_data_sg(cmd
);
1269 target_complete_cmd_with_length(cmd
, GOOD
, 8 + lun_count
* 8);
1272 EXPORT_SYMBOL(spc_emulate_report_luns
);
1274 static sense_reason_t
1275 spc_emulate_testunitready(struct se_cmd
*cmd
)
1277 target_complete_cmd(cmd
, GOOD
);
1282 spc_parse_cdb(struct se_cmd
*cmd
, unsigned int *size
)
1284 struct se_device
*dev
= cmd
->se_dev
;
1285 unsigned char *cdb
= cmd
->t_task_cdb
;
1290 cmd
->execute_cmd
= spc_emulate_modeselect
;
1292 case MODE_SELECT_10
:
1293 *size
= (cdb
[7] << 8) + cdb
[8];
1294 cmd
->execute_cmd
= spc_emulate_modeselect
;
1298 cmd
->execute_cmd
= spc_emulate_modesense
;
1301 *size
= (cdb
[7] << 8) + cdb
[8];
1302 cmd
->execute_cmd
= spc_emulate_modesense
;
1306 *size
= (cdb
[7] << 8) + cdb
[8];
1308 case PERSISTENT_RESERVE_IN
:
1309 *size
= (cdb
[7] << 8) + cdb
[8];
1310 cmd
->execute_cmd
= target_scsi3_emulate_pr_in
;
1312 case PERSISTENT_RESERVE_OUT
:
1313 *size
= (cdb
[7] << 8) + cdb
[8];
1314 cmd
->execute_cmd
= target_scsi3_emulate_pr_out
;
1318 if (cdb
[0] == RELEASE_10
)
1319 *size
= (cdb
[7] << 8) | cdb
[8];
1321 *size
= cmd
->data_length
;
1323 cmd
->execute_cmd
= target_scsi2_reservation_release
;
1328 * The SPC-2 RESERVE does not contain a size in the SCSI CDB.
1329 * Assume the passthrough or $FABRIC_MOD will tell us about it.
1331 if (cdb
[0] == RESERVE_10
)
1332 *size
= (cdb
[7] << 8) | cdb
[8];
1334 *size
= cmd
->data_length
;
1336 cmd
->execute_cmd
= target_scsi2_reservation_reserve
;
1340 cmd
->execute_cmd
= spc_emulate_request_sense
;
1343 *size
= (cdb
[3] << 8) + cdb
[4];
1346 * Do implicit HEAD_OF_QUEUE processing for INQUIRY.
1347 * See spc4r17 section 5.3
1349 cmd
->sam_task_attr
= TCM_HEAD_TAG
;
1350 cmd
->execute_cmd
= spc_emulate_inquiry
;
1352 case SECURITY_PROTOCOL_IN
:
1353 case SECURITY_PROTOCOL_OUT
:
1354 *size
= (cdb
[6] << 24) | (cdb
[7] << 16) | (cdb
[8] << 8) | cdb
[9];
1357 *size
= get_unaligned_be32(&cdb
[10]);
1358 cmd
->execute_cmd
= target_do_xcopy
;
1360 case RECEIVE_COPY_RESULTS
:
1361 *size
= get_unaligned_be32(&cdb
[10]);
1362 cmd
->execute_cmd
= target_do_receive_copy_results
;
1364 case READ_ATTRIBUTE
:
1365 case WRITE_ATTRIBUTE
:
1366 *size
= (cdb
[10] << 24) | (cdb
[11] << 16) |
1367 (cdb
[12] << 8) | cdb
[13];
1369 case RECEIVE_DIAGNOSTIC
:
1370 case SEND_DIAGNOSTIC
:
1371 *size
= (cdb
[3] << 8) | cdb
[4];
1374 *size
= (cdb
[6] << 16) + (cdb
[7] << 8) + cdb
[8];
1377 cmd
->execute_cmd
= spc_emulate_report_luns
;
1378 *size
= (cdb
[6] << 24) | (cdb
[7] << 16) | (cdb
[8] << 8) | cdb
[9];
1380 * Do implicit HEAD_OF_QUEUE processing for REPORT_LUNS
1381 * See spc4r17 section 5.3
1383 cmd
->sam_task_attr
= TCM_HEAD_TAG
;
1385 case TEST_UNIT_READY
:
1386 cmd
->execute_cmd
= spc_emulate_testunitready
;
1389 case MAINTENANCE_IN
:
1390 if (dev
->transport
->get_device_type(dev
) != TYPE_ROM
) {
1392 * MAINTENANCE_IN from SCC-2
1393 * Check for emulated MI_REPORT_TARGET_PGS
1395 if ((cdb
[1] & 0x1f) == MI_REPORT_TARGET_PGS
) {
1397 target_emulate_report_target_port_groups
;
1399 *size
= get_unaligned_be32(&cdb
[6]);
1402 * GPCMD_SEND_KEY from multi media commands
1404 *size
= get_unaligned_be16(&cdb
[8]);
1407 case MAINTENANCE_OUT
:
1408 if (dev
->transport
->get_device_type(dev
) != TYPE_ROM
) {
1410 * MAINTENANCE_OUT from SCC-2
1411 * Check for emulated MO_SET_TARGET_PGS.
1413 if (cdb
[1] == MO_SET_TARGET_PGS
) {
1415 target_emulate_set_target_port_groups
;
1417 *size
= get_unaligned_be32(&cdb
[6]);
1420 * GPCMD_SEND_KEY from multi media commands
1422 *size
= get_unaligned_be16(&cdb
[8]);
1426 pr_warn("TARGET_CORE[%s]: Unsupported SCSI Opcode"
1427 " 0x%02x, sending CHECK_CONDITION.\n",
1428 cmd
->se_tfo
->get_fabric_name(), cdb
[0]);
1429 return TCM_UNSUPPORTED_SCSI_OPCODE
;
1434 EXPORT_SYMBOL(spc_parse_cdb
);