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 transport supports VERIFY + PASS.
108 if (sess
->sup_prot_ops
& (TARGET_PROT_DIN_PASS
| TARGET_PROT_DOUT_PASS
)) {
109 if (dev
->dev_attrib
.pi_prot_type
)
113 buf
[7] = 0x2; /* CmdQue=1 */
115 memcpy(&buf
[8], "LIO-ORG ", 8);
116 memset(&buf
[16], 0x20, 16);
117 memcpy(&buf
[16], dev
->t10_wwn
.model
,
118 min_t(size_t, strlen(dev
->t10_wwn
.model
), 16));
119 memcpy(&buf
[32], dev
->t10_wwn
.revision
,
120 min_t(size_t, strlen(dev
->t10_wwn
.revision
), 4));
121 buf
[4] = 31; /* Set additional length to 31 */
125 EXPORT_SYMBOL(spc_emulate_inquiry_std
);
127 /* unit serial number */
128 static sense_reason_t
129 spc_emulate_evpd_80(struct se_cmd
*cmd
, unsigned char *buf
)
131 struct se_device
*dev
= cmd
->se_dev
;
134 if (dev
->dev_flags
& DF_EMULATED_VPD_UNIT_SERIAL
) {
135 len
= sprintf(&buf
[4], "%s", dev
->t10_wwn
.unit_serial
);
136 len
++; /* Extra Byte for NULL Terminator */
142 void spc_parse_naa_6h_vendor_specific(struct se_device
*dev
,
145 unsigned char *p
= &dev
->t10_wwn
.unit_serial
[0];
150 * Generate up to 36 bits of VENDOR SPECIFIC IDENTIFIER starting on
151 * byte 3 bit 3-0 for NAA IEEE Registered Extended DESIGNATOR field
152 * format, followed by 64 bits of VENDOR SPECIFIC IDENTIFIER EXTENSION
153 * to complete the payload. These are based from VPD=0x80 PRODUCT SERIAL
154 * NUMBER set via vpd_unit_serial in target_core_configfs.c to ensure
155 * per device uniqeness.
157 for (cnt
= 0; *p
&& cnt
< 13; p
++) {
158 int val
= hex_to_bin(*p
);
174 * Device identification VPD, for a complete list of
175 * DESIGNATOR TYPEs see spc4r17 Table 459.
178 spc_emulate_evpd_83(struct se_cmd
*cmd
, unsigned char *buf
)
180 struct se_device
*dev
= cmd
->se_dev
;
181 struct se_lun
*lun
= cmd
->se_lun
;
182 struct se_port
*port
= NULL
;
183 struct se_portal_group
*tpg
= NULL
;
184 struct t10_alua_lu_gp_member
*lu_gp_mem
;
185 struct t10_alua_tg_pt_gp
*tg_pt_gp
;
186 struct t10_alua_tg_pt_gp_member
*tg_pt_gp_mem
;
187 unsigned char *prod
= &dev
->t10_wwn
.model
[0];
189 u32 unit_serial_len
, off
= 0;
195 * NAA IEEE Registered Extended Assigned designator format, see
196 * spc4r17 section 7.7.3.6.5
198 * We depend upon a target_core_mod/ConfigFS provided
199 * /sys/kernel/config/target/core/$HBA/$DEV/wwn/vpd_unit_serial
200 * value in order to return the NAA id.
202 if (!(dev
->dev_flags
& DF_EMULATED_VPD_UNIT_SERIAL
))
203 goto check_t10_vend_desc
;
205 /* CODE SET == Binary */
208 /* Set ASSOCIATION == addressed logical unit: 0)b */
211 /* Identifier/Designator type == NAA identifier */
215 /* Identifier/Designator length */
219 * Start NAA IEEE Registered Extended Identifier/Designator
221 buf
[off
++] = (0x6 << 4);
224 * Use OpenFabrics IEEE Company ID: 00 14 05
228 buf
[off
] = (0x5 << 4);
231 * Return ConfigFS Unit Serial Number information for
232 * VENDOR_SPECIFIC_IDENTIFIER and
233 * VENDOR_SPECIFIC_IDENTIFIER_EXTENTION
235 spc_parse_naa_6h_vendor_specific(dev
, &buf
[off
]);
242 * T10 Vendor Identifier Page, see spc4r17 section 7.7.3.4
244 id_len
= 8; /* For Vendor field */
245 prod_len
= 4; /* For VPD Header */
246 prod_len
+= 8; /* For Vendor field */
247 prod_len
+= strlen(prod
);
248 prod_len
++; /* For : */
250 if (dev
->dev_flags
& DF_EMULATED_VPD_UNIT_SERIAL
) {
251 unit_serial_len
= strlen(&dev
->t10_wwn
.unit_serial
[0]);
252 unit_serial_len
++; /* For NULL Terminator */
254 id_len
+= sprintf(&buf
[off
+12], "%s:%s", prod
,
255 &dev
->t10_wwn
.unit_serial
[0]);
257 buf
[off
] = 0x2; /* ASCII */
258 buf
[off
+1] = 0x1; /* T10 Vendor ID */
260 memcpy(&buf
[off
+4], "LIO-ORG", 8);
261 /* Extra Byte for NULL Terminator */
263 /* Identifier Length */
265 /* Header size for Designation descriptor */
269 * struct se_port is only set for INQUIRY VPD=1 through $FABRIC_MOD
273 struct t10_alua_lu_gp
*lu_gp
;
274 u32 padding
, scsi_name_len
, scsi_target_len
;
281 * Relative target port identifer, see spc4r17
284 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
285 * section 7.5.1 Table 362
288 (tpg
->se_tpg_tfo
->get_fabric_proto_ident(tpg
) << 4);
289 buf
[off
++] |= 0x1; /* CODE SET == Binary */
290 buf
[off
] = 0x80; /* Set PIV=1 */
291 /* Set ASSOCIATION == target port: 01b */
293 /* DESIGNATOR TYPE == Relative target port identifer */
295 off
++; /* Skip over Reserved */
296 buf
[off
++] = 4; /* DESIGNATOR LENGTH */
297 /* Skip over Obsolete field in RTPI payload
300 buf
[off
++] = ((port
->sep_rtpi
>> 8) & 0xff);
301 buf
[off
++] = (port
->sep_rtpi
& 0xff);
302 len
+= 8; /* Header size + Designation descriptor */
304 * Target port group identifier, see spc4r17
307 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
308 * section 7.5.1 Table 362
310 tg_pt_gp_mem
= port
->sep_alua_tg_pt_gp_mem
;
314 spin_lock(&tg_pt_gp_mem
->tg_pt_gp_mem_lock
);
315 tg_pt_gp
= tg_pt_gp_mem
->tg_pt_gp
;
317 spin_unlock(&tg_pt_gp_mem
->tg_pt_gp_mem_lock
);
320 tg_pt_gp_id
= tg_pt_gp
->tg_pt_gp_id
;
321 spin_unlock(&tg_pt_gp_mem
->tg_pt_gp_mem_lock
);
324 (tpg
->se_tpg_tfo
->get_fabric_proto_ident(tpg
) << 4);
325 buf
[off
++] |= 0x1; /* CODE SET == Binary */
326 buf
[off
] = 0x80; /* Set PIV=1 */
327 /* Set ASSOCIATION == target port: 01b */
329 /* DESIGNATOR TYPE == Target port group identifier */
331 off
++; /* Skip over Reserved */
332 buf
[off
++] = 4; /* DESIGNATOR LENGTH */
333 off
+= 2; /* Skip over Reserved Field */
334 buf
[off
++] = ((tg_pt_gp_id
>> 8) & 0xff);
335 buf
[off
++] = (tg_pt_gp_id
& 0xff);
336 len
+= 8; /* Header size + Designation descriptor */
338 * Logical Unit Group identifier, see spc4r17
342 lu_gp_mem
= dev
->dev_alua_lu_gp_mem
;
344 goto check_scsi_name
;
346 spin_lock(&lu_gp_mem
->lu_gp_mem_lock
);
347 lu_gp
= lu_gp_mem
->lu_gp
;
349 spin_unlock(&lu_gp_mem
->lu_gp_mem_lock
);
350 goto check_scsi_name
;
352 lu_gp_id
= lu_gp
->lu_gp_id
;
353 spin_unlock(&lu_gp_mem
->lu_gp_mem_lock
);
355 buf
[off
++] |= 0x1; /* CODE SET == Binary */
356 /* DESIGNATOR TYPE == Logical Unit Group identifier */
358 off
++; /* Skip over Reserved */
359 buf
[off
++] = 4; /* DESIGNATOR LENGTH */
360 off
+= 2; /* Skip over Reserved Field */
361 buf
[off
++] = ((lu_gp_id
>> 8) & 0xff);
362 buf
[off
++] = (lu_gp_id
& 0xff);
363 len
+= 8; /* Header size + Designation descriptor */
365 * SCSI name string designator, see spc4r17
368 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
369 * section 7.5.1 Table 362
373 (tpg
->se_tpg_tfo
->get_fabric_proto_ident(tpg
) << 4);
374 buf
[off
++] |= 0x3; /* CODE SET == UTF-8 */
375 buf
[off
] = 0x80; /* Set PIV=1 */
376 /* Set ASSOCIATION == target port: 01b */
378 /* DESIGNATOR TYPE == SCSI name string */
380 off
+= 2; /* Skip over Reserved and length */
382 * SCSI name string identifer containing, $FABRIC_MOD
383 * dependent information. For LIO-Target and iSCSI
384 * Target Port, this means "<iSCSI name>,t,0x<TPGT> in
387 tpgt
= tpg
->se_tpg_tfo
->tpg_get_tag(tpg
);
388 scsi_name_len
= sprintf(&buf
[off
], "%s,t,0x%04x",
389 tpg
->se_tpg_tfo
->tpg_get_wwn(tpg
), tpgt
);
390 scsi_name_len
+= 1 /* Include NULL terminator */;
392 * The null-terminated, null-padded (see 4.4.2) SCSI
393 * NAME STRING field contains a UTF-8 format string.
394 * The number of bytes in the SCSI NAME STRING field
395 * (i.e., the value in the DESIGNATOR LENGTH field)
396 * shall be no larger than 256 and shall be a multiple
399 padding
= ((-scsi_name_len
) & 3);
401 scsi_name_len
+= padding
;
402 if (scsi_name_len
> 256)
405 buf
[off
-1] = scsi_name_len
;
406 off
+= scsi_name_len
;
407 /* Header size + Designation descriptor */
408 len
+= (scsi_name_len
+ 4);
411 * Target device designator
414 (tpg
->se_tpg_tfo
->get_fabric_proto_ident(tpg
) << 4);
415 buf
[off
++] |= 0x3; /* CODE SET == UTF-8 */
416 buf
[off
] = 0x80; /* Set PIV=1 */
417 /* Set ASSOCIATION == target device: 10b */
419 /* DESIGNATOR TYPE == SCSI name string */
421 off
+= 2; /* Skip over Reserved and length */
423 * SCSI name string identifer containing, $FABRIC_MOD
424 * dependent information. For LIO-Target and iSCSI
425 * Target Port, this means "<iSCSI name>" in
428 scsi_target_len
= sprintf(&buf
[off
], "%s",
429 tpg
->se_tpg_tfo
->tpg_get_wwn(tpg
));
430 scsi_target_len
+= 1 /* Include NULL terminator */;
432 * The null-terminated, null-padded (see 4.4.2) SCSI
433 * NAME STRING field contains a UTF-8 format string.
434 * The number of bytes in the SCSI NAME STRING field
435 * (i.e., the value in the DESIGNATOR LENGTH field)
436 * shall be no larger than 256 and shall be a multiple
439 padding
= ((-scsi_target_len
) & 3);
441 scsi_target_len
+= padding
;
442 if (scsi_target_len
> 256)
443 scsi_target_len
= 256;
445 buf
[off
-1] = scsi_target_len
;
446 off
+= scsi_target_len
;
448 /* Header size + Designation descriptor */
449 len
+= (scsi_target_len
+ 4);
451 buf
[2] = ((len
>> 8) & 0xff);
452 buf
[3] = (len
& 0xff); /* Page Length for VPD 0x83 */
455 EXPORT_SYMBOL(spc_emulate_evpd_83
);
457 /* Extended INQUIRY Data VPD Page */
458 static sense_reason_t
459 spc_emulate_evpd_86(struct se_cmd
*cmd
, unsigned char *buf
)
461 struct se_device
*dev
= cmd
->se_dev
;
462 struct se_session
*sess
= cmd
->se_sess
;
466 * Set GRD_CHK + REF_CHK for TYPE1 protection, or GRD_CHK
467 * only for TYPE3 protection.
469 if (sess
->sup_prot_ops
& (TARGET_PROT_DIN_PASS
| TARGET_PROT_DOUT_PASS
)) {
470 if (dev
->dev_attrib
.pi_prot_type
== TARGET_DIF_TYPE1_PROT
)
472 else if (dev
->dev_attrib
.pi_prot_type
== TARGET_DIF_TYPE3_PROT
)
476 /* Set HEADSUP, ORDSUP, SIMPSUP */
479 /* If WriteCache emulation is enabled, set V_SUP */
480 if (se_dev_check_wce(dev
))
482 /* If an LBA map is present set R_SUP */
483 spin_lock(&cmd
->se_dev
->t10_alua
.lba_map_lock
);
484 if (!list_empty(&dev
->t10_alua
.lba_map_list
))
486 spin_unlock(&cmd
->se_dev
->t10_alua
.lba_map_lock
);
490 /* Block Limits VPD page */
491 static sense_reason_t
492 spc_emulate_evpd_b0(struct se_cmd
*cmd
, unsigned char *buf
)
494 struct se_device
*dev
= cmd
->se_dev
;
499 * Following spc3r22 section 6.5.3 Block Limits VPD page, when
500 * emulate_tpu=1 or emulate_tpws=1 we will be expect a
501 * different page length for Thin Provisioning.
503 if (dev
->dev_attrib
.emulate_tpu
|| dev
->dev_attrib
.emulate_tpws
)
506 buf
[0] = dev
->transport
->get_device_type(dev
);
507 buf
[3] = have_tp
? 0x3c : 0x10;
512 * Set MAXIMUM COMPARE AND WRITE LENGTH
514 if (dev
->dev_attrib
.emulate_caw
)
518 * Set OPTIMAL TRANSFER LENGTH GRANULARITY
520 if (dev
->transport
->get_io_min
&& (min
= dev
->transport
->get_io_min(dev
)))
521 put_unaligned_be16(min
/ dev
->dev_attrib
.block_size
, &buf
[6]);
523 put_unaligned_be16(1, &buf
[6]);
526 * Set MAXIMUM TRANSFER LENGTH
528 put_unaligned_be32(dev
->dev_attrib
.hw_max_sectors
, &buf
[8]);
531 * Set OPTIMAL TRANSFER LENGTH
533 if (dev
->transport
->get_io_opt
&& (opt
= dev
->transport
->get_io_opt(dev
)))
534 put_unaligned_be32(opt
/ dev
->dev_attrib
.block_size
, &buf
[12]);
536 put_unaligned_be32(dev
->dev_attrib
.optimal_sectors
, &buf
[12]);
539 * Exit now if we don't support TP.
545 * Set MAXIMUM UNMAP LBA COUNT
547 put_unaligned_be32(dev
->dev_attrib
.max_unmap_lba_count
, &buf
[20]);
550 * Set MAXIMUM UNMAP BLOCK DESCRIPTOR COUNT
552 put_unaligned_be32(dev
->dev_attrib
.max_unmap_block_desc_count
,
556 * Set OPTIMAL UNMAP GRANULARITY
558 put_unaligned_be32(dev
->dev_attrib
.unmap_granularity
, &buf
[28]);
561 * UNMAP GRANULARITY ALIGNMENT
563 put_unaligned_be32(dev
->dev_attrib
.unmap_granularity_alignment
,
565 if (dev
->dev_attrib
.unmap_granularity_alignment
!= 0)
566 buf
[32] |= 0x80; /* Set the UGAVALID bit */
569 * MAXIMUM WRITE SAME LENGTH
572 put_unaligned_be64(dev
->dev_attrib
.max_write_same_len
, &buf
[36]);
577 /* Block Device Characteristics VPD page */
578 static sense_reason_t
579 spc_emulate_evpd_b1(struct se_cmd
*cmd
, unsigned char *buf
)
581 struct se_device
*dev
= cmd
->se_dev
;
583 buf
[0] = dev
->transport
->get_device_type(dev
);
585 buf
[5] = dev
->dev_attrib
.is_nonrot
? 1 : 0;
590 /* Thin Provisioning VPD */
591 static sense_reason_t
592 spc_emulate_evpd_b2(struct se_cmd
*cmd
, unsigned char *buf
)
594 struct se_device
*dev
= cmd
->se_dev
;
597 * From spc3r22 section 6.5.4 Thin Provisioning VPD page:
599 * The PAGE LENGTH field is defined in SPC-4. If the DP bit is set to
600 * zero, then the page length shall be set to 0004h. If the DP bit
601 * is set to one, then the page length shall be set to the value
602 * defined in table 162.
604 buf
[0] = dev
->transport
->get_device_type(dev
);
607 * Set Hardcoded length mentioned above for DP=0
609 put_unaligned_be16(0x0004, &buf
[2]);
612 * The THRESHOLD EXPONENT field indicates the threshold set size in
613 * LBAs as a power of 2 (i.e., the threshold set size is equal to
614 * 2(threshold exponent)).
616 * Note that this is currently set to 0x00 as mkp says it will be
617 * changing again. We can enable this once it has settled in T10
618 * and is actually used by Linux/SCSI ML code.
623 * A TPU bit set to one indicates that the device server supports
624 * the UNMAP command (see 5.25). A TPU bit set to zero indicates
625 * that the device server does not support the UNMAP command.
627 if (dev
->dev_attrib
.emulate_tpu
!= 0)
631 * A TPWS bit set to one indicates that the device server supports
632 * the use of the WRITE SAME (16) command (see 5.42) to unmap LBAs.
633 * A TPWS bit set to zero indicates that the device server does not
634 * support the use of the WRITE SAME (16) command to unmap LBAs.
636 if (dev
->dev_attrib
.emulate_tpws
!= 0)
637 buf
[5] |= 0x40 | 0x20;
642 /* Referrals VPD page */
643 static sense_reason_t
644 spc_emulate_evpd_b3(struct se_cmd
*cmd
, unsigned char *buf
)
646 struct se_device
*dev
= cmd
->se_dev
;
648 buf
[0] = dev
->transport
->get_device_type(dev
);
650 put_unaligned_be32(dev
->t10_alua
.lba_map_segment_size
, &buf
[8]);
651 put_unaligned_be32(dev
->t10_alua
.lba_map_segment_multiplier
, &buf
[12]);
656 static sense_reason_t
657 spc_emulate_evpd_00(struct se_cmd
*cmd
, unsigned char *buf
);
661 sense_reason_t (*emulate
)(struct se_cmd
*, unsigned char *);
662 } evpd_handlers
[] = {
663 { .page
= 0x00, .emulate
= spc_emulate_evpd_00
},
664 { .page
= 0x80, .emulate
= spc_emulate_evpd_80
},
665 { .page
= 0x83, .emulate
= spc_emulate_evpd_83
},
666 { .page
= 0x86, .emulate
= spc_emulate_evpd_86
},
667 { .page
= 0xb0, .emulate
= spc_emulate_evpd_b0
},
668 { .page
= 0xb1, .emulate
= spc_emulate_evpd_b1
},
669 { .page
= 0xb2, .emulate
= spc_emulate_evpd_b2
},
670 { .page
= 0xb3, .emulate
= spc_emulate_evpd_b3
},
673 /* supported vital product data pages */
674 static sense_reason_t
675 spc_emulate_evpd_00(struct se_cmd
*cmd
, unsigned char *buf
)
680 * Only report the INQUIRY EVPD=1 pages after a valid NAA
681 * Registered Extended LUN WWN has been set via ConfigFS
682 * during device creation/restart.
684 if (cmd
->se_dev
->dev_flags
& DF_EMULATED_VPD_UNIT_SERIAL
) {
685 buf
[3] = ARRAY_SIZE(evpd_handlers
);
686 for (p
= 0; p
< ARRAY_SIZE(evpd_handlers
); ++p
)
687 buf
[p
+ 4] = evpd_handlers
[p
].page
;
693 static sense_reason_t
694 spc_emulate_inquiry(struct se_cmd
*cmd
)
696 struct se_device
*dev
= cmd
->se_dev
;
697 struct se_portal_group
*tpg
= cmd
->se_lun
->lun_sep
->sep_tpg
;
699 unsigned char *cdb
= cmd
->t_task_cdb
;
705 buf
= kzalloc(SE_INQUIRY_BUF
, GFP_KERNEL
);
707 pr_err("Unable to allocate response buffer for INQUIRY\n");
708 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
711 if (dev
== tpg
->tpg_virt_lun0
.lun_se_dev
)
712 buf
[0] = 0x3f; /* Not connected */
714 buf
[0] = dev
->transport
->get_device_type(dev
);
716 if (!(cdb
[1] & 0x1)) {
718 pr_err("INQUIRY with EVPD==0 but PAGE CODE=%02x\n",
720 ret
= TCM_INVALID_CDB_FIELD
;
724 ret
= spc_emulate_inquiry_std(cmd
, buf
);
729 for (p
= 0; p
< ARRAY_SIZE(evpd_handlers
); ++p
) {
730 if (cdb
[2] == evpd_handlers
[p
].page
) {
732 ret
= evpd_handlers
[p
].emulate(cmd
, buf
);
733 len
= get_unaligned_be16(&buf
[2]) + 4;
738 pr_err("Unknown VPD Code: 0x%02x\n", cdb
[2]);
739 ret
= TCM_INVALID_CDB_FIELD
;
742 rbuf
= transport_kmap_data_sg(cmd
);
744 memcpy(rbuf
, buf
, min_t(u32
, SE_INQUIRY_BUF
, cmd
->data_length
));
745 transport_kunmap_data_sg(cmd
);
750 target_complete_cmd_with_length(cmd
, GOOD
, len
);
754 static int spc_modesense_rwrecovery(struct se_cmd
*cmd
, u8 pc
, u8
*p
)
759 /* No changeable values for now */
767 static int spc_modesense_control(struct se_cmd
*cmd
, u8 pc
, u8
*p
)
769 struct se_device
*dev
= cmd
->se_dev
;
770 struct se_session
*sess
= cmd
->se_sess
;
775 /* No changeable values for now */
781 * From spc4r23, 7.4.7 Control mode page
783 * The QUEUE ALGORITHM MODIFIER field (see table 368) specifies
784 * restrictions on the algorithm used for reordering commands
785 * having the SIMPLE task attribute (see SAM-4).
787 * Table 368 -- QUEUE ALGORITHM MODIFIER field
789 * 0h Restricted reordering
790 * 1h Unrestricted reordering allowed
792 * 8h to Fh Vendor specific
794 * A value of zero in the QUEUE ALGORITHM MODIFIER field specifies that
795 * the device server shall order the processing sequence of commands
796 * having the SIMPLE task attribute such that data integrity is maintained
797 * for that I_T nexus (i.e., if the transmission of new SCSI transport protocol
798 * requests is halted at any time, the final value of all data observable
799 * on the medium shall be the same as if all the commands had been processed
800 * with the ORDERED task attribute).
802 * A value of one in the QUEUE ALGORITHM MODIFIER field specifies that the
803 * device server may reorder the processing sequence of commands having the
804 * SIMPLE task attribute in any manner. Any data integrity exposures related to
805 * command sequence order shall be explicitly handled by the application client
806 * through the selection of appropriate ommands and task attributes.
808 p
[3] = (dev
->dev_attrib
.emulate_rest_reord
== 1) ? 0x00 : 0x10;
810 * From spc4r17, section 7.4.6 Control mode Page
812 * Unit Attention interlocks control (UN_INTLCK_CTRL) to code 00b
814 * 00b: The logical unit shall clear any unit attention condition
815 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
816 * status and shall not establish a unit attention condition when a com-
817 * mand is completed with BUSY, TASK SET FULL, or RESERVATION CONFLICT
820 * 10b: The logical unit shall not clear any unit attention condition
821 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
822 * status and shall not establish a unit attention condition when
823 * a command is completed with BUSY, TASK SET FULL, or RESERVATION
826 * 11b a The logical unit shall not clear any unit attention condition
827 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
828 * status and shall establish a unit attention condition for the
829 * initiator port associated with the I_T nexus on which the BUSY,
830 * TASK SET FULL, or RESERVATION CONFLICT status is being returned.
831 * Depending on the status, the additional sense code shall be set to
832 * PREVIOUS BUSY STATUS, PREVIOUS TASK SET FULL STATUS, or PREVIOUS
833 * RESERVATION CONFLICT STATUS. Until it is cleared by a REQUEST SENSE
834 * command, a unit attention condition shall be established only once
835 * for a BUSY, TASK SET FULL, or RESERVATION CONFLICT status regardless
836 * to the number of commands completed with one of those status codes.
838 p
[4] = (dev
->dev_attrib
.emulate_ua_intlck_ctrl
== 2) ? 0x30 :
839 (dev
->dev_attrib
.emulate_ua_intlck_ctrl
== 1) ? 0x20 : 0x00;
841 * From spc4r17, section 7.4.6 Control mode Page
843 * Task Aborted Status (TAS) bit set to zero.
845 * A task aborted status (TAS) bit set to zero specifies that aborted
846 * tasks shall be terminated by the device server without any response
847 * to the application client. A TAS bit set to one specifies that tasks
848 * aborted by the actions of an I_T nexus other than the I_T nexus on
849 * which the command was received shall be completed with TASK ABORTED
850 * status (see SAM-4).
852 p
[5] = (dev
->dev_attrib
.emulate_tas
) ? 0x40 : 0x00;
854 * From spc4r30, section 7.5.7 Control mode page
856 * Application Tag Owner (ATO) bit set to one.
858 * If the ATO bit is set to one the device server shall not modify the
859 * LOGICAL BLOCK APPLICATION TAG field and, depending on the protection
860 * type, shall not modify the contents of the LOGICAL BLOCK REFERENCE
863 if (sess
->sup_prot_ops
& (TARGET_PROT_DIN_PASS
| TARGET_PROT_DOUT_PASS
)) {
864 if (dev
->dev_attrib
.pi_prot_type
)
876 static int spc_modesense_caching(struct se_cmd
*cmd
, u8 pc
, u8
*p
)
878 struct se_device
*dev
= cmd
->se_dev
;
883 /* No changeable values for now */
887 if (se_dev_check_wce(dev
))
888 p
[2] = 0x04; /* Write Cache Enable */
889 p
[12] = 0x20; /* Disabled Read Ahead */
895 static int spc_modesense_informational_exceptions(struct se_cmd
*cmd
, u8 pc
, unsigned char *p
)
900 /* No changeable values for now */
911 int (*emulate
)(struct se_cmd
*, u8
, unsigned char *);
912 } modesense_handlers
[] = {
913 { .page
= 0x01, .subpage
= 0x00, .emulate
= spc_modesense_rwrecovery
},
914 { .page
= 0x08, .subpage
= 0x00, .emulate
= spc_modesense_caching
},
915 { .page
= 0x0a, .subpage
= 0x00, .emulate
= spc_modesense_control
},
916 { .page
= 0x1c, .subpage
= 0x00, .emulate
= spc_modesense_informational_exceptions
},
919 static void spc_modesense_write_protect(unsigned char *buf
, int type
)
922 * I believe that the WP bit (bit 7) in the mode header is the same for
929 buf
[0] |= 0x80; /* WP bit */
934 static void spc_modesense_dpofua(unsigned char *buf
, int type
)
938 buf
[0] |= 0x10; /* DPOFUA bit */
945 static int spc_modesense_blockdesc(unsigned char *buf
, u64 blocks
, u32 block_size
)
948 put_unaligned_be32(min(blocks
, 0xffffffffull
), buf
);
950 put_unaligned_be32(block_size
, buf
);
954 static int spc_modesense_long_blockdesc(unsigned char *buf
, u64 blocks
, u32 block_size
)
956 if (blocks
<= 0xffffffff)
957 return spc_modesense_blockdesc(buf
+ 3, blocks
, block_size
) + 3;
959 *buf
++ = 1; /* LONGLBA */
962 put_unaligned_be64(blocks
, buf
);
964 put_unaligned_be32(block_size
, buf
);
969 static sense_reason_t
spc_emulate_modesense(struct se_cmd
*cmd
)
971 struct se_device
*dev
= cmd
->se_dev
;
972 char *cdb
= cmd
->t_task_cdb
;
973 unsigned char buf
[SE_MODE_PAGE_BUF
], *rbuf
;
974 int type
= dev
->transport
->get_device_type(dev
);
975 int ten
= (cmd
->t_task_cdb
[0] == MODE_SENSE_10
);
976 bool dbd
= !!(cdb
[1] & 0x08);
977 bool llba
= ten
? !!(cdb
[1] & 0x10) : false;
979 u8 page
= cdb
[2] & 0x3f;
985 memset(buf
, 0, SE_MODE_PAGE_BUF
);
988 * Skip over MODE DATA LENGTH + MEDIUM TYPE fields to byte 3 for
989 * MODE_SENSE_10 and byte 2 for MODE_SENSE (6).
991 length
= ten
? 3 : 2;
993 /* DEVICE-SPECIFIC PARAMETER */
994 if ((cmd
->se_lun
->lun_access
& TRANSPORT_LUNFLAGS_READ_ONLY
) ||
996 (cmd
->se_deve
->lun_flags
& TRANSPORT_LUNFLAGS_READ_ONLY
)))
997 spc_modesense_write_protect(&buf
[length
], type
);
999 if ((se_dev_check_wce(dev
)) &&
1000 (dev
->dev_attrib
.emulate_fua_write
> 0))
1001 spc_modesense_dpofua(&buf
[length
], type
);
1005 /* BLOCK DESCRIPTOR */
1008 * For now we only include a block descriptor for disk (SBC)
1009 * devices; other command sets use a slightly different format.
1011 if (!dbd
&& type
== TYPE_DISK
) {
1012 u64 blocks
= dev
->transport
->get_blocks(dev
);
1013 u32 block_size
= dev
->dev_attrib
.block_size
;
1017 length
+= spc_modesense_long_blockdesc(&buf
[length
],
1018 blocks
, block_size
);
1021 length
+= spc_modesense_blockdesc(&buf
[length
],
1022 blocks
, block_size
);
1025 length
+= spc_modesense_blockdesc(&buf
[length
], blocks
,
1036 if (subpage
!= 0x00 && subpage
!= 0xff) {
1037 pr_warn("MODE_SENSE: Invalid subpage code: 0x%02x\n", subpage
);
1038 return TCM_INVALID_CDB_FIELD
;
1041 for (i
= 0; i
< ARRAY_SIZE(modesense_handlers
); ++i
) {
1043 * Tricky way to say all subpage 00h for
1044 * subpage==0, all subpages for subpage==0xff
1045 * (and we just checked above that those are
1046 * the only two possibilities).
1048 if ((modesense_handlers
[i
].subpage
& ~subpage
) == 0) {
1049 ret
= modesense_handlers
[i
].emulate(cmd
, pc
, &buf
[length
]);
1050 if (!ten
&& length
+ ret
>= 255)
1059 for (i
= 0; i
< ARRAY_SIZE(modesense_handlers
); ++i
)
1060 if (modesense_handlers
[i
].page
== page
&&
1061 modesense_handlers
[i
].subpage
== subpage
) {
1062 length
+= modesense_handlers
[i
].emulate(cmd
, pc
, &buf
[length
]);
1067 * We don't intend to implement:
1068 * - obsolete page 03h "format parameters" (checked by Solaris)
1071 pr_err("MODE SENSE: unimplemented page/subpage: 0x%02x/0x%02x\n",
1074 return TCM_UNKNOWN_MODE_PAGE
;
1078 put_unaligned_be16(length
- 2, buf
);
1080 buf
[0] = length
- 1;
1082 rbuf
= transport_kmap_data_sg(cmd
);
1084 memcpy(rbuf
, buf
, min_t(u32
, SE_MODE_PAGE_BUF
, cmd
->data_length
));
1085 transport_kunmap_data_sg(cmd
);
1088 target_complete_cmd_with_length(cmd
, GOOD
, length
);
1092 static sense_reason_t
spc_emulate_modeselect(struct se_cmd
*cmd
)
1094 char *cdb
= cmd
->t_task_cdb
;
1095 bool ten
= cdb
[0] == MODE_SELECT_10
;
1096 int off
= ten
? 8 : 4;
1097 bool pf
= !!(cdb
[1] & 0x10);
1100 unsigned char tbuf
[SE_MODE_PAGE_BUF
];
1105 if (!cmd
->data_length
) {
1106 target_complete_cmd(cmd
, GOOD
);
1110 if (cmd
->data_length
< off
+ 2)
1111 return TCM_PARAMETER_LIST_LENGTH_ERROR
;
1113 buf
= transport_kmap_data_sg(cmd
);
1115 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1118 ret
= TCM_INVALID_CDB_FIELD
;
1122 page
= buf
[off
] & 0x3f;
1123 subpage
= buf
[off
] & 0x40 ? buf
[off
+ 1] : 0;
1125 for (i
= 0; i
< ARRAY_SIZE(modesense_handlers
); ++i
)
1126 if (modesense_handlers
[i
].page
== page
&&
1127 modesense_handlers
[i
].subpage
== subpage
) {
1128 memset(tbuf
, 0, SE_MODE_PAGE_BUF
);
1129 length
= modesense_handlers
[i
].emulate(cmd
, 0, tbuf
);
1130 goto check_contents
;
1133 ret
= TCM_UNKNOWN_MODE_PAGE
;
1137 if (cmd
->data_length
< off
+ length
) {
1138 ret
= TCM_PARAMETER_LIST_LENGTH_ERROR
;
1142 if (memcmp(buf
+ off
, tbuf
, length
))
1143 ret
= TCM_INVALID_PARAMETER_LIST
;
1146 transport_kunmap_data_sg(cmd
);
1149 target_complete_cmd(cmd
, GOOD
);
1153 static sense_reason_t
spc_emulate_request_sense(struct se_cmd
*cmd
)
1155 unsigned char *cdb
= cmd
->t_task_cdb
;
1156 unsigned char *rbuf
;
1157 u8 ua_asc
= 0, ua_ascq
= 0;
1158 unsigned char buf
[SE_SENSE_BUF
];
1160 memset(buf
, 0, SE_SENSE_BUF
);
1162 if (cdb
[1] & 0x01) {
1163 pr_err("REQUEST_SENSE description emulation not"
1165 return TCM_INVALID_CDB_FIELD
;
1168 rbuf
= transport_kmap_data_sg(cmd
);
1170 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1172 if (!core_scsi3_ua_clear_for_request_sense(cmd
, &ua_asc
, &ua_ascq
)) {
1174 * CURRENT ERROR, UNIT ATTENTION
1177 buf
[SPC_SENSE_KEY_OFFSET
] = UNIT_ATTENTION
;
1180 * The Additional Sense Code (ASC) from the UNIT ATTENTION
1182 buf
[SPC_ASC_KEY_OFFSET
] = ua_asc
;
1183 buf
[SPC_ASCQ_KEY_OFFSET
] = ua_ascq
;
1187 * CURRENT ERROR, NO SENSE
1190 buf
[SPC_SENSE_KEY_OFFSET
] = NO_SENSE
;
1193 * NO ADDITIONAL SENSE INFORMATION
1195 buf
[SPC_ASC_KEY_OFFSET
] = 0x00;
1199 memcpy(rbuf
, buf
, min_t(u32
, sizeof(buf
), cmd
->data_length
));
1200 transport_kunmap_data_sg(cmd
);
1202 target_complete_cmd(cmd
, GOOD
);
1206 sense_reason_t
spc_emulate_report_luns(struct se_cmd
*cmd
)
1208 struct se_dev_entry
*deve
;
1209 struct se_session
*sess
= cmd
->se_sess
;
1211 u32 lun_count
= 0, offset
= 8, i
;
1213 if (cmd
->data_length
< 16) {
1214 pr_warn("REPORT LUNS allocation length %u too small\n",
1216 return TCM_INVALID_CDB_FIELD
;
1219 buf
= transport_kmap_data_sg(cmd
);
1221 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1224 * If no struct se_session pointer is present, this struct se_cmd is
1225 * coming via a target_core_mod PASSTHROUGH op, and not through
1226 * a $FABRIC_MOD. In that case, report LUN=0 only.
1229 int_to_scsilun(0, (struct scsi_lun
*)&buf
[offset
]);
1234 spin_lock_irq(&sess
->se_node_acl
->device_list_lock
);
1235 for (i
= 0; i
< TRANSPORT_MAX_LUNS_PER_TPG
; i
++) {
1236 deve
= sess
->se_node_acl
->device_list
[i
];
1237 if (!(deve
->lun_flags
& TRANSPORT_LUNFLAGS_INITIATOR_ACCESS
))
1240 * We determine the correct LUN LIST LENGTH even once we
1241 * have reached the initial allocation length.
1242 * See SPC2-R20 7.19.
1245 if ((offset
+ 8) > cmd
->data_length
)
1248 int_to_scsilun(deve
->mapped_lun
, (struct scsi_lun
*)&buf
[offset
]);
1251 spin_unlock_irq(&sess
->se_node_acl
->device_list_lock
);
1254 * See SPC3 r07, page 159.
1258 buf
[0] = ((lun_count
>> 24) & 0xff);
1259 buf
[1] = ((lun_count
>> 16) & 0xff);
1260 buf
[2] = ((lun_count
>> 8) & 0xff);
1261 buf
[3] = (lun_count
& 0xff);
1262 transport_kunmap_data_sg(cmd
);
1264 target_complete_cmd_with_length(cmd
, GOOD
, 8 + lun_count
* 8);
1267 EXPORT_SYMBOL(spc_emulate_report_luns
);
1269 static sense_reason_t
1270 spc_emulate_testunitready(struct se_cmd
*cmd
)
1272 target_complete_cmd(cmd
, GOOD
);
1277 spc_parse_cdb(struct se_cmd
*cmd
, unsigned int *size
)
1279 struct se_device
*dev
= cmd
->se_dev
;
1280 unsigned char *cdb
= cmd
->t_task_cdb
;
1285 cmd
->execute_cmd
= spc_emulate_modeselect
;
1287 case MODE_SELECT_10
:
1288 *size
= (cdb
[7] << 8) + cdb
[8];
1289 cmd
->execute_cmd
= spc_emulate_modeselect
;
1293 cmd
->execute_cmd
= spc_emulate_modesense
;
1296 *size
= (cdb
[7] << 8) + cdb
[8];
1297 cmd
->execute_cmd
= spc_emulate_modesense
;
1301 *size
= (cdb
[7] << 8) + cdb
[8];
1303 case PERSISTENT_RESERVE_IN
:
1304 *size
= (cdb
[7] << 8) + cdb
[8];
1305 cmd
->execute_cmd
= target_scsi3_emulate_pr_in
;
1307 case PERSISTENT_RESERVE_OUT
:
1308 *size
= (cdb
[7] << 8) + cdb
[8];
1309 cmd
->execute_cmd
= target_scsi3_emulate_pr_out
;
1313 if (cdb
[0] == RELEASE_10
)
1314 *size
= (cdb
[7] << 8) | cdb
[8];
1316 *size
= cmd
->data_length
;
1318 cmd
->execute_cmd
= target_scsi2_reservation_release
;
1323 * The SPC-2 RESERVE does not contain a size in the SCSI CDB.
1324 * Assume the passthrough or $FABRIC_MOD will tell us about it.
1326 if (cdb
[0] == RESERVE_10
)
1327 *size
= (cdb
[7] << 8) | cdb
[8];
1329 *size
= cmd
->data_length
;
1331 cmd
->execute_cmd
= target_scsi2_reservation_reserve
;
1335 cmd
->execute_cmd
= spc_emulate_request_sense
;
1338 *size
= (cdb
[3] << 8) + cdb
[4];
1341 * Do implicit HEAD_OF_QUEUE processing for INQUIRY.
1342 * See spc4r17 section 5.3
1344 cmd
->sam_task_attr
= TCM_HEAD_TAG
;
1345 cmd
->execute_cmd
= spc_emulate_inquiry
;
1347 case SECURITY_PROTOCOL_IN
:
1348 case SECURITY_PROTOCOL_OUT
:
1349 *size
= (cdb
[6] << 24) | (cdb
[7] << 16) | (cdb
[8] << 8) | cdb
[9];
1352 *size
= get_unaligned_be32(&cdb
[10]);
1353 cmd
->execute_cmd
= target_do_xcopy
;
1355 case RECEIVE_COPY_RESULTS
:
1356 *size
= get_unaligned_be32(&cdb
[10]);
1357 cmd
->execute_cmd
= target_do_receive_copy_results
;
1359 case READ_ATTRIBUTE
:
1360 case WRITE_ATTRIBUTE
:
1361 *size
= (cdb
[10] << 24) | (cdb
[11] << 16) |
1362 (cdb
[12] << 8) | cdb
[13];
1364 case RECEIVE_DIAGNOSTIC
:
1365 case SEND_DIAGNOSTIC
:
1366 *size
= (cdb
[3] << 8) | cdb
[4];
1369 *size
= (cdb
[6] << 16) + (cdb
[7] << 8) + cdb
[8];
1372 cmd
->execute_cmd
= spc_emulate_report_luns
;
1373 *size
= (cdb
[6] << 24) | (cdb
[7] << 16) | (cdb
[8] << 8) | cdb
[9];
1375 * Do implicit HEAD_OF_QUEUE processing for REPORT_LUNS
1376 * See spc4r17 section 5.3
1378 cmd
->sam_task_attr
= TCM_HEAD_TAG
;
1380 case TEST_UNIT_READY
:
1381 cmd
->execute_cmd
= spc_emulate_testunitready
;
1384 case MAINTENANCE_IN
:
1385 if (dev
->transport
->get_device_type(dev
) != TYPE_ROM
) {
1387 * MAINTENANCE_IN from SCC-2
1388 * Check for emulated MI_REPORT_TARGET_PGS
1390 if ((cdb
[1] & 0x1f) == MI_REPORT_TARGET_PGS
) {
1392 target_emulate_report_target_port_groups
;
1394 *size
= get_unaligned_be32(&cdb
[6]);
1397 * GPCMD_SEND_KEY from multi media commands
1399 *size
= get_unaligned_be16(&cdb
[8]);
1402 case MAINTENANCE_OUT
:
1403 if (dev
->transport
->get_device_type(dev
) != TYPE_ROM
) {
1405 * MAINTENANCE_OUT from SCC-2
1406 * Check for emulated MO_SET_TARGET_PGS.
1408 if (cdb
[1] == MO_SET_TARGET_PGS
) {
1410 target_emulate_set_target_port_groups
;
1412 *size
= get_unaligned_be32(&cdb
[6]);
1415 * GPCMD_SEND_KEY from multi media commands
1417 *size
= get_unaligned_be16(&cdb
[8]);
1421 pr_warn("TARGET_CORE[%s]: Unsupported SCSI Opcode"
1422 " 0x%02x, sending CHECK_CONDITION.\n",
1423 cmd
->se_tfo
->get_fabric_name(), cdb
[0]);
1424 return TCM_UNSUPPORTED_SCSI_OPCODE
;
1429 EXPORT_SYMBOL(spc_parse_cdb
);