2 * SCSI Primary Commands (SPC) parsing and emulation.
4 * (c) Copyright 2002-2012 RisingTide Systems LLC.
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"
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 explict and/or implict 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
, char *buf
)
72 struct se_lun
*lun
= cmd
->se_lun
;
73 struct se_device
*dev
= cmd
->se_dev
;
75 /* Set RMB (removable media) for tape devices */
76 if (dev
->transport
->get_device_type(dev
) == TYPE_TAPE
)
79 buf
[2] = 0x05; /* SPC-3 */
82 * NORMACA and HISUP = 0, RESPONSE DATA FORMAT = 2
85 * A RESPONSE DATA FORMAT field set to 2h indicates that the
86 * standard INQUIRY data is in the format defined in this
87 * standard. Response data format values less than 2h are
88 * obsolete. Response data format values greater than 2h are
94 * Enable SCCS and TPGS fields for Emulated ALUA
96 spc_fill_alua_data(lun
->lun_sep
, buf
);
98 buf
[7] = 0x2; /* CmdQue=1 */
100 snprintf(&buf
[8], 8, "LIO-ORG");
101 snprintf(&buf
[16], 16, "%s", dev
->t10_wwn
.model
);
102 snprintf(&buf
[32], 4, "%s", dev
->t10_wwn
.revision
);
103 buf
[4] = 31; /* Set additional length to 31 */
108 /* unit serial number */
109 static sense_reason_t
110 spc_emulate_evpd_80(struct se_cmd
*cmd
, unsigned char *buf
)
112 struct se_device
*dev
= cmd
->se_dev
;
115 if (dev
->dev_flags
& DF_EMULATED_VPD_UNIT_SERIAL
) {
118 unit_serial_len
= strlen(dev
->t10_wwn
.unit_serial
);
119 unit_serial_len
++; /* For NULL Terminator */
121 len
+= sprintf(&buf
[4], "%s", dev
->t10_wwn
.unit_serial
);
122 len
++; /* Extra Byte for NULL Terminator */
128 static void spc_parse_naa_6h_vendor_specific(struct se_device
*dev
,
131 unsigned char *p
= &dev
->t10_wwn
.unit_serial
[0];
136 * Generate up to 36 bits of VENDOR SPECIFIC IDENTIFIER starting on
137 * byte 3 bit 3-0 for NAA IEEE Registered Extended DESIGNATOR field
138 * format, followed by 64 bits of VENDOR SPECIFIC IDENTIFIER EXTENSION
139 * to complete the payload. These are based from VPD=0x80 PRODUCT SERIAL
140 * NUMBER set via vpd_unit_serial in target_core_configfs.c to ensure
141 * per device uniqeness.
143 for (cnt
= 0; *p
&& cnt
< 13; p
++) {
144 int val
= hex_to_bin(*p
);
160 * Device identification VPD, for a complete list of
161 * DESIGNATOR TYPEs see spc4r17 Table 459.
163 static sense_reason_t
164 spc_emulate_evpd_83(struct se_cmd
*cmd
, unsigned char *buf
)
166 struct se_device
*dev
= cmd
->se_dev
;
167 struct se_lun
*lun
= cmd
->se_lun
;
168 struct se_port
*port
= NULL
;
169 struct se_portal_group
*tpg
= NULL
;
170 struct t10_alua_lu_gp_member
*lu_gp_mem
;
171 struct t10_alua_tg_pt_gp
*tg_pt_gp
;
172 struct t10_alua_tg_pt_gp_member
*tg_pt_gp_mem
;
173 unsigned char *prod
= &dev
->t10_wwn
.model
[0];
175 u32 unit_serial_len
, off
= 0;
181 * NAA IEEE Registered Extended Assigned designator format, see
182 * spc4r17 section 7.7.3.6.5
184 * We depend upon a target_core_mod/ConfigFS provided
185 * /sys/kernel/config/target/core/$HBA/$DEV/wwn/vpd_unit_serial
186 * value in order to return the NAA id.
188 if (!(dev
->dev_flags
& DF_EMULATED_VPD_UNIT_SERIAL
))
189 goto check_t10_vend_desc
;
191 /* CODE SET == Binary */
194 /* Set ASSOCIATION == addressed logical unit: 0)b */
197 /* Identifier/Designator type == NAA identifier */
201 /* Identifier/Designator length */
205 * Start NAA IEEE Registered Extended Identifier/Designator
207 buf
[off
++] = (0x6 << 4);
210 * Use OpenFabrics IEEE Company ID: 00 14 05
214 buf
[off
] = (0x5 << 4);
217 * Return ConfigFS Unit Serial Number information for
218 * VENDOR_SPECIFIC_IDENTIFIER and
219 * VENDOR_SPECIFIC_IDENTIFIER_EXTENTION
221 spc_parse_naa_6h_vendor_specific(dev
, &buf
[off
]);
228 * T10 Vendor Identifier Page, see spc4r17 section 7.7.3.4
230 id_len
= 8; /* For Vendor field */
231 prod_len
= 4; /* For VPD Header */
232 prod_len
+= 8; /* For Vendor field */
233 prod_len
+= strlen(prod
);
234 prod_len
++; /* For : */
236 if (dev
->dev_flags
& DF_EMULATED_VPD_UNIT_SERIAL
) {
237 unit_serial_len
= strlen(&dev
->t10_wwn
.unit_serial
[0]);
238 unit_serial_len
++; /* For NULL Terminator */
240 id_len
+= sprintf(&buf
[off
+12], "%s:%s", prod
,
241 &dev
->t10_wwn
.unit_serial
[0]);
243 buf
[off
] = 0x2; /* ASCII */
244 buf
[off
+1] = 0x1; /* T10 Vendor ID */
246 memcpy(&buf
[off
+4], "LIO-ORG", 8);
247 /* Extra Byte for NULL Terminator */
249 /* Identifier Length */
251 /* Header size for Designation descriptor */
255 * struct se_port is only set for INQUIRY VPD=1 through $FABRIC_MOD
259 struct t10_alua_lu_gp
*lu_gp
;
260 u32 padding
, scsi_name_len
;
267 * Relative target port identifer, see spc4r17
270 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
271 * section 7.5.1 Table 362
274 (tpg
->se_tpg_tfo
->get_fabric_proto_ident(tpg
) << 4);
275 buf
[off
++] |= 0x1; /* CODE SET == Binary */
276 buf
[off
] = 0x80; /* Set PIV=1 */
277 /* Set ASSOCIATION == target port: 01b */
279 /* DESIGNATOR TYPE == Relative target port identifer */
281 off
++; /* Skip over Reserved */
282 buf
[off
++] = 4; /* DESIGNATOR LENGTH */
283 /* Skip over Obsolete field in RTPI payload
286 buf
[off
++] = ((port
->sep_rtpi
>> 8) & 0xff);
287 buf
[off
++] = (port
->sep_rtpi
& 0xff);
288 len
+= 8; /* Header size + Designation descriptor */
290 * Target port group identifier, see spc4r17
293 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
294 * section 7.5.1 Table 362
296 tg_pt_gp_mem
= port
->sep_alua_tg_pt_gp_mem
;
300 spin_lock(&tg_pt_gp_mem
->tg_pt_gp_mem_lock
);
301 tg_pt_gp
= tg_pt_gp_mem
->tg_pt_gp
;
303 spin_unlock(&tg_pt_gp_mem
->tg_pt_gp_mem_lock
);
306 tg_pt_gp_id
= tg_pt_gp
->tg_pt_gp_id
;
307 spin_unlock(&tg_pt_gp_mem
->tg_pt_gp_mem_lock
);
310 (tpg
->se_tpg_tfo
->get_fabric_proto_ident(tpg
) << 4);
311 buf
[off
++] |= 0x1; /* CODE SET == Binary */
312 buf
[off
] = 0x80; /* Set PIV=1 */
313 /* Set ASSOCIATION == target port: 01b */
315 /* DESIGNATOR TYPE == Target port group identifier */
317 off
++; /* Skip over Reserved */
318 buf
[off
++] = 4; /* DESIGNATOR LENGTH */
319 off
+= 2; /* Skip over Reserved Field */
320 buf
[off
++] = ((tg_pt_gp_id
>> 8) & 0xff);
321 buf
[off
++] = (tg_pt_gp_id
& 0xff);
322 len
+= 8; /* Header size + Designation descriptor */
324 * Logical Unit Group identifier, see spc4r17
328 lu_gp_mem
= dev
->dev_alua_lu_gp_mem
;
330 goto check_scsi_name
;
332 spin_lock(&lu_gp_mem
->lu_gp_mem_lock
);
333 lu_gp
= lu_gp_mem
->lu_gp
;
335 spin_unlock(&lu_gp_mem
->lu_gp_mem_lock
);
336 goto check_scsi_name
;
338 lu_gp_id
= lu_gp
->lu_gp_id
;
339 spin_unlock(&lu_gp_mem
->lu_gp_mem_lock
);
341 buf
[off
++] |= 0x1; /* CODE SET == Binary */
342 /* DESIGNATOR TYPE == Logical Unit Group identifier */
344 off
++; /* Skip over Reserved */
345 buf
[off
++] = 4; /* DESIGNATOR LENGTH */
346 off
+= 2; /* Skip over Reserved Field */
347 buf
[off
++] = ((lu_gp_id
>> 8) & 0xff);
348 buf
[off
++] = (lu_gp_id
& 0xff);
349 len
+= 8; /* Header size + Designation descriptor */
351 * SCSI name string designator, see spc4r17
354 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
355 * section 7.5.1 Table 362
358 scsi_name_len
= strlen(tpg
->se_tpg_tfo
->tpg_get_wwn(tpg
));
359 /* UTF-8 ",t,0x<16-bit TPGT>" + NULL Terminator */
361 /* Check for 4-byte padding */
362 padding
= ((-scsi_name_len
) & 3);
364 scsi_name_len
+= padding
;
365 /* Header size + Designation descriptor */
369 (tpg
->se_tpg_tfo
->get_fabric_proto_ident(tpg
) << 4);
370 buf
[off
++] |= 0x3; /* CODE SET == UTF-8 */
371 buf
[off
] = 0x80; /* Set PIV=1 */
372 /* Set ASSOCIATION == target port: 01b */
374 /* DESIGNATOR TYPE == SCSI name string */
376 off
+= 2; /* Skip over Reserved and length */
378 * SCSI name string identifer containing, $FABRIC_MOD
379 * dependent information. For LIO-Target and iSCSI
380 * Target Port, this means "<iSCSI name>,t,0x<TPGT> in
383 tpgt
= tpg
->se_tpg_tfo
->tpg_get_tag(tpg
);
384 scsi_name_len
= sprintf(&buf
[off
], "%s,t,0x%04x",
385 tpg
->se_tpg_tfo
->tpg_get_wwn(tpg
), tpgt
);
386 scsi_name_len
+= 1 /* Include NULL terminator */;
388 * The null-terminated, null-padded (see 4.4.2) SCSI
389 * NAME STRING field contains a UTF-8 format string.
390 * The number of bytes in the SCSI NAME STRING field
391 * (i.e., the value in the DESIGNATOR LENGTH field)
392 * shall be no larger than 256 and shall be a multiple
396 scsi_name_len
+= padding
;
398 buf
[off
-1] = scsi_name_len
;
399 off
+= scsi_name_len
;
400 /* Header size + Designation descriptor */
401 len
+= (scsi_name_len
+ 4);
403 buf
[2] = ((len
>> 8) & 0xff);
404 buf
[3] = (len
& 0xff); /* Page Length for VPD 0x83 */
408 /* Extended INQUIRY Data VPD Page */
409 static sense_reason_t
410 spc_emulate_evpd_86(struct se_cmd
*cmd
, unsigned char *buf
)
413 /* Set HEADSUP, ORDSUP, SIMPSUP */
416 /* If WriteCache emulation is enabled, set V_SUP */
417 if (cmd
->se_dev
->dev_attrib
.emulate_write_cache
> 0)
422 /* Block Limits VPD page */
423 static sense_reason_t
424 spc_emulate_evpd_b0(struct se_cmd
*cmd
, unsigned char *buf
)
426 struct se_device
*dev
= cmd
->se_dev
;
431 * Following spc3r22 section 6.5.3 Block Limits VPD page, when
432 * emulate_tpu=1 or emulate_tpws=1 we will be expect a
433 * different page length for Thin Provisioning.
435 if (dev
->dev_attrib
.emulate_tpu
|| dev
->dev_attrib
.emulate_tpws
)
438 buf
[0] = dev
->transport
->get_device_type(dev
);
439 buf
[3] = have_tp
? 0x3c : 0x10;
445 * Set OPTIMAL TRANSFER LENGTH GRANULARITY
447 put_unaligned_be16(1, &buf
[6]);
450 * Set MAXIMUM TRANSFER LENGTH
452 max_sectors
= min(dev
->dev_attrib
.fabric_max_sectors
,
453 dev
->dev_attrib
.hw_max_sectors
);
454 put_unaligned_be32(max_sectors
, &buf
[8]);
457 * Set OPTIMAL TRANSFER LENGTH
459 put_unaligned_be32(dev
->dev_attrib
.optimal_sectors
, &buf
[12]);
462 * Exit now if we don't support TP.
468 * Set MAXIMUM UNMAP LBA COUNT
470 put_unaligned_be32(dev
->dev_attrib
.max_unmap_lba_count
, &buf
[20]);
473 * Set MAXIMUM UNMAP BLOCK DESCRIPTOR COUNT
475 put_unaligned_be32(dev
->dev_attrib
.max_unmap_block_desc_count
,
479 * Set OPTIMAL UNMAP GRANULARITY
481 put_unaligned_be32(dev
->dev_attrib
.unmap_granularity
, &buf
[28]);
484 * UNMAP GRANULARITY ALIGNMENT
486 put_unaligned_be32(dev
->dev_attrib
.unmap_granularity_alignment
,
488 if (dev
->dev_attrib
.unmap_granularity_alignment
!= 0)
489 buf
[32] |= 0x80; /* Set the UGAVALID bit */
492 * MAXIMUM WRITE SAME LENGTH
495 put_unaligned_be64(dev
->dev_attrib
.max_write_same_len
, &buf
[36]);
500 /* Block Device Characteristics VPD page */
501 static sense_reason_t
502 spc_emulate_evpd_b1(struct se_cmd
*cmd
, unsigned char *buf
)
504 struct se_device
*dev
= cmd
->se_dev
;
506 buf
[0] = dev
->transport
->get_device_type(dev
);
508 buf
[5] = dev
->dev_attrib
.is_nonrot
? 1 : 0;
513 /* Thin Provisioning VPD */
514 static sense_reason_t
515 spc_emulate_evpd_b2(struct se_cmd
*cmd
, unsigned char *buf
)
517 struct se_device
*dev
= cmd
->se_dev
;
520 * From spc3r22 section 6.5.4 Thin Provisioning VPD page:
522 * The PAGE LENGTH field is defined in SPC-4. If the DP bit is set to
523 * zero, then the page length shall be set to 0004h. If the DP bit
524 * is set to one, then the page length shall be set to the value
525 * defined in table 162.
527 buf
[0] = dev
->transport
->get_device_type(dev
);
530 * Set Hardcoded length mentioned above for DP=0
532 put_unaligned_be16(0x0004, &buf
[2]);
535 * The THRESHOLD EXPONENT field indicates the threshold set size in
536 * LBAs as a power of 2 (i.e., the threshold set size is equal to
537 * 2(threshold exponent)).
539 * Note that this is currently set to 0x00 as mkp says it will be
540 * changing again. We can enable this once it has settled in T10
541 * and is actually used by Linux/SCSI ML code.
546 * A TPU bit set to one indicates that the device server supports
547 * the UNMAP command (see 5.25). A TPU bit set to zero indicates
548 * that the device server does not support the UNMAP command.
550 if (dev
->dev_attrib
.emulate_tpu
!= 0)
554 * A TPWS bit set to one indicates that the device server supports
555 * the use of the WRITE SAME (16) command (see 5.42) to unmap LBAs.
556 * A TPWS bit set to zero indicates that the device server does not
557 * support the use of the WRITE SAME (16) command to unmap LBAs.
559 if (dev
->dev_attrib
.emulate_tpws
!= 0)
565 static sense_reason_t
566 spc_emulate_evpd_00(struct se_cmd
*cmd
, unsigned char *buf
);
570 sense_reason_t (*emulate
)(struct se_cmd
*, unsigned char *);
571 } evpd_handlers
[] = {
572 { .page
= 0x00, .emulate
= spc_emulate_evpd_00
},
573 { .page
= 0x80, .emulate
= spc_emulate_evpd_80
},
574 { .page
= 0x83, .emulate
= spc_emulate_evpd_83
},
575 { .page
= 0x86, .emulate
= spc_emulate_evpd_86
},
576 { .page
= 0xb0, .emulate
= spc_emulate_evpd_b0
},
577 { .page
= 0xb1, .emulate
= spc_emulate_evpd_b1
},
578 { .page
= 0xb2, .emulate
= spc_emulate_evpd_b2
},
581 /* supported vital product data pages */
582 static sense_reason_t
583 spc_emulate_evpd_00(struct se_cmd
*cmd
, unsigned char *buf
)
588 * Only report the INQUIRY EVPD=1 pages after a valid NAA
589 * Registered Extended LUN WWN has been set via ConfigFS
590 * during device creation/restart.
592 if (cmd
->se_dev
->dev_flags
& DF_EMULATED_VPD_UNIT_SERIAL
) {
593 buf
[3] = ARRAY_SIZE(evpd_handlers
);
594 for (p
= 0; p
< ARRAY_SIZE(evpd_handlers
); ++p
)
595 buf
[p
+ 4] = evpd_handlers
[p
].page
;
601 static sense_reason_t
602 spc_emulate_inquiry(struct se_cmd
*cmd
)
604 struct se_device
*dev
= cmd
->se_dev
;
605 struct se_portal_group
*tpg
= cmd
->se_lun
->lun_sep
->sep_tpg
;
607 unsigned char *cdb
= cmd
->t_task_cdb
;
608 unsigned char buf
[SE_INQUIRY_BUF
];
612 memset(buf
, 0, SE_INQUIRY_BUF
);
614 if (dev
== tpg
->tpg_virt_lun0
.lun_se_dev
)
615 buf
[0] = 0x3f; /* Not connected */
617 buf
[0] = dev
->transport
->get_device_type(dev
);
619 if (!(cdb
[1] & 0x1)) {
621 pr_err("INQUIRY with EVPD==0 but PAGE CODE=%02x\n",
623 ret
= TCM_INVALID_CDB_FIELD
;
627 ret
= spc_emulate_inquiry_std(cmd
, buf
);
631 for (p
= 0; p
< ARRAY_SIZE(evpd_handlers
); ++p
) {
632 if (cdb
[2] == evpd_handlers
[p
].page
) {
634 ret
= evpd_handlers
[p
].emulate(cmd
, buf
);
639 pr_err("Unknown VPD Code: 0x%02x\n", cdb
[2]);
640 ret
= TCM_INVALID_CDB_FIELD
;
643 rbuf
= transport_kmap_data_sg(cmd
);
645 memcpy(rbuf
, buf
, min_t(u32
, sizeof(buf
), cmd
->data_length
));
646 transport_kunmap_data_sg(cmd
);
650 target_complete_cmd(cmd
, GOOD
);
654 static int spc_modesense_rwrecovery(struct se_device
*dev
, u8 pc
, u8
*p
)
659 /* No changeable values for now */
667 static int spc_modesense_control(struct se_device
*dev
, u8 pc
, u8
*p
)
672 /* No changeable values for now */
678 * From spc4r23, 7.4.7 Control mode page
680 * The QUEUE ALGORITHM MODIFIER field (see table 368) specifies
681 * restrictions on the algorithm used for reordering commands
682 * having the SIMPLE task attribute (see SAM-4).
684 * Table 368 -- QUEUE ALGORITHM MODIFIER field
686 * 0h Restricted reordering
687 * 1h Unrestricted reordering allowed
689 * 8h to Fh Vendor specific
691 * A value of zero in the QUEUE ALGORITHM MODIFIER field specifies that
692 * the device server shall order the processing sequence of commands
693 * having the SIMPLE task attribute such that data integrity is maintained
694 * for that I_T nexus (i.e., if the transmission of new SCSI transport protocol
695 * requests is halted at any time, the final value of all data observable
696 * on the medium shall be the same as if all the commands had been processed
697 * with the ORDERED task attribute).
699 * A value of one in the QUEUE ALGORITHM MODIFIER field specifies that the
700 * device server may reorder the processing sequence of commands having the
701 * SIMPLE task attribute in any manner. Any data integrity exposures related to
702 * command sequence order shall be explicitly handled by the application client
703 * through the selection of appropriate ommands and task attributes.
705 p
[3] = (dev
->dev_attrib
.emulate_rest_reord
== 1) ? 0x00 : 0x10;
707 * From spc4r17, section 7.4.6 Control mode Page
709 * Unit Attention interlocks control (UN_INTLCK_CTRL) to code 00b
711 * 00b: The logical unit shall clear any unit attention condition
712 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
713 * status and shall not establish a unit attention condition when a com-
714 * mand is completed with BUSY, TASK SET FULL, or RESERVATION CONFLICT
717 * 10b: The logical unit shall not clear any unit attention condition
718 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
719 * status and shall not establish a unit attention condition when
720 * a command is completed with BUSY, TASK SET FULL, or RESERVATION
723 * 11b a The logical unit shall not clear any unit attention condition
724 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
725 * status and shall establish a unit attention condition for the
726 * initiator port associated with the I_T nexus on which the BUSY,
727 * TASK SET FULL, or RESERVATION CONFLICT status is being returned.
728 * Depending on the status, the additional sense code shall be set to
729 * PREVIOUS BUSY STATUS, PREVIOUS TASK SET FULL STATUS, or PREVIOUS
730 * RESERVATION CONFLICT STATUS. Until it is cleared by a REQUEST SENSE
731 * command, a unit attention condition shall be established only once
732 * for a BUSY, TASK SET FULL, or RESERVATION CONFLICT status regardless
733 * to the number of commands completed with one of those status codes.
735 p
[4] = (dev
->dev_attrib
.emulate_ua_intlck_ctrl
== 2) ? 0x30 :
736 (dev
->dev_attrib
.emulate_ua_intlck_ctrl
== 1) ? 0x20 : 0x00;
738 * From spc4r17, section 7.4.6 Control mode Page
740 * Task Aborted Status (TAS) bit set to zero.
742 * A task aborted status (TAS) bit set to zero specifies that aborted
743 * tasks shall be terminated by the device server without any response
744 * to the application client. A TAS bit set to one specifies that tasks
745 * aborted by the actions of an I_T nexus other than the I_T nexus on
746 * which the command was received shall be completed with TASK ABORTED
747 * status (see SAM-4).
749 p
[5] = (dev
->dev_attrib
.emulate_tas
) ? 0x40 : 0x00;
758 static int spc_modesense_caching(struct se_device
*dev
, u8 pc
, u8
*p
)
763 /* No changeable values for now */
767 if (dev
->dev_attrib
.emulate_write_cache
> 0)
768 p
[2] = 0x04; /* Write Cache Enable */
769 p
[12] = 0x20; /* Disabled Read Ahead */
775 static int spc_modesense_informational_exceptions(struct se_device
*dev
, u8 pc
, unsigned char *p
)
780 /* No changeable values for now */
791 int (*emulate
)(struct se_device
*, u8
, unsigned char *);
792 } modesense_handlers
[] = {
793 { .page
= 0x01, .subpage
= 0x00, .emulate
= spc_modesense_rwrecovery
},
794 { .page
= 0x08, .subpage
= 0x00, .emulate
= spc_modesense_caching
},
795 { .page
= 0x0a, .subpage
= 0x00, .emulate
= spc_modesense_control
},
796 { .page
= 0x1c, .subpage
= 0x00, .emulate
= spc_modesense_informational_exceptions
},
799 static void spc_modesense_write_protect(unsigned char *buf
, int type
)
802 * I believe that the WP bit (bit 7) in the mode header is the same for
809 buf
[0] |= 0x80; /* WP bit */
814 static void spc_modesense_dpofua(unsigned char *buf
, int type
)
818 buf
[0] |= 0x10; /* DPOFUA bit */
825 static int spc_modesense_blockdesc(unsigned char *buf
, u64 blocks
, u32 block_size
)
828 put_unaligned_be32(min(blocks
, 0xffffffffull
), buf
);
830 put_unaligned_be32(block_size
, buf
);
834 static int spc_modesense_long_blockdesc(unsigned char *buf
, u64 blocks
, u32 block_size
)
836 if (blocks
<= 0xffffffff)
837 return spc_modesense_blockdesc(buf
+ 3, blocks
, block_size
) + 3;
839 *buf
++ = 1; /* LONGLBA */
842 put_unaligned_be64(blocks
, buf
);
844 put_unaligned_be32(block_size
, buf
);
849 static sense_reason_t
spc_emulate_modesense(struct se_cmd
*cmd
)
851 struct se_device
*dev
= cmd
->se_dev
;
852 char *cdb
= cmd
->t_task_cdb
;
853 unsigned char buf
[SE_MODE_PAGE_BUF
], *rbuf
;
854 int type
= dev
->transport
->get_device_type(dev
);
855 int ten
= (cmd
->t_task_cdb
[0] == MODE_SENSE_10
);
856 bool dbd
= !!(cdb
[1] & 0x08);
857 bool llba
= ten
? !!(cdb
[1] & 0x10) : false;
859 u8 page
= cdb
[2] & 0x3f;
865 memset(buf
, 0, SE_MODE_PAGE_BUF
);
868 * Skip over MODE DATA LENGTH + MEDIUM TYPE fields to byte 3 for
869 * MODE_SENSE_10 and byte 2 for MODE_SENSE (6).
871 length
= ten
? 3 : 2;
873 /* DEVICE-SPECIFIC PARAMETER */
874 if ((cmd
->se_lun
->lun_access
& TRANSPORT_LUNFLAGS_READ_ONLY
) ||
876 (cmd
->se_deve
->lun_flags
& TRANSPORT_LUNFLAGS_READ_ONLY
)))
877 spc_modesense_write_protect(&buf
[length
], type
);
879 if ((dev
->dev_attrib
.emulate_write_cache
> 0) &&
880 (dev
->dev_attrib
.emulate_fua_write
> 0))
881 spc_modesense_dpofua(&buf
[length
], type
);
885 /* BLOCK DESCRIPTOR */
888 * For now we only include a block descriptor for disk (SBC)
889 * devices; other command sets use a slightly different format.
891 if (!dbd
&& type
== TYPE_DISK
) {
892 u64 blocks
= dev
->transport
->get_blocks(dev
);
893 u32 block_size
= dev
->dev_attrib
.block_size
;
897 length
+= spc_modesense_long_blockdesc(&buf
[length
],
901 length
+= spc_modesense_blockdesc(&buf
[length
],
905 length
+= spc_modesense_blockdesc(&buf
[length
], blocks
,
916 if (subpage
!= 0x00 && subpage
!= 0xff) {
917 pr_warn("MODE_SENSE: Invalid subpage code: 0x%02x\n", subpage
);
918 return TCM_INVALID_CDB_FIELD
;
921 for (i
= 0; i
< ARRAY_SIZE(modesense_handlers
); ++i
) {
923 * Tricky way to say all subpage 00h for
924 * subpage==0, all subpages for subpage==0xff
925 * (and we just checked above that those are
926 * the only two possibilities).
928 if ((modesense_handlers
[i
].subpage
& ~subpage
) == 0) {
929 ret
= modesense_handlers
[i
].emulate(dev
, pc
, &buf
[length
]);
930 if (!ten
&& length
+ ret
>= 255)
939 for (i
= 0; i
< ARRAY_SIZE(modesense_handlers
); ++i
)
940 if (modesense_handlers
[i
].page
== page
&&
941 modesense_handlers
[i
].subpage
== subpage
) {
942 length
+= modesense_handlers
[i
].emulate(dev
, pc
, &buf
[length
]);
947 * We don't intend to implement:
948 * - obsolete page 03h "format parameters" (checked by Solaris)
951 pr_err("MODE SENSE: unimplemented page/subpage: 0x%02x/0x%02x\n",
954 return TCM_UNKNOWN_MODE_PAGE
;
958 put_unaligned_be16(length
- 2, buf
);
962 rbuf
= transport_kmap_data_sg(cmd
);
964 memcpy(rbuf
, buf
, min_t(u32
, SE_MODE_PAGE_BUF
, cmd
->data_length
));
965 transport_kunmap_data_sg(cmd
);
968 target_complete_cmd(cmd
, GOOD
);
972 static sense_reason_t
spc_emulate_modeselect(struct se_cmd
*cmd
)
974 struct se_device
*dev
= cmd
->se_dev
;
975 char *cdb
= cmd
->t_task_cdb
;
976 bool ten
= cdb
[0] == MODE_SELECT_10
;
977 int off
= ten
? 8 : 4;
978 bool pf
= !!(cdb
[1] & 0x10);
981 unsigned char tbuf
[SE_MODE_PAGE_BUF
];
986 buf
= transport_kmap_data_sg(cmd
);
988 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
991 ret
= TCM_INVALID_CDB_FIELD
;
995 page
= buf
[off
] & 0x3f;
996 subpage
= buf
[off
] & 0x40 ? buf
[off
+ 1] : 0;
998 for (i
= 0; i
< ARRAY_SIZE(modesense_handlers
); ++i
)
999 if (modesense_handlers
[i
].page
== page
&&
1000 modesense_handlers
[i
].subpage
== subpage
) {
1001 memset(tbuf
, 0, SE_MODE_PAGE_BUF
);
1002 length
= modesense_handlers
[i
].emulate(dev
, 0, tbuf
);
1003 goto check_contents
;
1006 ret
= TCM_UNKNOWN_MODE_PAGE
;
1010 if (memcmp(buf
+ off
, tbuf
, length
))
1011 ret
= TCM_INVALID_PARAMETER_LIST
;
1014 transport_kunmap_data_sg(cmd
);
1017 target_complete_cmd(cmd
, GOOD
);
1021 static sense_reason_t
spc_emulate_request_sense(struct se_cmd
*cmd
)
1023 unsigned char *cdb
= cmd
->t_task_cdb
;
1024 unsigned char *rbuf
;
1025 u8 ua_asc
= 0, ua_ascq
= 0;
1026 unsigned char buf
[SE_SENSE_BUF
];
1028 memset(buf
, 0, SE_SENSE_BUF
);
1030 if (cdb
[1] & 0x01) {
1031 pr_err("REQUEST_SENSE description emulation not"
1033 return TCM_INVALID_CDB_FIELD
;
1036 rbuf
= transport_kmap_data_sg(cmd
);
1038 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1040 if (!core_scsi3_ua_clear_for_request_sense(cmd
, &ua_asc
, &ua_ascq
)) {
1042 * CURRENT ERROR, UNIT ATTENTION
1045 buf
[SPC_SENSE_KEY_OFFSET
] = UNIT_ATTENTION
;
1048 * The Additional Sense Code (ASC) from the UNIT ATTENTION
1050 buf
[SPC_ASC_KEY_OFFSET
] = ua_asc
;
1051 buf
[SPC_ASCQ_KEY_OFFSET
] = ua_ascq
;
1055 * CURRENT ERROR, NO SENSE
1058 buf
[SPC_SENSE_KEY_OFFSET
] = NO_SENSE
;
1061 * NO ADDITIONAL SENSE INFORMATION
1063 buf
[SPC_ASC_KEY_OFFSET
] = 0x00;
1067 memcpy(rbuf
, buf
, min_t(u32
, sizeof(buf
), cmd
->data_length
));
1068 transport_kunmap_data_sg(cmd
);
1070 target_complete_cmd(cmd
, GOOD
);
1074 sense_reason_t
spc_emulate_report_luns(struct se_cmd
*cmd
)
1076 struct se_dev_entry
*deve
;
1077 struct se_session
*sess
= cmd
->se_sess
;
1079 u32 lun_count
= 0, offset
= 8, i
;
1081 if (cmd
->data_length
< 16) {
1082 pr_warn("REPORT LUNS allocation length %u too small\n",
1084 return TCM_INVALID_CDB_FIELD
;
1087 buf
= transport_kmap_data_sg(cmd
);
1089 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1092 * If no struct se_session pointer is present, this struct se_cmd is
1093 * coming via a target_core_mod PASSTHROUGH op, and not through
1094 * a $FABRIC_MOD. In that case, report LUN=0 only.
1097 int_to_scsilun(0, (struct scsi_lun
*)&buf
[offset
]);
1102 spin_lock_irq(&sess
->se_node_acl
->device_list_lock
);
1103 for (i
= 0; i
< TRANSPORT_MAX_LUNS_PER_TPG
; i
++) {
1104 deve
= sess
->se_node_acl
->device_list
[i
];
1105 if (!(deve
->lun_flags
& TRANSPORT_LUNFLAGS_INITIATOR_ACCESS
))
1108 * We determine the correct LUN LIST LENGTH even once we
1109 * have reached the initial allocation length.
1110 * See SPC2-R20 7.19.
1113 if ((offset
+ 8) > cmd
->data_length
)
1116 int_to_scsilun(deve
->mapped_lun
, (struct scsi_lun
*)&buf
[offset
]);
1119 spin_unlock_irq(&sess
->se_node_acl
->device_list_lock
);
1122 * See SPC3 r07, page 159.
1126 buf
[0] = ((lun_count
>> 24) & 0xff);
1127 buf
[1] = ((lun_count
>> 16) & 0xff);
1128 buf
[2] = ((lun_count
>> 8) & 0xff);
1129 buf
[3] = (lun_count
& 0xff);
1130 transport_kunmap_data_sg(cmd
);
1132 target_complete_cmd(cmd
, GOOD
);
1135 EXPORT_SYMBOL(spc_emulate_report_luns
);
1137 static sense_reason_t
1138 spc_emulate_testunitready(struct se_cmd
*cmd
)
1140 target_complete_cmd(cmd
, GOOD
);
1145 spc_parse_cdb(struct se_cmd
*cmd
, unsigned int *size
)
1147 struct se_device
*dev
= cmd
->se_dev
;
1148 unsigned char *cdb
= cmd
->t_task_cdb
;
1153 cmd
->execute_cmd
= spc_emulate_modeselect
;
1155 case MODE_SELECT_10
:
1156 *size
= (cdb
[7] << 8) + cdb
[8];
1157 cmd
->execute_cmd
= spc_emulate_modeselect
;
1161 cmd
->execute_cmd
= spc_emulate_modesense
;
1164 *size
= (cdb
[7] << 8) + cdb
[8];
1165 cmd
->execute_cmd
= spc_emulate_modesense
;
1169 *size
= (cdb
[7] << 8) + cdb
[8];
1171 case PERSISTENT_RESERVE_IN
:
1172 *size
= (cdb
[7] << 8) + cdb
[8];
1173 cmd
->execute_cmd
= target_scsi3_emulate_pr_in
;
1175 case PERSISTENT_RESERVE_OUT
:
1176 *size
= (cdb
[7] << 8) + cdb
[8];
1177 cmd
->execute_cmd
= target_scsi3_emulate_pr_out
;
1181 if (cdb
[0] == RELEASE_10
)
1182 *size
= (cdb
[7] << 8) | cdb
[8];
1184 *size
= cmd
->data_length
;
1186 cmd
->execute_cmd
= target_scsi2_reservation_release
;
1191 * The SPC-2 RESERVE does not contain a size in the SCSI CDB.
1192 * Assume the passthrough or $FABRIC_MOD will tell us about it.
1194 if (cdb
[0] == RESERVE_10
)
1195 *size
= (cdb
[7] << 8) | cdb
[8];
1197 *size
= cmd
->data_length
;
1199 cmd
->execute_cmd
= target_scsi2_reservation_reserve
;
1203 cmd
->execute_cmd
= spc_emulate_request_sense
;
1206 *size
= (cdb
[3] << 8) + cdb
[4];
1209 * Do implict HEAD_OF_QUEUE processing for INQUIRY.
1210 * See spc4r17 section 5.3
1212 cmd
->sam_task_attr
= MSG_HEAD_TAG
;
1213 cmd
->execute_cmd
= spc_emulate_inquiry
;
1215 case SECURITY_PROTOCOL_IN
:
1216 case SECURITY_PROTOCOL_OUT
:
1217 *size
= (cdb
[6] << 24) | (cdb
[7] << 16) | (cdb
[8] << 8) | cdb
[9];
1220 case READ_ATTRIBUTE
:
1221 case RECEIVE_COPY_RESULTS
:
1222 case WRITE_ATTRIBUTE
:
1223 *size
= (cdb
[10] << 24) | (cdb
[11] << 16) |
1224 (cdb
[12] << 8) | cdb
[13];
1226 case RECEIVE_DIAGNOSTIC
:
1227 case SEND_DIAGNOSTIC
:
1228 *size
= (cdb
[3] << 8) | cdb
[4];
1231 *size
= (cdb
[6] << 16) + (cdb
[7] << 8) + cdb
[8];
1234 cmd
->execute_cmd
= spc_emulate_report_luns
;
1235 *size
= (cdb
[6] << 24) | (cdb
[7] << 16) | (cdb
[8] << 8) | cdb
[9];
1237 * Do implict HEAD_OF_QUEUE processing for REPORT_LUNS
1238 * See spc4r17 section 5.3
1240 cmd
->sam_task_attr
= MSG_HEAD_TAG
;
1242 case TEST_UNIT_READY
:
1243 cmd
->execute_cmd
= spc_emulate_testunitready
;
1246 case MAINTENANCE_IN
:
1247 if (dev
->transport
->get_device_type(dev
) != TYPE_ROM
) {
1249 * MAINTENANCE_IN from SCC-2
1250 * Check for emulated MI_REPORT_TARGET_PGS
1252 if ((cdb
[1] & 0x1f) == MI_REPORT_TARGET_PGS
) {
1254 target_emulate_report_target_port_groups
;
1256 *size
= get_unaligned_be32(&cdb
[6]);
1259 * GPCMD_SEND_KEY from multi media commands
1261 *size
= get_unaligned_be16(&cdb
[8]);
1264 case MAINTENANCE_OUT
:
1265 if (dev
->transport
->get_device_type(dev
) != TYPE_ROM
) {
1267 * MAINTENANCE_OUT from SCC-2
1268 * Check for emulated MO_SET_TARGET_PGS.
1270 if (cdb
[1] == MO_SET_TARGET_PGS
) {
1272 target_emulate_set_target_port_groups
;
1274 *size
= get_unaligned_be32(&cdb
[6]);
1277 * GPCMD_SEND_KEY from multi media commands
1279 *size
= get_unaligned_be16(&cdb
[8]);
1283 pr_warn("TARGET_CORE[%s]: Unsupported SCSI Opcode"
1284 " 0x%02x, sending CHECK_CONDITION.\n",
1285 cmd
->se_tfo
->get_fabric_name(), cdb
[0]);
1286 return TCM_UNSUPPORTED_SCSI_OPCODE
;
1291 EXPORT_SYMBOL(spc_parse_cdb
);