x86/xen: resume timer irqs early
[linux/fpc-iii.git] / drivers / target / target_core_spc.c
blobee400df1fea2fcb2403d8392952d94b5381e53a3
1 /*
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.
48 buf[5] = 0x80;
51 * Set TPGS field for explict and/or implict ALUA access type
52 * and opteration.
54 * See spc4r17 section 6.4.2 Table 135
56 if (!port)
57 return;
58 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
59 if (!tg_pt_gp_mem)
60 return;
62 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
63 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
64 if (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);
69 sense_reason_t
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;
75 /* Set RMB (removable media) for tape devices */
76 if (dev->transport->get_device_type(dev) == TYPE_TAPE)
77 buf[1] = 0x80;
79 buf[2] = 0x05; /* SPC-3 */
82 * NORMACA and HISUP = 0, RESPONSE DATA FORMAT = 2
84 * SPC4 says:
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
89 * reserved.
91 buf[3] = 2;
94 * Enable SCCS and TPGS fields for Emulated ALUA
96 spc_fill_alua_data(lun->lun_sep, buf);
99 * Set Third-Party Copy (3PC) bit to indicate support for EXTENDED_COPY
101 if (dev->dev_attrib.emulate_3pc)
102 buf[5] |= 0x8;
104 buf[7] = 0x2; /* CmdQue=1 */
106 memcpy(&buf[8], "LIO-ORG ", 8);
107 memset(&buf[16], 0x20, 16);
108 memcpy(&buf[16], dev->t10_wwn.model,
109 min_t(size_t, strlen(dev->t10_wwn.model), 16));
110 memcpy(&buf[32], dev->t10_wwn.revision,
111 min_t(size_t, strlen(dev->t10_wwn.revision), 4));
112 buf[4] = 31; /* Set additional length to 31 */
114 return 0;
116 EXPORT_SYMBOL(spc_emulate_inquiry_std);
118 /* unit serial number */
119 static sense_reason_t
120 spc_emulate_evpd_80(struct se_cmd *cmd, unsigned char *buf)
122 struct se_device *dev = cmd->se_dev;
123 u16 len = 0;
125 if (dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL) {
126 u32 unit_serial_len;
128 unit_serial_len = strlen(dev->t10_wwn.unit_serial);
129 unit_serial_len++; /* For NULL Terminator */
131 len += sprintf(&buf[4], "%s", dev->t10_wwn.unit_serial);
132 len++; /* Extra Byte for NULL Terminator */
133 buf[3] = len;
135 return 0;
138 void spc_parse_naa_6h_vendor_specific(struct se_device *dev,
139 unsigned char *buf)
141 unsigned char *p = &dev->t10_wwn.unit_serial[0];
142 int cnt;
143 bool next = true;
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);
156 if (val < 0)
157 continue;
159 if (next) {
160 next = false;
161 buf[cnt++] |= val;
162 } else {
163 next = true;
164 buf[cnt] = val << 4;
170 * Device identification VPD, for a complete list of
171 * DESIGNATOR TYPEs see spc4r17 Table 459.
173 sense_reason_t
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_port *port = NULL;
179 struct se_portal_group *tpg = NULL;
180 struct t10_alua_lu_gp_member *lu_gp_mem;
181 struct t10_alua_tg_pt_gp *tg_pt_gp;
182 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
183 unsigned char *prod = &dev->t10_wwn.model[0];
184 u32 prod_len;
185 u32 unit_serial_len, off = 0;
186 u16 len = 0, id_len;
188 off = 4;
191 * NAA IEEE Registered Extended Assigned designator format, see
192 * spc4r17 section 7.7.3.6.5
194 * We depend upon a target_core_mod/ConfigFS provided
195 * /sys/kernel/config/target/core/$HBA/$DEV/wwn/vpd_unit_serial
196 * value in order to return the NAA id.
198 if (!(dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL))
199 goto check_t10_vend_desc;
201 /* CODE SET == Binary */
202 buf[off++] = 0x1;
204 /* Set ASSOCIATION == addressed logical unit: 0)b */
205 buf[off] = 0x00;
207 /* Identifier/Designator type == NAA identifier */
208 buf[off++] |= 0x3;
209 off++;
211 /* Identifier/Designator length */
212 buf[off++] = 0x10;
215 * Start NAA IEEE Registered Extended Identifier/Designator
217 buf[off++] = (0x6 << 4);
220 * Use OpenFabrics IEEE Company ID: 00 14 05
222 buf[off++] = 0x01;
223 buf[off++] = 0x40;
224 buf[off] = (0x5 << 4);
227 * Return ConfigFS Unit Serial Number information for
228 * VENDOR_SPECIFIC_IDENTIFIER and
229 * VENDOR_SPECIFIC_IDENTIFIER_EXTENTION
231 spc_parse_naa_6h_vendor_specific(dev, &buf[off]);
233 len = 20;
234 off = (len + 4);
236 check_t10_vend_desc:
238 * T10 Vendor Identifier Page, see spc4r17 section 7.7.3.4
240 id_len = 8; /* For Vendor field */
241 prod_len = 4; /* For VPD Header */
242 prod_len += 8; /* For Vendor field */
243 prod_len += strlen(prod);
244 prod_len++; /* For : */
246 if (dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL) {
247 unit_serial_len = strlen(&dev->t10_wwn.unit_serial[0]);
248 unit_serial_len++; /* For NULL Terminator */
250 id_len += sprintf(&buf[off+12], "%s:%s", prod,
251 &dev->t10_wwn.unit_serial[0]);
253 buf[off] = 0x2; /* ASCII */
254 buf[off+1] = 0x1; /* T10 Vendor ID */
255 buf[off+2] = 0x0;
256 memcpy(&buf[off+4], "LIO-ORG", 8);
257 /* Extra Byte for NULL Terminator */
258 id_len++;
259 /* Identifier Length */
260 buf[off+3] = id_len;
261 /* Header size for Designation descriptor */
262 len += (id_len + 4);
263 off += (id_len + 4);
265 * struct se_port is only set for INQUIRY VPD=1 through $FABRIC_MOD
267 port = lun->lun_sep;
268 if (port) {
269 struct t10_alua_lu_gp *lu_gp;
270 u32 padding, scsi_name_len;
271 u16 lu_gp_id = 0;
272 u16 tg_pt_gp_id = 0;
273 u16 tpgt;
275 tpg = port->sep_tpg;
277 * Relative target port identifer, see spc4r17
278 * section 7.7.3.7
280 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
281 * section 7.5.1 Table 362
283 buf[off] =
284 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
285 buf[off++] |= 0x1; /* CODE SET == Binary */
286 buf[off] = 0x80; /* Set PIV=1 */
287 /* Set ASSOCIATION == target port: 01b */
288 buf[off] |= 0x10;
289 /* DESIGNATOR TYPE == Relative target port identifer */
290 buf[off++] |= 0x4;
291 off++; /* Skip over Reserved */
292 buf[off++] = 4; /* DESIGNATOR LENGTH */
293 /* Skip over Obsolete field in RTPI payload
294 * in Table 472 */
295 off += 2;
296 buf[off++] = ((port->sep_rtpi >> 8) & 0xff);
297 buf[off++] = (port->sep_rtpi & 0xff);
298 len += 8; /* Header size + Designation descriptor */
300 * Target port group identifier, see spc4r17
301 * section 7.7.3.8
303 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
304 * section 7.5.1 Table 362
306 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
307 if (!tg_pt_gp_mem)
308 goto check_lu_gp;
310 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
311 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
312 if (!tg_pt_gp) {
313 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
314 goto check_lu_gp;
316 tg_pt_gp_id = tg_pt_gp->tg_pt_gp_id;
317 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
319 buf[off] =
320 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
321 buf[off++] |= 0x1; /* CODE SET == Binary */
322 buf[off] = 0x80; /* Set PIV=1 */
323 /* Set ASSOCIATION == target port: 01b */
324 buf[off] |= 0x10;
325 /* DESIGNATOR TYPE == Target port group identifier */
326 buf[off++] |= 0x5;
327 off++; /* Skip over Reserved */
328 buf[off++] = 4; /* DESIGNATOR LENGTH */
329 off += 2; /* Skip over Reserved Field */
330 buf[off++] = ((tg_pt_gp_id >> 8) & 0xff);
331 buf[off++] = (tg_pt_gp_id & 0xff);
332 len += 8; /* Header size + Designation descriptor */
334 * Logical Unit Group identifier, see spc4r17
335 * section 7.7.3.8
337 check_lu_gp:
338 lu_gp_mem = dev->dev_alua_lu_gp_mem;
339 if (!lu_gp_mem)
340 goto check_scsi_name;
342 spin_lock(&lu_gp_mem->lu_gp_mem_lock);
343 lu_gp = lu_gp_mem->lu_gp;
344 if (!lu_gp) {
345 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
346 goto check_scsi_name;
348 lu_gp_id = lu_gp->lu_gp_id;
349 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
351 buf[off++] |= 0x1; /* CODE SET == Binary */
352 /* DESIGNATOR TYPE == Logical Unit Group identifier */
353 buf[off++] |= 0x6;
354 off++; /* Skip over Reserved */
355 buf[off++] = 4; /* DESIGNATOR LENGTH */
356 off += 2; /* Skip over Reserved Field */
357 buf[off++] = ((lu_gp_id >> 8) & 0xff);
358 buf[off++] = (lu_gp_id & 0xff);
359 len += 8; /* Header size + Designation descriptor */
361 * SCSI name string designator, see spc4r17
362 * section 7.7.3.11
364 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
365 * section 7.5.1 Table 362
367 check_scsi_name:
368 scsi_name_len = strlen(tpg->se_tpg_tfo->tpg_get_wwn(tpg));
369 /* UTF-8 ",t,0x<16-bit TPGT>" + NULL Terminator */
370 scsi_name_len += 10;
371 /* Check for 4-byte padding */
372 padding = ((-scsi_name_len) & 3);
373 if (padding != 0)
374 scsi_name_len += padding;
375 /* Header size + Designation descriptor */
376 scsi_name_len += 4;
378 buf[off] =
379 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
380 buf[off++] |= 0x3; /* CODE SET == UTF-8 */
381 buf[off] = 0x80; /* Set PIV=1 */
382 /* Set ASSOCIATION == target port: 01b */
383 buf[off] |= 0x10;
384 /* DESIGNATOR TYPE == SCSI name string */
385 buf[off++] |= 0x8;
386 off += 2; /* Skip over Reserved and length */
388 * SCSI name string identifer containing, $FABRIC_MOD
389 * dependent information. For LIO-Target and iSCSI
390 * Target Port, this means "<iSCSI name>,t,0x<TPGT> in
391 * UTF-8 encoding.
393 tpgt = tpg->se_tpg_tfo->tpg_get_tag(tpg);
394 scsi_name_len = sprintf(&buf[off], "%s,t,0x%04x",
395 tpg->se_tpg_tfo->tpg_get_wwn(tpg), tpgt);
396 scsi_name_len += 1 /* Include NULL terminator */;
398 * The null-terminated, null-padded (see 4.4.2) SCSI
399 * NAME STRING field contains a UTF-8 format string.
400 * The number of bytes in the SCSI NAME STRING field
401 * (i.e., the value in the DESIGNATOR LENGTH field)
402 * shall be no larger than 256 and shall be a multiple
403 * of four.
405 if (padding)
406 scsi_name_len += padding;
408 buf[off-1] = scsi_name_len;
409 off += scsi_name_len;
410 /* Header size + Designation descriptor */
411 len += (scsi_name_len + 4);
413 buf[2] = ((len >> 8) & 0xff);
414 buf[3] = (len & 0xff); /* Page Length for VPD 0x83 */
415 return 0;
417 EXPORT_SYMBOL(spc_emulate_evpd_83);
419 static bool
420 spc_check_dev_wce(struct se_device *dev)
422 bool wce = false;
424 if (dev->transport->get_write_cache)
425 wce = dev->transport->get_write_cache(dev);
426 else if (dev->dev_attrib.emulate_write_cache > 0)
427 wce = true;
429 return wce;
432 /* Extended INQUIRY Data VPD Page */
433 static sense_reason_t
434 spc_emulate_evpd_86(struct se_cmd *cmd, unsigned char *buf)
436 struct se_device *dev = cmd->se_dev;
438 buf[3] = 0x3c;
439 /* Set HEADSUP, ORDSUP, SIMPSUP */
440 buf[5] = 0x07;
442 /* If WriteCache emulation is enabled, set V_SUP */
443 if (spc_check_dev_wce(dev))
444 buf[6] = 0x01;
445 return 0;
448 /* Block Limits VPD page */
449 static sense_reason_t
450 spc_emulate_evpd_b0(struct se_cmd *cmd, unsigned char *buf)
452 struct se_device *dev = cmd->se_dev;
453 u32 max_sectors;
454 int have_tp = 0;
457 * Following spc3r22 section 6.5.3 Block Limits VPD page, when
458 * emulate_tpu=1 or emulate_tpws=1 we will be expect a
459 * different page length for Thin Provisioning.
461 if (dev->dev_attrib.emulate_tpu || dev->dev_attrib.emulate_tpws)
462 have_tp = 1;
464 buf[0] = dev->transport->get_device_type(dev);
465 buf[3] = have_tp ? 0x3c : 0x10;
467 /* Set WSNZ to 1 */
468 buf[4] = 0x01;
470 * Set MAXIMUM COMPARE AND WRITE LENGTH
472 if (dev->dev_attrib.emulate_caw)
473 buf[5] = 0x01;
476 * Set OPTIMAL TRANSFER LENGTH GRANULARITY
478 put_unaligned_be16(1, &buf[6]);
481 * Set MAXIMUM TRANSFER LENGTH
483 max_sectors = min(dev->dev_attrib.fabric_max_sectors,
484 dev->dev_attrib.hw_max_sectors);
485 put_unaligned_be32(max_sectors, &buf[8]);
488 * Set OPTIMAL TRANSFER LENGTH
490 put_unaligned_be32(dev->dev_attrib.optimal_sectors, &buf[12]);
493 * Exit now if we don't support TP.
495 if (!have_tp)
496 goto max_write_same;
499 * Set MAXIMUM UNMAP LBA COUNT
501 put_unaligned_be32(dev->dev_attrib.max_unmap_lba_count, &buf[20]);
504 * Set MAXIMUM UNMAP BLOCK DESCRIPTOR COUNT
506 put_unaligned_be32(dev->dev_attrib.max_unmap_block_desc_count,
507 &buf[24]);
510 * Set OPTIMAL UNMAP GRANULARITY
512 put_unaligned_be32(dev->dev_attrib.unmap_granularity, &buf[28]);
515 * UNMAP GRANULARITY ALIGNMENT
517 put_unaligned_be32(dev->dev_attrib.unmap_granularity_alignment,
518 &buf[32]);
519 if (dev->dev_attrib.unmap_granularity_alignment != 0)
520 buf[32] |= 0x80; /* Set the UGAVALID bit */
523 * MAXIMUM WRITE SAME LENGTH
525 max_write_same:
526 put_unaligned_be64(dev->dev_attrib.max_write_same_len, &buf[36]);
528 return 0;
531 /* Block Device Characteristics VPD page */
532 static sense_reason_t
533 spc_emulate_evpd_b1(struct se_cmd *cmd, unsigned char *buf)
535 struct se_device *dev = cmd->se_dev;
537 buf[0] = dev->transport->get_device_type(dev);
538 buf[3] = 0x3c;
539 buf[5] = dev->dev_attrib.is_nonrot ? 1 : 0;
541 return 0;
544 /* Thin Provisioning VPD */
545 static sense_reason_t
546 spc_emulate_evpd_b2(struct se_cmd *cmd, unsigned char *buf)
548 struct se_device *dev = cmd->se_dev;
551 * From spc3r22 section 6.5.4 Thin Provisioning VPD page:
553 * The PAGE LENGTH field is defined in SPC-4. If the DP bit is set to
554 * zero, then the page length shall be set to 0004h. If the DP bit
555 * is set to one, then the page length shall be set to the value
556 * defined in table 162.
558 buf[0] = dev->transport->get_device_type(dev);
561 * Set Hardcoded length mentioned above for DP=0
563 put_unaligned_be16(0x0004, &buf[2]);
566 * The THRESHOLD EXPONENT field indicates the threshold set size in
567 * LBAs as a power of 2 (i.e., the threshold set size is equal to
568 * 2(threshold exponent)).
570 * Note that this is currently set to 0x00 as mkp says it will be
571 * changing again. We can enable this once it has settled in T10
572 * and is actually used by Linux/SCSI ML code.
574 buf[4] = 0x00;
577 * A TPU bit set to one indicates that the device server supports
578 * the UNMAP command (see 5.25). A TPU bit set to zero indicates
579 * that the device server does not support the UNMAP command.
581 if (dev->dev_attrib.emulate_tpu != 0)
582 buf[5] = 0x80;
585 * A TPWS bit set to one indicates that the device server supports
586 * the use of the WRITE SAME (16) command (see 5.42) to unmap LBAs.
587 * A TPWS bit set to zero indicates that the device server does not
588 * support the use of the WRITE SAME (16) command to unmap LBAs.
590 if (dev->dev_attrib.emulate_tpws != 0)
591 buf[5] |= 0x40;
593 return 0;
596 static sense_reason_t
597 spc_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf);
599 static struct {
600 uint8_t page;
601 sense_reason_t (*emulate)(struct se_cmd *, unsigned char *);
602 } evpd_handlers[] = {
603 { .page = 0x00, .emulate = spc_emulate_evpd_00 },
604 { .page = 0x80, .emulate = spc_emulate_evpd_80 },
605 { .page = 0x83, .emulate = spc_emulate_evpd_83 },
606 { .page = 0x86, .emulate = spc_emulate_evpd_86 },
607 { .page = 0xb0, .emulate = spc_emulate_evpd_b0 },
608 { .page = 0xb1, .emulate = spc_emulate_evpd_b1 },
609 { .page = 0xb2, .emulate = spc_emulate_evpd_b2 },
612 /* supported vital product data pages */
613 static sense_reason_t
614 spc_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf)
616 int p;
619 * Only report the INQUIRY EVPD=1 pages after a valid NAA
620 * Registered Extended LUN WWN has been set via ConfigFS
621 * during device creation/restart.
623 if (cmd->se_dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL) {
624 buf[3] = ARRAY_SIZE(evpd_handlers);
625 for (p = 0; p < ARRAY_SIZE(evpd_handlers); ++p)
626 buf[p + 4] = evpd_handlers[p].page;
629 return 0;
632 static sense_reason_t
633 spc_emulate_inquiry(struct se_cmd *cmd)
635 struct se_device *dev = cmd->se_dev;
636 struct se_portal_group *tpg = cmd->se_lun->lun_sep->sep_tpg;
637 unsigned char *rbuf;
638 unsigned char *cdb = cmd->t_task_cdb;
639 unsigned char buf[SE_INQUIRY_BUF];
640 sense_reason_t ret;
641 int p;
642 int len = 0;
644 memset(buf, 0, SE_INQUIRY_BUF);
646 if (dev == tpg->tpg_virt_lun0.lun_se_dev)
647 buf[0] = 0x3f; /* Not connected */
648 else
649 buf[0] = dev->transport->get_device_type(dev);
651 if (!(cdb[1] & 0x1)) {
652 if (cdb[2]) {
653 pr_err("INQUIRY with EVPD==0 but PAGE CODE=%02x\n",
654 cdb[2]);
655 ret = TCM_INVALID_CDB_FIELD;
656 goto out;
659 ret = spc_emulate_inquiry_std(cmd, buf);
660 len = buf[4] + 5;
661 goto out;
664 for (p = 0; p < ARRAY_SIZE(evpd_handlers); ++p) {
665 if (cdb[2] == evpd_handlers[p].page) {
666 buf[1] = cdb[2];
667 ret = evpd_handlers[p].emulate(cmd, buf);
668 len = get_unaligned_be16(&buf[2]) + 4;
669 goto out;
673 pr_err("Unknown VPD Code: 0x%02x\n", cdb[2]);
674 ret = TCM_INVALID_CDB_FIELD;
676 out:
677 rbuf = transport_kmap_data_sg(cmd);
678 if (rbuf) {
679 memcpy(rbuf, buf, min_t(u32, sizeof(buf), cmd->data_length));
680 transport_kunmap_data_sg(cmd);
683 if (!ret)
684 target_complete_cmd_with_length(cmd, GOOD, len);
685 return ret;
688 static int spc_modesense_rwrecovery(struct se_device *dev, u8 pc, u8 *p)
690 p[0] = 0x01;
691 p[1] = 0x0a;
693 /* No changeable values for now */
694 if (pc == 1)
695 goto out;
697 out:
698 return 12;
701 static int spc_modesense_control(struct se_device *dev, u8 pc, u8 *p)
703 p[0] = 0x0a;
704 p[1] = 0x0a;
706 /* No changeable values for now */
707 if (pc == 1)
708 goto out;
710 p[2] = 2;
712 * From spc4r23, 7.4.7 Control mode page
714 * The QUEUE ALGORITHM MODIFIER field (see table 368) specifies
715 * restrictions on the algorithm used for reordering commands
716 * having the SIMPLE task attribute (see SAM-4).
718 * Table 368 -- QUEUE ALGORITHM MODIFIER field
719 * Code Description
720 * 0h Restricted reordering
721 * 1h Unrestricted reordering allowed
722 * 2h to 7h Reserved
723 * 8h to Fh Vendor specific
725 * A value of zero in the QUEUE ALGORITHM MODIFIER field specifies that
726 * the device server shall order the processing sequence of commands
727 * having the SIMPLE task attribute such that data integrity is maintained
728 * for that I_T nexus (i.e., if the transmission of new SCSI transport protocol
729 * requests is halted at any time, the final value of all data observable
730 * on the medium shall be the same as if all the commands had been processed
731 * with the ORDERED task attribute).
733 * A value of one in the QUEUE ALGORITHM MODIFIER field specifies that the
734 * device server may reorder the processing sequence of commands having the
735 * SIMPLE task attribute in any manner. Any data integrity exposures related to
736 * command sequence order shall be explicitly handled by the application client
737 * through the selection of appropriate ommands and task attributes.
739 p[3] = (dev->dev_attrib.emulate_rest_reord == 1) ? 0x00 : 0x10;
741 * From spc4r17, section 7.4.6 Control mode Page
743 * Unit Attention interlocks control (UN_INTLCK_CTRL) to code 00b
745 * 00b: The logical unit shall clear any unit attention condition
746 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
747 * status and shall not establish a unit attention condition when a com-
748 * mand is completed with BUSY, TASK SET FULL, or RESERVATION CONFLICT
749 * status.
751 * 10b: The logical unit shall not clear any unit attention condition
752 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
753 * status and shall not establish a unit attention condition when
754 * a command is completed with BUSY, TASK SET FULL, or RESERVATION
755 * CONFLICT status.
757 * 11b a The logical unit shall not clear any unit attention condition
758 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
759 * status and shall establish a unit attention condition for the
760 * initiator port associated with the I_T nexus on which the BUSY,
761 * TASK SET FULL, or RESERVATION CONFLICT status is being returned.
762 * Depending on the status, the additional sense code shall be set to
763 * PREVIOUS BUSY STATUS, PREVIOUS TASK SET FULL STATUS, or PREVIOUS
764 * RESERVATION CONFLICT STATUS. Until it is cleared by a REQUEST SENSE
765 * command, a unit attention condition shall be established only once
766 * for a BUSY, TASK SET FULL, or RESERVATION CONFLICT status regardless
767 * to the number of commands completed with one of those status codes.
769 p[4] = (dev->dev_attrib.emulate_ua_intlck_ctrl == 2) ? 0x30 :
770 (dev->dev_attrib.emulate_ua_intlck_ctrl == 1) ? 0x20 : 0x00;
772 * From spc4r17, section 7.4.6 Control mode Page
774 * Task Aborted Status (TAS) bit set to zero.
776 * A task aborted status (TAS) bit set to zero specifies that aborted
777 * tasks shall be terminated by the device server without any response
778 * to the application client. A TAS bit set to one specifies that tasks
779 * aborted by the actions of an I_T nexus other than the I_T nexus on
780 * which the command was received shall be completed with TASK ABORTED
781 * status (see SAM-4).
783 p[5] = (dev->dev_attrib.emulate_tas) ? 0x40 : 0x00;
784 p[8] = 0xff;
785 p[9] = 0xff;
786 p[11] = 30;
788 out:
789 return 12;
792 static int spc_modesense_caching(struct se_device *dev, u8 pc, u8 *p)
794 p[0] = 0x08;
795 p[1] = 0x12;
797 /* No changeable values for now */
798 if (pc == 1)
799 goto out;
801 if (spc_check_dev_wce(dev))
802 p[2] = 0x04; /* Write Cache Enable */
803 p[12] = 0x20; /* Disabled Read Ahead */
805 out:
806 return 20;
809 static int spc_modesense_informational_exceptions(struct se_device *dev, u8 pc, unsigned char *p)
811 p[0] = 0x1c;
812 p[1] = 0x0a;
814 /* No changeable values for now */
815 if (pc == 1)
816 goto out;
818 out:
819 return 12;
822 static struct {
823 uint8_t page;
824 uint8_t subpage;
825 int (*emulate)(struct se_device *, u8, unsigned char *);
826 } modesense_handlers[] = {
827 { .page = 0x01, .subpage = 0x00, .emulate = spc_modesense_rwrecovery },
828 { .page = 0x08, .subpage = 0x00, .emulate = spc_modesense_caching },
829 { .page = 0x0a, .subpage = 0x00, .emulate = spc_modesense_control },
830 { .page = 0x1c, .subpage = 0x00, .emulate = spc_modesense_informational_exceptions },
833 static void spc_modesense_write_protect(unsigned char *buf, int type)
836 * I believe that the WP bit (bit 7) in the mode header is the same for
837 * all device types..
839 switch (type) {
840 case TYPE_DISK:
841 case TYPE_TAPE:
842 default:
843 buf[0] |= 0x80; /* WP bit */
844 break;
848 static void spc_modesense_dpofua(unsigned char *buf, int type)
850 switch (type) {
851 case TYPE_DISK:
852 buf[0] |= 0x10; /* DPOFUA bit */
853 break;
854 default:
855 break;
859 static int spc_modesense_blockdesc(unsigned char *buf, u64 blocks, u32 block_size)
861 *buf++ = 8;
862 put_unaligned_be32(min(blocks, 0xffffffffull), buf);
863 buf += 4;
864 put_unaligned_be32(block_size, buf);
865 return 9;
868 static int spc_modesense_long_blockdesc(unsigned char *buf, u64 blocks, u32 block_size)
870 if (blocks <= 0xffffffff)
871 return spc_modesense_blockdesc(buf + 3, blocks, block_size) + 3;
873 *buf++ = 1; /* LONGLBA */
874 buf += 2;
875 *buf++ = 16;
876 put_unaligned_be64(blocks, buf);
877 buf += 12;
878 put_unaligned_be32(block_size, buf);
880 return 17;
883 static sense_reason_t spc_emulate_modesense(struct se_cmd *cmd)
885 struct se_device *dev = cmd->se_dev;
886 char *cdb = cmd->t_task_cdb;
887 unsigned char buf[SE_MODE_PAGE_BUF], *rbuf;
888 int type = dev->transport->get_device_type(dev);
889 int ten = (cmd->t_task_cdb[0] == MODE_SENSE_10);
890 bool dbd = !!(cdb[1] & 0x08);
891 bool llba = ten ? !!(cdb[1] & 0x10) : false;
892 u8 pc = cdb[2] >> 6;
893 u8 page = cdb[2] & 0x3f;
894 u8 subpage = cdb[3];
895 int length = 0;
896 int ret;
897 int i;
899 memset(buf, 0, SE_MODE_PAGE_BUF);
902 * Skip over MODE DATA LENGTH + MEDIUM TYPE fields to byte 3 for
903 * MODE_SENSE_10 and byte 2 for MODE_SENSE (6).
905 length = ten ? 3 : 2;
907 /* DEVICE-SPECIFIC PARAMETER */
908 if ((cmd->se_lun->lun_access & TRANSPORT_LUNFLAGS_READ_ONLY) ||
909 (cmd->se_deve &&
910 (cmd->se_deve->lun_flags & TRANSPORT_LUNFLAGS_READ_ONLY)))
911 spc_modesense_write_protect(&buf[length], type);
913 if ((spc_check_dev_wce(dev)) &&
914 (dev->dev_attrib.emulate_fua_write > 0))
915 spc_modesense_dpofua(&buf[length], type);
917 ++length;
919 /* BLOCK DESCRIPTOR */
922 * For now we only include a block descriptor for disk (SBC)
923 * devices; other command sets use a slightly different format.
925 if (!dbd && type == TYPE_DISK) {
926 u64 blocks = dev->transport->get_blocks(dev);
927 u32 block_size = dev->dev_attrib.block_size;
929 if (ten) {
930 if (llba) {
931 length += spc_modesense_long_blockdesc(&buf[length],
932 blocks, block_size);
933 } else {
934 length += 3;
935 length += spc_modesense_blockdesc(&buf[length],
936 blocks, block_size);
938 } else {
939 length += spc_modesense_blockdesc(&buf[length], blocks,
940 block_size);
942 } else {
943 if (ten)
944 length += 4;
945 else
946 length += 1;
949 if (page == 0x3f) {
950 if (subpage != 0x00 && subpage != 0xff) {
951 pr_warn("MODE_SENSE: Invalid subpage code: 0x%02x\n", subpage);
952 return TCM_INVALID_CDB_FIELD;
955 for (i = 0; i < ARRAY_SIZE(modesense_handlers); ++i) {
957 * Tricky way to say all subpage 00h for
958 * subpage==0, all subpages for subpage==0xff
959 * (and we just checked above that those are
960 * the only two possibilities).
962 if ((modesense_handlers[i].subpage & ~subpage) == 0) {
963 ret = modesense_handlers[i].emulate(dev, pc, &buf[length]);
964 if (!ten && length + ret >= 255)
965 break;
966 length += ret;
970 goto set_length;
973 for (i = 0; i < ARRAY_SIZE(modesense_handlers); ++i)
974 if (modesense_handlers[i].page == page &&
975 modesense_handlers[i].subpage == subpage) {
976 length += modesense_handlers[i].emulate(dev, pc, &buf[length]);
977 goto set_length;
981 * We don't intend to implement:
982 * - obsolete page 03h "format parameters" (checked by Solaris)
984 if (page != 0x03)
985 pr_err("MODE SENSE: unimplemented page/subpage: 0x%02x/0x%02x\n",
986 page, subpage);
988 return TCM_UNKNOWN_MODE_PAGE;
990 set_length:
991 if (ten)
992 put_unaligned_be16(length - 2, buf);
993 else
994 buf[0] = length - 1;
996 rbuf = transport_kmap_data_sg(cmd);
997 if (rbuf) {
998 memcpy(rbuf, buf, min_t(u32, SE_MODE_PAGE_BUF, cmd->data_length));
999 transport_kunmap_data_sg(cmd);
1002 target_complete_cmd_with_length(cmd, GOOD, length);
1003 return 0;
1006 static sense_reason_t spc_emulate_modeselect(struct se_cmd *cmd)
1008 struct se_device *dev = cmd->se_dev;
1009 char *cdb = cmd->t_task_cdb;
1010 bool ten = cdb[0] == MODE_SELECT_10;
1011 int off = ten ? 8 : 4;
1012 bool pf = !!(cdb[1] & 0x10);
1013 u8 page, subpage;
1014 unsigned char *buf;
1015 unsigned char tbuf[SE_MODE_PAGE_BUF];
1016 int length;
1017 int ret = 0;
1018 int i;
1020 if (!cmd->data_length) {
1021 target_complete_cmd(cmd, GOOD);
1022 return 0;
1025 if (cmd->data_length < off + 2)
1026 return TCM_PARAMETER_LIST_LENGTH_ERROR;
1028 buf = transport_kmap_data_sg(cmd);
1029 if (!buf)
1030 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1032 if (!pf) {
1033 ret = TCM_INVALID_CDB_FIELD;
1034 goto out;
1037 page = buf[off] & 0x3f;
1038 subpage = buf[off] & 0x40 ? buf[off + 1] : 0;
1040 for (i = 0; i < ARRAY_SIZE(modesense_handlers); ++i)
1041 if (modesense_handlers[i].page == page &&
1042 modesense_handlers[i].subpage == subpage) {
1043 memset(tbuf, 0, SE_MODE_PAGE_BUF);
1044 length = modesense_handlers[i].emulate(dev, 0, tbuf);
1045 goto check_contents;
1048 ret = TCM_UNKNOWN_MODE_PAGE;
1049 goto out;
1051 check_contents:
1052 if (cmd->data_length < off + length) {
1053 ret = TCM_PARAMETER_LIST_LENGTH_ERROR;
1054 goto out;
1057 if (memcmp(buf + off, tbuf, length))
1058 ret = TCM_INVALID_PARAMETER_LIST;
1060 out:
1061 transport_kunmap_data_sg(cmd);
1063 if (!ret)
1064 target_complete_cmd(cmd, GOOD);
1065 return ret;
1068 static sense_reason_t spc_emulate_request_sense(struct se_cmd *cmd)
1070 unsigned char *cdb = cmd->t_task_cdb;
1071 unsigned char *rbuf;
1072 u8 ua_asc = 0, ua_ascq = 0;
1073 unsigned char buf[SE_SENSE_BUF];
1075 memset(buf, 0, SE_SENSE_BUF);
1077 if (cdb[1] & 0x01) {
1078 pr_err("REQUEST_SENSE description emulation not"
1079 " supported\n");
1080 return TCM_INVALID_CDB_FIELD;
1083 rbuf = transport_kmap_data_sg(cmd);
1084 if (!rbuf)
1085 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1087 if (!core_scsi3_ua_clear_for_request_sense(cmd, &ua_asc, &ua_ascq)) {
1089 * CURRENT ERROR, UNIT ATTENTION
1091 buf[0] = 0x70;
1092 buf[SPC_SENSE_KEY_OFFSET] = UNIT_ATTENTION;
1095 * The Additional Sense Code (ASC) from the UNIT ATTENTION
1097 buf[SPC_ASC_KEY_OFFSET] = ua_asc;
1098 buf[SPC_ASCQ_KEY_OFFSET] = ua_ascq;
1099 buf[7] = 0x0A;
1100 } else {
1102 * CURRENT ERROR, NO SENSE
1104 buf[0] = 0x70;
1105 buf[SPC_SENSE_KEY_OFFSET] = NO_SENSE;
1108 * NO ADDITIONAL SENSE INFORMATION
1110 buf[SPC_ASC_KEY_OFFSET] = 0x00;
1111 buf[7] = 0x0A;
1114 memcpy(rbuf, buf, min_t(u32, sizeof(buf), cmd->data_length));
1115 transport_kunmap_data_sg(cmd);
1117 target_complete_cmd(cmd, GOOD);
1118 return 0;
1121 sense_reason_t spc_emulate_report_luns(struct se_cmd *cmd)
1123 struct se_dev_entry *deve;
1124 struct se_session *sess = cmd->se_sess;
1125 unsigned char *buf;
1126 u32 lun_count = 0, offset = 8, i;
1128 if (cmd->data_length < 16) {
1129 pr_warn("REPORT LUNS allocation length %u too small\n",
1130 cmd->data_length);
1131 return TCM_INVALID_CDB_FIELD;
1134 buf = transport_kmap_data_sg(cmd);
1135 if (!buf)
1136 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1139 * If no struct se_session pointer is present, this struct se_cmd is
1140 * coming via a target_core_mod PASSTHROUGH op, and not through
1141 * a $FABRIC_MOD. In that case, report LUN=0 only.
1143 if (!sess) {
1144 int_to_scsilun(0, (struct scsi_lun *)&buf[offset]);
1145 lun_count = 1;
1146 goto done;
1149 spin_lock_irq(&sess->se_node_acl->device_list_lock);
1150 for (i = 0; i < TRANSPORT_MAX_LUNS_PER_TPG; i++) {
1151 deve = sess->se_node_acl->device_list[i];
1152 if (!(deve->lun_flags & TRANSPORT_LUNFLAGS_INITIATOR_ACCESS))
1153 continue;
1155 * We determine the correct LUN LIST LENGTH even once we
1156 * have reached the initial allocation length.
1157 * See SPC2-R20 7.19.
1159 lun_count++;
1160 if ((offset + 8) > cmd->data_length)
1161 continue;
1163 int_to_scsilun(deve->mapped_lun, (struct scsi_lun *)&buf[offset]);
1164 offset += 8;
1166 spin_unlock_irq(&sess->se_node_acl->device_list_lock);
1169 * See SPC3 r07, page 159.
1171 done:
1172 lun_count *= 8;
1173 buf[0] = ((lun_count >> 24) & 0xff);
1174 buf[1] = ((lun_count >> 16) & 0xff);
1175 buf[2] = ((lun_count >> 8) & 0xff);
1176 buf[3] = (lun_count & 0xff);
1177 transport_kunmap_data_sg(cmd);
1179 target_complete_cmd_with_length(cmd, GOOD, 8 + lun_count * 8);
1180 return 0;
1182 EXPORT_SYMBOL(spc_emulate_report_luns);
1184 static sense_reason_t
1185 spc_emulate_testunitready(struct se_cmd *cmd)
1187 target_complete_cmd(cmd, GOOD);
1188 return 0;
1191 sense_reason_t
1192 spc_parse_cdb(struct se_cmd *cmd, unsigned int *size)
1194 struct se_device *dev = cmd->se_dev;
1195 unsigned char *cdb = cmd->t_task_cdb;
1197 switch (cdb[0]) {
1198 case MODE_SELECT:
1199 *size = cdb[4];
1200 cmd->execute_cmd = spc_emulate_modeselect;
1201 break;
1202 case MODE_SELECT_10:
1203 *size = (cdb[7] << 8) + cdb[8];
1204 cmd->execute_cmd = spc_emulate_modeselect;
1205 break;
1206 case MODE_SENSE:
1207 *size = cdb[4];
1208 cmd->execute_cmd = spc_emulate_modesense;
1209 break;
1210 case MODE_SENSE_10:
1211 *size = (cdb[7] << 8) + cdb[8];
1212 cmd->execute_cmd = spc_emulate_modesense;
1213 break;
1214 case LOG_SELECT:
1215 case LOG_SENSE:
1216 *size = (cdb[7] << 8) + cdb[8];
1217 break;
1218 case PERSISTENT_RESERVE_IN:
1219 *size = (cdb[7] << 8) + cdb[8];
1220 cmd->execute_cmd = target_scsi3_emulate_pr_in;
1221 break;
1222 case PERSISTENT_RESERVE_OUT:
1223 *size = (cdb[7] << 8) + cdb[8];
1224 cmd->execute_cmd = target_scsi3_emulate_pr_out;
1225 break;
1226 case RELEASE:
1227 case RELEASE_10:
1228 if (cdb[0] == RELEASE_10)
1229 *size = (cdb[7] << 8) | cdb[8];
1230 else
1231 *size = cmd->data_length;
1233 cmd->execute_cmd = target_scsi2_reservation_release;
1234 break;
1235 case RESERVE:
1236 case RESERVE_10:
1238 * The SPC-2 RESERVE does not contain a size in the SCSI CDB.
1239 * Assume the passthrough or $FABRIC_MOD will tell us about it.
1241 if (cdb[0] == RESERVE_10)
1242 *size = (cdb[7] << 8) | cdb[8];
1243 else
1244 *size = cmd->data_length;
1246 cmd->execute_cmd = target_scsi2_reservation_reserve;
1247 break;
1248 case REQUEST_SENSE:
1249 *size = cdb[4];
1250 cmd->execute_cmd = spc_emulate_request_sense;
1251 break;
1252 case INQUIRY:
1253 *size = (cdb[3] << 8) + cdb[4];
1256 * Do implict HEAD_OF_QUEUE processing for INQUIRY.
1257 * See spc4r17 section 5.3
1259 cmd->sam_task_attr = MSG_HEAD_TAG;
1260 cmd->execute_cmd = spc_emulate_inquiry;
1261 break;
1262 case SECURITY_PROTOCOL_IN:
1263 case SECURITY_PROTOCOL_OUT:
1264 *size = (cdb[6] << 24) | (cdb[7] << 16) | (cdb[8] << 8) | cdb[9];
1265 break;
1266 case EXTENDED_COPY:
1267 *size = get_unaligned_be32(&cdb[10]);
1268 cmd->execute_cmd = target_do_xcopy;
1269 break;
1270 case RECEIVE_COPY_RESULTS:
1271 *size = get_unaligned_be32(&cdb[10]);
1272 cmd->execute_cmd = target_do_receive_copy_results;
1273 break;
1274 case READ_ATTRIBUTE:
1275 case WRITE_ATTRIBUTE:
1276 *size = (cdb[10] << 24) | (cdb[11] << 16) |
1277 (cdb[12] << 8) | cdb[13];
1278 break;
1279 case RECEIVE_DIAGNOSTIC:
1280 case SEND_DIAGNOSTIC:
1281 *size = (cdb[3] << 8) | cdb[4];
1282 break;
1283 case WRITE_BUFFER:
1284 *size = (cdb[6] << 16) + (cdb[7] << 8) + cdb[8];
1285 break;
1286 case REPORT_LUNS:
1287 cmd->execute_cmd = spc_emulate_report_luns;
1288 *size = (cdb[6] << 24) | (cdb[7] << 16) | (cdb[8] << 8) | cdb[9];
1290 * Do implict HEAD_OF_QUEUE processing for REPORT_LUNS
1291 * See spc4r17 section 5.3
1293 cmd->sam_task_attr = MSG_HEAD_TAG;
1294 break;
1295 case TEST_UNIT_READY:
1296 cmd->execute_cmd = spc_emulate_testunitready;
1297 *size = 0;
1298 break;
1299 case MAINTENANCE_IN:
1300 if (dev->transport->get_device_type(dev) != TYPE_ROM) {
1302 * MAINTENANCE_IN from SCC-2
1303 * Check for emulated MI_REPORT_TARGET_PGS
1305 if ((cdb[1] & 0x1f) == MI_REPORT_TARGET_PGS) {
1306 cmd->execute_cmd =
1307 target_emulate_report_target_port_groups;
1309 *size = get_unaligned_be32(&cdb[6]);
1310 } else {
1312 * GPCMD_SEND_KEY from multi media commands
1314 *size = get_unaligned_be16(&cdb[8]);
1316 break;
1317 case MAINTENANCE_OUT:
1318 if (dev->transport->get_device_type(dev) != TYPE_ROM) {
1320 * MAINTENANCE_OUT from SCC-2
1321 * Check for emulated MO_SET_TARGET_PGS.
1323 if (cdb[1] == MO_SET_TARGET_PGS) {
1324 cmd->execute_cmd =
1325 target_emulate_set_target_port_groups;
1327 *size = get_unaligned_be32(&cdb[6]);
1328 } else {
1330 * GPCMD_SEND_KEY from multi media commands
1332 *size = get_unaligned_be16(&cdb[8]);
1334 break;
1335 default:
1336 pr_warn("TARGET_CORE[%s]: Unsupported SCSI Opcode"
1337 " 0x%02x, sending CHECK_CONDITION.\n",
1338 cmd->se_tfo->get_fabric_name(), cdb[0]);
1339 return TCM_UNSUPPORTED_SCSI_OPCODE;
1342 return 0;
1344 EXPORT_SYMBOL(spc_parse_cdb);