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_lun
*lun
, unsigned char *buf
)
43 struct t10_alua_tg_pt_gp
*tg_pt_gp
;
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
56 spin_lock(&lun
->lun_tg_pt_gp_lock
);
57 tg_pt_gp
= lun
->lun_tg_pt_gp
;
59 buf
[5] |= tg_pt_gp
->tg_pt_gp_alua_access_type
;
60 spin_unlock(&lun
->lun_tg_pt_gp_lock
);
64 spc_emulate_inquiry_std(struct se_cmd
*cmd
, unsigned char *buf
)
66 struct se_lun
*lun
= cmd
->se_lun
;
67 struct se_device
*dev
= cmd
->se_dev
;
68 struct se_session
*sess
= cmd
->se_sess
;
70 /* Set RMB (removable media) for tape devices */
71 if (dev
->transport
->get_device_type(dev
) == TYPE_TAPE
)
74 buf
[2] = 0x05; /* SPC-3 */
77 * NORMACA and HISUP = 0, RESPONSE DATA FORMAT = 2
80 * A RESPONSE DATA FORMAT field set to 2h indicates that the
81 * standard INQUIRY data is in the format defined in this
82 * standard. Response data format values less than 2h are
83 * obsolete. Response data format values greater than 2h are
89 * Enable SCCS and TPGS fields for Emulated ALUA
91 spc_fill_alua_data(lun
, buf
);
94 * Set Third-Party Copy (3PC) bit to indicate support for EXTENDED_COPY
96 if (dev
->dev_attrib
.emulate_3pc
)
99 * Set Protection (PROTECT) bit when DIF has been enabled on the
100 * device, and the fabric supports VERIFY + PASS. Also report
101 * PROTECT=1 if sess_prot_type has been configured to allow T10-PI
102 * to unprotected devices.
104 if (sess
->sup_prot_ops
& (TARGET_PROT_DIN_PASS
| TARGET_PROT_DOUT_PASS
)) {
105 if (dev
->dev_attrib
.pi_prot_type
|| cmd
->se_sess
->sess_prot_type
)
109 buf
[7] = 0x2; /* CmdQue=1 */
111 memcpy(&buf
[8], "LIO-ORG ", 8);
112 memset(&buf
[16], 0x20, 16);
113 memcpy(&buf
[16], dev
->t10_wwn
.model
,
114 min_t(size_t, strlen(dev
->t10_wwn
.model
), 16));
115 memcpy(&buf
[32], dev
->t10_wwn
.revision
,
116 min_t(size_t, strlen(dev
->t10_wwn
.revision
), 4));
117 buf
[4] = 31; /* Set additional length to 31 */
121 EXPORT_SYMBOL(spc_emulate_inquiry_std
);
123 /* unit serial number */
124 static sense_reason_t
125 spc_emulate_evpd_80(struct se_cmd
*cmd
, unsigned char *buf
)
127 struct se_device
*dev
= cmd
->se_dev
;
130 if (dev
->dev_flags
& DF_EMULATED_VPD_UNIT_SERIAL
) {
131 len
= sprintf(&buf
[4], "%s", dev
->t10_wwn
.unit_serial
);
132 len
++; /* Extra Byte for NULL Terminator */
138 void spc_parse_naa_6h_vendor_specific(struct se_device
*dev
,
141 unsigned char *p
= &dev
->t10_wwn
.unit_serial
[0];
146 * Generate up to 36 bits of VENDOR SPECIFIC IDENTIFIER starting on
147 * byte 3 bit 3-0 for NAA IEEE Registered Extended DESIGNATOR field
148 * format, followed by 64 bits of VENDOR SPECIFIC IDENTIFIER EXTENSION
149 * to complete the payload. These are based from VPD=0x80 PRODUCT SERIAL
150 * NUMBER set via vpd_unit_serial in target_core_configfs.c to ensure
151 * per device uniqeness.
153 for (cnt
= 0; *p
&& cnt
< 13; p
++) {
154 int val
= hex_to_bin(*p
);
170 * Device identification VPD, for a complete list of
171 * DESIGNATOR TYPEs see spc4r17 Table 459.
174 spc_emulate_evpd_83(struct se_cmd
*cmd
, unsigned char *buf
)
176 struct se_device
*dev
= cmd
->se_dev
;
177 struct se_lun
*lun
= cmd
->se_lun
;
178 struct se_portal_group
*tpg
= NULL
;
179 struct t10_alua_lu_gp_member
*lu_gp_mem
;
180 struct t10_alua_tg_pt_gp
*tg_pt_gp
;
181 unsigned char *prod
= &dev
->t10_wwn
.model
[0];
183 u32 unit_serial_len
, off
= 0;
189 * NAA IEEE Registered Extended Assigned designator format, see
190 * spc4r17 section 7.7.3.6.5
192 * We depend upon a target_core_mod/ConfigFS provided
193 * /sys/kernel/config/target/core/$HBA/$DEV/wwn/vpd_unit_serial
194 * value in order to return the NAA id.
196 if (!(dev
->dev_flags
& DF_EMULATED_VPD_UNIT_SERIAL
))
197 goto check_t10_vend_desc
;
199 /* CODE SET == Binary */
202 /* Set ASSOCIATION == addressed logical unit: 0)b */
205 /* Identifier/Designator type == NAA identifier */
209 /* Identifier/Designator length */
213 * Start NAA IEEE Registered Extended Identifier/Designator
215 buf
[off
++] = (0x6 << 4);
218 * Use OpenFabrics IEEE Company ID: 00 14 05
222 buf
[off
] = (0x5 << 4);
225 * Return ConfigFS Unit Serial Number information for
226 * VENDOR_SPECIFIC_IDENTIFIER and
227 * VENDOR_SPECIFIC_IDENTIFIER_EXTENTION
229 spc_parse_naa_6h_vendor_specific(dev
, &buf
[off
]);
236 * T10 Vendor Identifier Page, see spc4r17 section 7.7.3.4
238 id_len
= 8; /* For Vendor field */
239 prod_len
= 4; /* For VPD Header */
240 prod_len
+= 8; /* For Vendor field */
241 prod_len
+= strlen(prod
);
242 prod_len
++; /* For : */
244 if (dev
->dev_flags
& DF_EMULATED_VPD_UNIT_SERIAL
) {
245 unit_serial_len
= strlen(&dev
->t10_wwn
.unit_serial
[0]);
246 unit_serial_len
++; /* For NULL Terminator */
248 id_len
+= sprintf(&buf
[off
+12], "%s:%s", prod
,
249 &dev
->t10_wwn
.unit_serial
[0]);
251 buf
[off
] = 0x2; /* ASCII */
252 buf
[off
+1] = 0x1; /* T10 Vendor ID */
254 memcpy(&buf
[off
+4], "LIO-ORG", 8);
255 /* Extra Byte for NULL Terminator */
257 /* Identifier Length */
259 /* Header size for Designation descriptor */
264 struct t10_alua_lu_gp
*lu_gp
;
265 u32 padding
, scsi_name_len
, scsi_target_len
;
272 * Relative target port identifer, see spc4r17
275 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
276 * section 7.5.1 Table 362
278 buf
[off
] = tpg
->proto_id
<< 4;
279 buf
[off
++] |= 0x1; /* CODE SET == Binary */
280 buf
[off
] = 0x80; /* Set PIV=1 */
281 /* Set ASSOCIATION == target port: 01b */
283 /* DESIGNATOR TYPE == Relative target port identifer */
285 off
++; /* Skip over Reserved */
286 buf
[off
++] = 4; /* DESIGNATOR LENGTH */
287 /* Skip over Obsolete field in RTPI payload
290 buf
[off
++] = ((lun
->lun_rtpi
>> 8) & 0xff);
291 buf
[off
++] = (lun
->lun_rtpi
& 0xff);
292 len
+= 8; /* Header size + Designation descriptor */
294 * Target port group identifier, see spc4r17
297 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
298 * section 7.5.1 Table 362
300 spin_lock(&lun
->lun_tg_pt_gp_lock
);
301 tg_pt_gp
= lun
->lun_tg_pt_gp
;
303 spin_unlock(&lun
->lun_tg_pt_gp_lock
);
306 tg_pt_gp_id
= tg_pt_gp
->tg_pt_gp_id
;
307 spin_unlock(&lun
->lun_tg_pt_gp_lock
);
309 buf
[off
] = tpg
->proto_id
<< 4;
310 buf
[off
++] |= 0x1; /* CODE SET == Binary */
311 buf
[off
] = 0x80; /* Set PIV=1 */
312 /* Set ASSOCIATION == target port: 01b */
314 /* DESIGNATOR TYPE == Target port group identifier */
316 off
++; /* Skip over Reserved */
317 buf
[off
++] = 4; /* DESIGNATOR LENGTH */
318 off
+= 2; /* Skip over Reserved Field */
319 buf
[off
++] = ((tg_pt_gp_id
>> 8) & 0xff);
320 buf
[off
++] = (tg_pt_gp_id
& 0xff);
321 len
+= 8; /* Header size + Designation descriptor */
323 * Logical Unit Group identifier, see spc4r17
327 lu_gp_mem
= dev
->dev_alua_lu_gp_mem
;
329 goto check_scsi_name
;
331 spin_lock(&lu_gp_mem
->lu_gp_mem_lock
);
332 lu_gp
= lu_gp_mem
->lu_gp
;
334 spin_unlock(&lu_gp_mem
->lu_gp_mem_lock
);
335 goto check_scsi_name
;
337 lu_gp_id
= lu_gp
->lu_gp_id
;
338 spin_unlock(&lu_gp_mem
->lu_gp_mem_lock
);
340 buf
[off
++] |= 0x1; /* CODE SET == Binary */
341 /* DESIGNATOR TYPE == Logical Unit Group identifier */
343 off
++; /* Skip over Reserved */
344 buf
[off
++] = 4; /* DESIGNATOR LENGTH */
345 off
+= 2; /* Skip over Reserved Field */
346 buf
[off
++] = ((lu_gp_id
>> 8) & 0xff);
347 buf
[off
++] = (lu_gp_id
& 0xff);
348 len
+= 8; /* Header size + Designation descriptor */
350 * SCSI name string designator, see spc4r17
353 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
354 * section 7.5.1 Table 362
357 buf
[off
] = tpg
->proto_id
<< 4;
358 buf
[off
++] |= 0x3; /* CODE SET == UTF-8 */
359 buf
[off
] = 0x80; /* Set PIV=1 */
360 /* Set ASSOCIATION == target port: 01b */
362 /* DESIGNATOR TYPE == SCSI name string */
364 off
+= 2; /* Skip over Reserved and length */
366 * SCSI name string identifer containing, $FABRIC_MOD
367 * dependent information. For LIO-Target and iSCSI
368 * Target Port, this means "<iSCSI name>,t,0x<TPGT> in
371 tpgt
= tpg
->se_tpg_tfo
->tpg_get_tag(tpg
);
372 scsi_name_len
= sprintf(&buf
[off
], "%s,t,0x%04x",
373 tpg
->se_tpg_tfo
->tpg_get_wwn(tpg
), tpgt
);
374 scsi_name_len
+= 1 /* Include NULL terminator */;
376 * The null-terminated, null-padded (see 4.4.2) SCSI
377 * NAME STRING field contains a UTF-8 format string.
378 * The number of bytes in the SCSI NAME STRING field
379 * (i.e., the value in the DESIGNATOR LENGTH field)
380 * shall be no larger than 256 and shall be a multiple
383 padding
= ((-scsi_name_len
) & 3);
385 scsi_name_len
+= padding
;
386 if (scsi_name_len
> 256)
389 buf
[off
-1] = scsi_name_len
;
390 off
+= scsi_name_len
;
391 /* Header size + Designation descriptor */
392 len
+= (scsi_name_len
+ 4);
395 * Target device designator
397 buf
[off
] = tpg
->proto_id
<< 4;
398 buf
[off
++] |= 0x3; /* CODE SET == UTF-8 */
399 buf
[off
] = 0x80; /* Set PIV=1 */
400 /* Set ASSOCIATION == target device: 10b */
402 /* DESIGNATOR TYPE == SCSI name string */
404 off
+= 2; /* Skip over Reserved and length */
406 * SCSI name string identifer containing, $FABRIC_MOD
407 * dependent information. For LIO-Target and iSCSI
408 * Target Port, this means "<iSCSI name>" in
411 scsi_target_len
= sprintf(&buf
[off
], "%s",
412 tpg
->se_tpg_tfo
->tpg_get_wwn(tpg
));
413 scsi_target_len
+= 1 /* Include NULL terminator */;
415 * The null-terminated, null-padded (see 4.4.2) SCSI
416 * NAME STRING field contains a UTF-8 format string.
417 * The number of bytes in the SCSI NAME STRING field
418 * (i.e., the value in the DESIGNATOR LENGTH field)
419 * shall be no larger than 256 and shall be a multiple
422 padding
= ((-scsi_target_len
) & 3);
424 scsi_target_len
+= padding
;
425 if (scsi_target_len
> 256)
426 scsi_target_len
= 256;
428 buf
[off
-1] = scsi_target_len
;
429 off
+= scsi_target_len
;
431 /* Header size + Designation descriptor */
432 len
+= (scsi_target_len
+ 4);
434 buf
[2] = ((len
>> 8) & 0xff);
435 buf
[3] = (len
& 0xff); /* Page Length for VPD 0x83 */
438 EXPORT_SYMBOL(spc_emulate_evpd_83
);
440 /* Extended INQUIRY Data VPD Page */
441 static sense_reason_t
442 spc_emulate_evpd_86(struct se_cmd
*cmd
, unsigned char *buf
)
444 struct se_device
*dev
= cmd
->se_dev
;
445 struct se_session
*sess
= cmd
->se_sess
;
449 * Set GRD_CHK + REF_CHK for TYPE1 protection, or GRD_CHK
450 * only for TYPE3 protection.
452 if (sess
->sup_prot_ops
& (TARGET_PROT_DIN_PASS
| TARGET_PROT_DOUT_PASS
)) {
453 if (dev
->dev_attrib
.pi_prot_type
== TARGET_DIF_TYPE1_PROT
||
454 cmd
->se_sess
->sess_prot_type
== TARGET_DIF_TYPE1_PROT
)
456 else if (dev
->dev_attrib
.pi_prot_type
== TARGET_DIF_TYPE3_PROT
||
457 cmd
->se_sess
->sess_prot_type
== TARGET_DIF_TYPE3_PROT
)
461 /* logical unit supports type 1 and type 3 protection */
462 buf
[4] |= (0x3 << 3);
464 /* Set HEADSUP, ORDSUP, SIMPSUP */
467 /* If WriteCache emulation is enabled, set V_SUP */
468 if (target_check_wce(dev
))
470 /* If an LBA map is present set R_SUP */
471 spin_lock(&cmd
->se_dev
->t10_alua
.lba_map_lock
);
472 if (!list_empty(&dev
->t10_alua
.lba_map_list
))
474 spin_unlock(&cmd
->se_dev
->t10_alua
.lba_map_lock
);
478 /* Block Limits VPD page */
479 static sense_reason_t
480 spc_emulate_evpd_b0(struct se_cmd
*cmd
, unsigned char *buf
)
482 struct se_device
*dev
= cmd
->se_dev
;
487 * Following spc3r22 section 6.5.3 Block Limits VPD page, when
488 * emulate_tpu=1 or emulate_tpws=1 we will be expect a
489 * different page length for Thin Provisioning.
491 if (dev
->dev_attrib
.emulate_tpu
|| dev
->dev_attrib
.emulate_tpws
)
494 buf
[0] = dev
->transport
->get_device_type(dev
);
495 buf
[3] = have_tp
? 0x3c : 0x10;
500 * Set MAXIMUM COMPARE AND WRITE LENGTH
502 if (dev
->dev_attrib
.emulate_caw
)
506 * Set OPTIMAL TRANSFER LENGTH GRANULARITY
508 if (dev
->transport
->get_io_min
&& (min
= dev
->transport
->get_io_min(dev
)))
509 put_unaligned_be16(min
/ dev
->dev_attrib
.block_size
, &buf
[6]);
511 put_unaligned_be16(1, &buf
[6]);
514 * Set MAXIMUM TRANSFER LENGTH
516 put_unaligned_be32(dev
->dev_attrib
.hw_max_sectors
, &buf
[8]);
519 * Set OPTIMAL TRANSFER LENGTH
521 if (dev
->transport
->get_io_opt
&& (opt
= dev
->transport
->get_io_opt(dev
)))
522 put_unaligned_be32(opt
/ dev
->dev_attrib
.block_size
, &buf
[12]);
524 put_unaligned_be32(dev
->dev_attrib
.optimal_sectors
, &buf
[12]);
527 * Exit now if we don't support TP.
533 * Set MAXIMUM UNMAP LBA COUNT
535 put_unaligned_be32(dev
->dev_attrib
.max_unmap_lba_count
, &buf
[20]);
538 * Set MAXIMUM UNMAP BLOCK DESCRIPTOR COUNT
540 put_unaligned_be32(dev
->dev_attrib
.max_unmap_block_desc_count
,
544 * Set OPTIMAL UNMAP GRANULARITY
546 put_unaligned_be32(dev
->dev_attrib
.unmap_granularity
, &buf
[28]);
549 * UNMAP GRANULARITY ALIGNMENT
551 put_unaligned_be32(dev
->dev_attrib
.unmap_granularity_alignment
,
553 if (dev
->dev_attrib
.unmap_granularity_alignment
!= 0)
554 buf
[32] |= 0x80; /* Set the UGAVALID bit */
557 * MAXIMUM WRITE SAME LENGTH
560 put_unaligned_be64(dev
->dev_attrib
.max_write_same_len
, &buf
[36]);
565 /* Block Device Characteristics VPD page */
566 static sense_reason_t
567 spc_emulate_evpd_b1(struct se_cmd
*cmd
, unsigned char *buf
)
569 struct se_device
*dev
= cmd
->se_dev
;
571 buf
[0] = dev
->transport
->get_device_type(dev
);
573 buf
[5] = dev
->dev_attrib
.is_nonrot
? 1 : 0;
578 /* Thin Provisioning VPD */
579 static sense_reason_t
580 spc_emulate_evpd_b2(struct se_cmd
*cmd
, unsigned char *buf
)
582 struct se_device
*dev
= cmd
->se_dev
;
585 * From spc3r22 section 6.5.4 Thin Provisioning VPD page:
587 * The PAGE LENGTH field is defined in SPC-4. If the DP bit is set to
588 * zero, then the page length shall be set to 0004h. If the DP bit
589 * is set to one, then the page length shall be set to the value
590 * defined in table 162.
592 buf
[0] = dev
->transport
->get_device_type(dev
);
595 * Set Hardcoded length mentioned above for DP=0
597 put_unaligned_be16(0x0004, &buf
[2]);
600 * The THRESHOLD EXPONENT field indicates the threshold set size in
601 * LBAs as a power of 2 (i.e., the threshold set size is equal to
602 * 2(threshold exponent)).
604 * Note that this is currently set to 0x00 as mkp says it will be
605 * changing again. We can enable this once it has settled in T10
606 * and is actually used by Linux/SCSI ML code.
611 * A TPU bit set to one indicates that the device server supports
612 * the UNMAP command (see 5.25). A TPU bit set to zero indicates
613 * that the device server does not support the UNMAP command.
615 if (dev
->dev_attrib
.emulate_tpu
!= 0)
619 * A TPWS bit set to one indicates that the device server supports
620 * the use of the WRITE SAME (16) command (see 5.42) to unmap LBAs.
621 * A TPWS bit set to zero indicates that the device server does not
622 * support the use of the WRITE SAME (16) command to unmap LBAs.
624 if (dev
->dev_attrib
.emulate_tpws
!= 0)
625 buf
[5] |= 0x40 | 0x20;
630 /* Referrals VPD page */
631 static sense_reason_t
632 spc_emulate_evpd_b3(struct se_cmd
*cmd
, unsigned char *buf
)
634 struct se_device
*dev
= cmd
->se_dev
;
636 buf
[0] = dev
->transport
->get_device_type(dev
);
638 put_unaligned_be32(dev
->t10_alua
.lba_map_segment_size
, &buf
[8]);
639 put_unaligned_be32(dev
->t10_alua
.lba_map_segment_multiplier
, &buf
[12]);
644 static sense_reason_t
645 spc_emulate_evpd_00(struct se_cmd
*cmd
, unsigned char *buf
);
649 sense_reason_t (*emulate
)(struct se_cmd
*, unsigned char *);
650 } evpd_handlers
[] = {
651 { .page
= 0x00, .emulate
= spc_emulate_evpd_00
},
652 { .page
= 0x80, .emulate
= spc_emulate_evpd_80
},
653 { .page
= 0x83, .emulate
= spc_emulate_evpd_83
},
654 { .page
= 0x86, .emulate
= spc_emulate_evpd_86
},
655 { .page
= 0xb0, .emulate
= spc_emulate_evpd_b0
},
656 { .page
= 0xb1, .emulate
= spc_emulate_evpd_b1
},
657 { .page
= 0xb2, .emulate
= spc_emulate_evpd_b2
},
658 { .page
= 0xb3, .emulate
= spc_emulate_evpd_b3
},
661 /* supported vital product data pages */
662 static sense_reason_t
663 spc_emulate_evpd_00(struct se_cmd
*cmd
, unsigned char *buf
)
668 * Only report the INQUIRY EVPD=1 pages after a valid NAA
669 * Registered Extended LUN WWN has been set via ConfigFS
670 * during device creation/restart.
672 if (cmd
->se_dev
->dev_flags
& DF_EMULATED_VPD_UNIT_SERIAL
) {
673 buf
[3] = ARRAY_SIZE(evpd_handlers
);
674 for (p
= 0; p
< ARRAY_SIZE(evpd_handlers
); ++p
)
675 buf
[p
+ 4] = evpd_handlers
[p
].page
;
681 static sense_reason_t
682 spc_emulate_inquiry(struct se_cmd
*cmd
)
684 struct se_device
*dev
= cmd
->se_dev
;
685 struct se_portal_group
*tpg
= cmd
->se_lun
->lun_tpg
;
687 unsigned char *cdb
= cmd
->t_task_cdb
;
693 buf
= kzalloc(SE_INQUIRY_BUF
, GFP_KERNEL
);
695 pr_err("Unable to allocate response buffer for INQUIRY\n");
696 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
699 if (dev
== rcu_access_pointer(tpg
->tpg_virt_lun0
->lun_se_dev
))
700 buf
[0] = 0x3f; /* Not connected */
702 buf
[0] = dev
->transport
->get_device_type(dev
);
704 if (!(cdb
[1] & 0x1)) {
706 pr_err("INQUIRY with EVPD==0 but PAGE CODE=%02x\n",
708 ret
= TCM_INVALID_CDB_FIELD
;
712 ret
= spc_emulate_inquiry_std(cmd
, buf
);
717 for (p
= 0; p
< ARRAY_SIZE(evpd_handlers
); ++p
) {
718 if (cdb
[2] == evpd_handlers
[p
].page
) {
720 ret
= evpd_handlers
[p
].emulate(cmd
, buf
);
721 len
= get_unaligned_be16(&buf
[2]) + 4;
726 pr_err("Unknown VPD Code: 0x%02x\n", cdb
[2]);
727 ret
= TCM_INVALID_CDB_FIELD
;
730 rbuf
= transport_kmap_data_sg(cmd
);
732 memcpy(rbuf
, buf
, min_t(u32
, SE_INQUIRY_BUF
, cmd
->data_length
));
733 transport_kunmap_data_sg(cmd
);
738 target_complete_cmd_with_length(cmd
, GOOD
, len
);
742 static int spc_modesense_rwrecovery(struct se_cmd
*cmd
, u8 pc
, u8
*p
)
747 /* No changeable values for now */
755 static int spc_modesense_control(struct se_cmd
*cmd
, u8 pc
, u8
*p
)
757 struct se_device
*dev
= cmd
->se_dev
;
758 struct se_session
*sess
= cmd
->se_sess
;
763 /* No changeable values for now */
769 * From spc4r23, 7.4.7 Control mode page
771 * The QUEUE ALGORITHM MODIFIER field (see table 368) specifies
772 * restrictions on the algorithm used for reordering commands
773 * having the SIMPLE task attribute (see SAM-4).
775 * Table 368 -- QUEUE ALGORITHM MODIFIER field
777 * 0h Restricted reordering
778 * 1h Unrestricted reordering allowed
780 * 8h to Fh Vendor specific
782 * A value of zero in the QUEUE ALGORITHM MODIFIER field specifies that
783 * the device server shall order the processing sequence of commands
784 * having the SIMPLE task attribute such that data integrity is maintained
785 * for that I_T nexus (i.e., if the transmission of new SCSI transport protocol
786 * requests is halted at any time, the final value of all data observable
787 * on the medium shall be the same as if all the commands had been processed
788 * with the ORDERED task attribute).
790 * A value of one in the QUEUE ALGORITHM MODIFIER field specifies that the
791 * device server may reorder the processing sequence of commands having the
792 * SIMPLE task attribute in any manner. Any data integrity exposures related to
793 * command sequence order shall be explicitly handled by the application client
794 * through the selection of appropriate ommands and task attributes.
796 p
[3] = (dev
->dev_attrib
.emulate_rest_reord
== 1) ? 0x00 : 0x10;
798 * From spc4r17, section 7.4.6 Control mode Page
800 * Unit Attention interlocks control (UN_INTLCK_CTRL) to code 00b
802 * 00b: The logical unit shall clear any unit attention condition
803 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
804 * status and shall not establish a unit attention condition when a com-
805 * mand is completed with BUSY, TASK SET FULL, or RESERVATION CONFLICT
808 * 10b: The logical unit shall not clear any unit attention condition
809 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
810 * status and shall not establish a unit attention condition when
811 * a command is completed with BUSY, TASK SET FULL, or RESERVATION
814 * 11b a The logical unit shall not clear any unit attention condition
815 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
816 * status and shall establish a unit attention condition for the
817 * initiator port associated with the I_T nexus on which the BUSY,
818 * TASK SET FULL, or RESERVATION CONFLICT status is being returned.
819 * Depending on the status, the additional sense code shall be set to
820 * PREVIOUS BUSY STATUS, PREVIOUS TASK SET FULL STATUS, or PREVIOUS
821 * RESERVATION CONFLICT STATUS. Until it is cleared by a REQUEST SENSE
822 * command, a unit attention condition shall be established only once
823 * for a BUSY, TASK SET FULL, or RESERVATION CONFLICT status regardless
824 * to the number of commands completed with one of those status codes.
826 p
[4] = (dev
->dev_attrib
.emulate_ua_intlck_ctrl
== 2) ? 0x30 :
827 (dev
->dev_attrib
.emulate_ua_intlck_ctrl
== 1) ? 0x20 : 0x00;
829 * From spc4r17, section 7.4.6 Control mode Page
831 * Task Aborted Status (TAS) bit set to zero.
833 * A task aborted status (TAS) bit set to zero specifies that aborted
834 * tasks shall be terminated by the device server without any response
835 * to the application client. A TAS bit set to one specifies that tasks
836 * aborted by the actions of an I_T nexus other than the I_T nexus on
837 * which the command was received shall be completed with TASK ABORTED
838 * status (see SAM-4).
840 p
[5] = (dev
->dev_attrib
.emulate_tas
) ? 0x40 : 0x00;
842 * From spc4r30, section 7.5.7 Control mode page
844 * Application Tag Owner (ATO) bit set to one.
846 * If the ATO bit is set to one the device server shall not modify the
847 * LOGICAL BLOCK APPLICATION TAG field and, depending on the protection
848 * type, shall not modify the contents of the LOGICAL BLOCK REFERENCE
851 if (sess
->sup_prot_ops
& (TARGET_PROT_DIN_PASS
| TARGET_PROT_DOUT_PASS
)) {
852 if (dev
->dev_attrib
.pi_prot_type
|| sess
->sess_prot_type
)
864 static int spc_modesense_caching(struct se_cmd
*cmd
, u8 pc
, u8
*p
)
866 struct se_device
*dev
= cmd
->se_dev
;
871 /* No changeable values for now */
875 if (target_check_wce(dev
))
876 p
[2] = 0x04; /* Write Cache Enable */
877 p
[12] = 0x20; /* Disabled Read Ahead */
883 static int spc_modesense_informational_exceptions(struct se_cmd
*cmd
, u8 pc
, unsigned char *p
)
888 /* No changeable values for now */
899 int (*emulate
)(struct se_cmd
*, u8
, unsigned char *);
900 } modesense_handlers
[] = {
901 { .page
= 0x01, .subpage
= 0x00, .emulate
= spc_modesense_rwrecovery
},
902 { .page
= 0x08, .subpage
= 0x00, .emulate
= spc_modesense_caching
},
903 { .page
= 0x0a, .subpage
= 0x00, .emulate
= spc_modesense_control
},
904 { .page
= 0x1c, .subpage
= 0x00, .emulate
= spc_modesense_informational_exceptions
},
907 static void spc_modesense_write_protect(unsigned char *buf
, int type
)
910 * I believe that the WP bit (bit 7) in the mode header is the same for
917 buf
[0] |= 0x80; /* WP bit */
922 static void spc_modesense_dpofua(unsigned char *buf
, int type
)
926 buf
[0] |= 0x10; /* DPOFUA bit */
933 static int spc_modesense_blockdesc(unsigned char *buf
, u64 blocks
, u32 block_size
)
936 put_unaligned_be32(min(blocks
, 0xffffffffull
), buf
);
938 put_unaligned_be32(block_size
, buf
);
942 static int spc_modesense_long_blockdesc(unsigned char *buf
, u64 blocks
, u32 block_size
)
944 if (blocks
<= 0xffffffff)
945 return spc_modesense_blockdesc(buf
+ 3, blocks
, block_size
) + 3;
947 *buf
++ = 1; /* LONGLBA */
950 put_unaligned_be64(blocks
, buf
);
952 put_unaligned_be32(block_size
, buf
);
957 static sense_reason_t
spc_emulate_modesense(struct se_cmd
*cmd
)
959 struct se_device
*dev
= cmd
->se_dev
;
960 char *cdb
= cmd
->t_task_cdb
;
961 unsigned char buf
[SE_MODE_PAGE_BUF
], *rbuf
;
962 int type
= dev
->transport
->get_device_type(dev
);
963 int ten
= (cmd
->t_task_cdb
[0] == MODE_SENSE_10
);
964 bool dbd
= !!(cdb
[1] & 0x08);
965 bool llba
= ten
? !!(cdb
[1] & 0x10) : false;
967 u8 page
= cdb
[2] & 0x3f;
972 bool read_only
= target_lun_is_rdonly(cmd
);;
974 memset(buf
, 0, SE_MODE_PAGE_BUF
);
977 * Skip over MODE DATA LENGTH + MEDIUM TYPE fields to byte 3 for
978 * MODE_SENSE_10 and byte 2 for MODE_SENSE (6).
980 length
= ten
? 3 : 2;
982 /* DEVICE-SPECIFIC PARAMETER */
983 if ((cmd
->se_lun
->lun_access
& TRANSPORT_LUNFLAGS_READ_ONLY
) || read_only
)
984 spc_modesense_write_protect(&buf
[length
], type
);
987 * SBC only allows us to enable FUA and DPO together. Fortunately
988 * DPO is explicitly specified as a hint, so a noop is a perfectly
989 * valid implementation.
991 if (target_check_fua(dev
))
992 spc_modesense_dpofua(&buf
[length
], type
);
996 /* BLOCK DESCRIPTOR */
999 * For now we only include a block descriptor for disk (SBC)
1000 * devices; other command sets use a slightly different format.
1002 if (!dbd
&& type
== TYPE_DISK
) {
1003 u64 blocks
= dev
->transport
->get_blocks(dev
);
1004 u32 block_size
= dev
->dev_attrib
.block_size
;
1008 length
+= spc_modesense_long_blockdesc(&buf
[length
],
1009 blocks
, block_size
);
1012 length
+= spc_modesense_blockdesc(&buf
[length
],
1013 blocks
, block_size
);
1016 length
+= spc_modesense_blockdesc(&buf
[length
], blocks
,
1027 if (subpage
!= 0x00 && subpage
!= 0xff) {
1028 pr_warn("MODE_SENSE: Invalid subpage code: 0x%02x\n", subpage
);
1029 return TCM_INVALID_CDB_FIELD
;
1032 for (i
= 0; i
< ARRAY_SIZE(modesense_handlers
); ++i
) {
1034 * Tricky way to say all subpage 00h for
1035 * subpage==0, all subpages for subpage==0xff
1036 * (and we just checked above that those are
1037 * the only two possibilities).
1039 if ((modesense_handlers
[i
].subpage
& ~subpage
) == 0) {
1040 ret
= modesense_handlers
[i
].emulate(cmd
, pc
, &buf
[length
]);
1041 if (!ten
&& length
+ ret
>= 255)
1050 for (i
= 0; i
< ARRAY_SIZE(modesense_handlers
); ++i
)
1051 if (modesense_handlers
[i
].page
== page
&&
1052 modesense_handlers
[i
].subpage
== subpage
) {
1053 length
+= modesense_handlers
[i
].emulate(cmd
, pc
, &buf
[length
]);
1058 * We don't intend to implement:
1059 * - obsolete page 03h "format parameters" (checked by Solaris)
1062 pr_err("MODE SENSE: unimplemented page/subpage: 0x%02x/0x%02x\n",
1065 return TCM_UNKNOWN_MODE_PAGE
;
1069 put_unaligned_be16(length
- 2, buf
);
1071 buf
[0] = length
- 1;
1073 rbuf
= transport_kmap_data_sg(cmd
);
1075 memcpy(rbuf
, buf
, min_t(u32
, SE_MODE_PAGE_BUF
, cmd
->data_length
));
1076 transport_kunmap_data_sg(cmd
);
1079 target_complete_cmd_with_length(cmd
, GOOD
, length
);
1083 static sense_reason_t
spc_emulate_modeselect(struct se_cmd
*cmd
)
1085 char *cdb
= cmd
->t_task_cdb
;
1086 bool ten
= cdb
[0] == MODE_SELECT_10
;
1087 int off
= ten
? 8 : 4;
1088 bool pf
= !!(cdb
[1] & 0x10);
1091 unsigned char tbuf
[SE_MODE_PAGE_BUF
];
1093 sense_reason_t ret
= 0;
1096 if (!cmd
->data_length
) {
1097 target_complete_cmd(cmd
, GOOD
);
1101 if (cmd
->data_length
< off
+ 2)
1102 return TCM_PARAMETER_LIST_LENGTH_ERROR
;
1104 buf
= transport_kmap_data_sg(cmd
);
1106 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1109 ret
= TCM_INVALID_CDB_FIELD
;
1113 page
= buf
[off
] & 0x3f;
1114 subpage
= buf
[off
] & 0x40 ? buf
[off
+ 1] : 0;
1116 for (i
= 0; i
< ARRAY_SIZE(modesense_handlers
); ++i
)
1117 if (modesense_handlers
[i
].page
== page
&&
1118 modesense_handlers
[i
].subpage
== subpage
) {
1119 memset(tbuf
, 0, SE_MODE_PAGE_BUF
);
1120 length
= modesense_handlers
[i
].emulate(cmd
, 0, tbuf
);
1121 goto check_contents
;
1124 ret
= TCM_UNKNOWN_MODE_PAGE
;
1128 if (cmd
->data_length
< off
+ length
) {
1129 ret
= TCM_PARAMETER_LIST_LENGTH_ERROR
;
1133 if (memcmp(buf
+ off
, tbuf
, length
))
1134 ret
= TCM_INVALID_PARAMETER_LIST
;
1137 transport_kunmap_data_sg(cmd
);
1140 target_complete_cmd(cmd
, GOOD
);
1144 static sense_reason_t
spc_emulate_request_sense(struct se_cmd
*cmd
)
1146 unsigned char *cdb
= cmd
->t_task_cdb
;
1147 unsigned char *rbuf
;
1148 u8 ua_asc
= 0, ua_ascq
= 0;
1149 unsigned char buf
[SE_SENSE_BUF
];
1151 memset(buf
, 0, SE_SENSE_BUF
);
1153 if (cdb
[1] & 0x01) {
1154 pr_err("REQUEST_SENSE description emulation not"
1156 return TCM_INVALID_CDB_FIELD
;
1159 rbuf
= transport_kmap_data_sg(cmd
);
1161 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1163 if (!core_scsi3_ua_clear_for_request_sense(cmd
, &ua_asc
, &ua_ascq
)) {
1165 * CURRENT ERROR, UNIT ATTENTION
1168 buf
[SPC_SENSE_KEY_OFFSET
] = UNIT_ATTENTION
;
1171 * The Additional Sense Code (ASC) from the UNIT ATTENTION
1173 buf
[SPC_ASC_KEY_OFFSET
] = ua_asc
;
1174 buf
[SPC_ASCQ_KEY_OFFSET
] = ua_ascq
;
1178 * CURRENT ERROR, NO SENSE
1181 buf
[SPC_SENSE_KEY_OFFSET
] = NO_SENSE
;
1184 * NO ADDITIONAL SENSE INFORMATION
1186 buf
[SPC_ASC_KEY_OFFSET
] = 0x00;
1190 memcpy(rbuf
, buf
, min_t(u32
, sizeof(buf
), cmd
->data_length
));
1191 transport_kunmap_data_sg(cmd
);
1193 target_complete_cmd(cmd
, GOOD
);
1197 sense_reason_t
spc_emulate_report_luns(struct se_cmd
*cmd
)
1199 struct se_dev_entry
*deve
;
1200 struct se_session
*sess
= cmd
->se_sess
;
1201 struct se_node_acl
*nacl
;
1203 u32 lun_count
= 0, offset
= 8;
1205 if (cmd
->data_length
< 16) {
1206 pr_warn("REPORT LUNS allocation length %u too small\n",
1208 return TCM_INVALID_CDB_FIELD
;
1211 buf
= transport_kmap_data_sg(cmd
);
1213 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1216 * If no struct se_session pointer is present, this struct se_cmd is
1217 * coming via a target_core_mod PASSTHROUGH op, and not through
1218 * a $FABRIC_MOD. In that case, report LUN=0 only.
1221 int_to_scsilun(0, (struct scsi_lun
*)&buf
[offset
]);
1225 nacl
= sess
->se_node_acl
;
1228 hlist_for_each_entry_rcu(deve
, &nacl
->lun_entry_hlist
, link
) {
1230 * We determine the correct LUN LIST LENGTH even once we
1231 * have reached the initial allocation length.
1232 * See SPC2-R20 7.19.
1235 if ((offset
+ 8) > cmd
->data_length
)
1238 int_to_scsilun(deve
->mapped_lun
, (struct scsi_lun
*)&buf
[offset
]);
1244 * See SPC3 r07, page 159.
1248 buf
[0] = ((lun_count
>> 24) & 0xff);
1249 buf
[1] = ((lun_count
>> 16) & 0xff);
1250 buf
[2] = ((lun_count
>> 8) & 0xff);
1251 buf
[3] = (lun_count
& 0xff);
1252 transport_kunmap_data_sg(cmd
);
1254 target_complete_cmd_with_length(cmd
, GOOD
, 8 + lun_count
* 8);
1257 EXPORT_SYMBOL(spc_emulate_report_luns
);
1259 static sense_reason_t
1260 spc_emulate_testunitready(struct se_cmd
*cmd
)
1262 target_complete_cmd(cmd
, GOOD
);
1267 spc_parse_cdb(struct se_cmd
*cmd
, unsigned int *size
)
1269 struct se_device
*dev
= cmd
->se_dev
;
1270 unsigned char *cdb
= cmd
->t_task_cdb
;
1275 cmd
->execute_cmd
= spc_emulate_modeselect
;
1277 case MODE_SELECT_10
:
1278 *size
= (cdb
[7] << 8) + cdb
[8];
1279 cmd
->execute_cmd
= spc_emulate_modeselect
;
1283 cmd
->execute_cmd
= spc_emulate_modesense
;
1286 *size
= (cdb
[7] << 8) + cdb
[8];
1287 cmd
->execute_cmd
= spc_emulate_modesense
;
1291 *size
= (cdb
[7] << 8) + cdb
[8];
1293 case PERSISTENT_RESERVE_IN
:
1294 *size
= (cdb
[7] << 8) + cdb
[8];
1295 cmd
->execute_cmd
= target_scsi3_emulate_pr_in
;
1297 case PERSISTENT_RESERVE_OUT
:
1298 *size
= (cdb
[7] << 8) + cdb
[8];
1299 cmd
->execute_cmd
= target_scsi3_emulate_pr_out
;
1303 if (cdb
[0] == RELEASE_10
)
1304 *size
= (cdb
[7] << 8) | cdb
[8];
1306 *size
= cmd
->data_length
;
1308 cmd
->execute_cmd
= target_scsi2_reservation_release
;
1313 * The SPC-2 RESERVE does not contain a size in the SCSI CDB.
1314 * Assume the passthrough or $FABRIC_MOD will tell us about it.
1316 if (cdb
[0] == RESERVE_10
)
1317 *size
= (cdb
[7] << 8) | cdb
[8];
1319 *size
= cmd
->data_length
;
1321 cmd
->execute_cmd
= target_scsi2_reservation_reserve
;
1325 cmd
->execute_cmd
= spc_emulate_request_sense
;
1328 *size
= (cdb
[3] << 8) + cdb
[4];
1331 * Do implicit HEAD_OF_QUEUE processing for INQUIRY.
1332 * See spc4r17 section 5.3
1334 cmd
->sam_task_attr
= TCM_HEAD_TAG
;
1335 cmd
->execute_cmd
= spc_emulate_inquiry
;
1337 case SECURITY_PROTOCOL_IN
:
1338 case SECURITY_PROTOCOL_OUT
:
1339 *size
= (cdb
[6] << 24) | (cdb
[7] << 16) | (cdb
[8] << 8) | cdb
[9];
1342 *size
= get_unaligned_be32(&cdb
[10]);
1343 cmd
->execute_cmd
= target_do_xcopy
;
1345 case RECEIVE_COPY_RESULTS
:
1346 *size
= get_unaligned_be32(&cdb
[10]);
1347 cmd
->execute_cmd
= target_do_receive_copy_results
;
1349 case READ_ATTRIBUTE
:
1350 case WRITE_ATTRIBUTE
:
1351 *size
= (cdb
[10] << 24) | (cdb
[11] << 16) |
1352 (cdb
[12] << 8) | cdb
[13];
1354 case RECEIVE_DIAGNOSTIC
:
1355 case SEND_DIAGNOSTIC
:
1356 *size
= (cdb
[3] << 8) | cdb
[4];
1359 *size
= (cdb
[6] << 16) + (cdb
[7] << 8) + cdb
[8];
1362 cmd
->execute_cmd
= spc_emulate_report_luns
;
1363 *size
= (cdb
[6] << 24) | (cdb
[7] << 16) | (cdb
[8] << 8) | cdb
[9];
1365 * Do implicit HEAD_OF_QUEUE processing for REPORT_LUNS
1366 * See spc4r17 section 5.3
1368 cmd
->sam_task_attr
= TCM_HEAD_TAG
;
1370 case TEST_UNIT_READY
:
1371 cmd
->execute_cmd
= spc_emulate_testunitready
;
1374 case MAINTENANCE_IN
:
1375 if (dev
->transport
->get_device_type(dev
) != TYPE_ROM
) {
1377 * MAINTENANCE_IN from SCC-2
1378 * Check for emulated MI_REPORT_TARGET_PGS
1380 if ((cdb
[1] & 0x1f) == MI_REPORT_TARGET_PGS
) {
1382 target_emulate_report_target_port_groups
;
1384 *size
= get_unaligned_be32(&cdb
[6]);
1387 * GPCMD_SEND_KEY from multi media commands
1389 *size
= get_unaligned_be16(&cdb
[8]);
1392 case MAINTENANCE_OUT
:
1393 if (dev
->transport
->get_device_type(dev
) != TYPE_ROM
) {
1395 * MAINTENANCE_OUT from SCC-2
1396 * Check for emulated MO_SET_TARGET_PGS.
1398 if (cdb
[1] == MO_SET_TARGET_PGS
) {
1400 target_emulate_set_target_port_groups
;
1402 *size
= get_unaligned_be32(&cdb
[6]);
1405 * GPCMD_SEND_KEY from multi media commands
1407 *size
= get_unaligned_be16(&cdb
[8]);
1411 pr_warn("TARGET_CORE[%s]: Unsupported SCSI Opcode"
1412 " 0x%02x, sending CHECK_CONDITION.\n",
1413 cmd
->se_tfo
->get_fabric_name(), cdb
[0]);
1414 return TCM_UNSUPPORTED_SCSI_OPCODE
;
1419 EXPORT_SYMBOL(spc_parse_cdb
);