Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/dtor/input
[linux-btrfs-devel.git] / drivers / target / target_core_cdb.c
blob38535eb13929ba5242e128629abfeadae409fc7a
1 /*
2 * CDB emulation for non-READ/WRITE commands.
4 * Copyright (c) 2002, 2003, 2004, 2005 PyX Technologies, Inc.
5 * Copyright (c) 2005, 2006, 2007 SBE, Inc.
6 * Copyright (c) 2007-2010 Rising Tide Systems
7 * Copyright (c) 2008-2010 Linux-iSCSI.org
9 * Nicholas A. Bellinger <nab@kernel.org>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
26 #include <linux/kernel.h>
27 #include <linux/module.h>
28 #include <asm/unaligned.h>
29 #include <scsi/scsi.h>
31 #include <target/target_core_base.h>
32 #include <target/target_core_transport.h>
33 #include <target/target_core_fabric_ops.h>
34 #include "target_core_ua.h"
36 static void
37 target_fill_alua_data(struct se_port *port, unsigned char *buf)
39 struct t10_alua_tg_pt_gp *tg_pt_gp;
40 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
43 * Set SCCS for MAINTENANCE_IN + REPORT_TARGET_PORT_GROUPS.
45 buf[5] = 0x80;
48 * Set TPGS field for explict and/or implict ALUA access type
49 * and opteration.
51 * See spc4r17 section 6.4.2 Table 135
53 if (!port)
54 return;
55 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
56 if (!tg_pt_gp_mem)
57 return;
59 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
60 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
61 if (tg_pt_gp)
62 buf[5] |= tg_pt_gp->tg_pt_gp_alua_access_type;
63 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
66 static int
67 target_emulate_inquiry_std(struct se_cmd *cmd)
69 struct se_lun *lun = cmd->se_lun;
70 struct se_device *dev = cmd->se_dev;
71 struct se_portal_group *tpg = lun->lun_sep->sep_tpg;
72 unsigned char *buf;
75 * Make sure we at least have 6 bytes of INQUIRY response
76 * payload going back for EVPD=0
78 if (cmd->data_length < 6) {
79 pr_err("SCSI Inquiry payload length: %u"
80 " too small for EVPD=0\n", cmd->data_length);
81 return -EINVAL;
84 buf = transport_kmap_first_data_page(cmd);
86 if (dev == tpg->tpg_virt_lun0.lun_se_dev) {
87 buf[0] = 0x3f; /* Not connected */
88 } else {
89 buf[0] = dev->transport->get_device_type(dev);
90 if (buf[0] == TYPE_TAPE)
91 buf[1] = 0x80;
93 buf[2] = dev->transport->get_device_rev(dev);
96 * Enable SCCS and TPGS fields for Emulated ALUA
98 if (dev->se_sub_dev->t10_alua.alua_type == SPC3_ALUA_EMULATED)
99 target_fill_alua_data(lun->lun_sep, buf);
101 if (cmd->data_length < 8) {
102 buf[4] = 1; /* Set additional length to 1 */
103 goto out;
106 buf[7] = 0x32; /* Sync=1 and CmdQue=1 */
109 * Do not include vendor, product, reversion info in INQUIRY
110 * response payload for cdbs with a small allocation length.
112 if (cmd->data_length < 36) {
113 buf[4] = 3; /* Set additional length to 3 */
114 goto out;
117 snprintf((unsigned char *)&buf[8], 8, "LIO-ORG");
118 snprintf((unsigned char *)&buf[16], 16, "%s",
119 &dev->se_sub_dev->t10_wwn.model[0]);
120 snprintf((unsigned char *)&buf[32], 4, "%s",
121 &dev->se_sub_dev->t10_wwn.revision[0]);
122 buf[4] = 31; /* Set additional length to 31 */
124 out:
125 transport_kunmap_first_data_page(cmd);
126 return 0;
129 /* unit serial number */
130 static int
131 target_emulate_evpd_80(struct se_cmd *cmd, unsigned char *buf)
133 struct se_device *dev = cmd->se_dev;
134 u16 len = 0;
136 if (dev->se_sub_dev->su_dev_flags &
137 SDF_EMULATED_VPD_UNIT_SERIAL) {
138 u32 unit_serial_len;
140 unit_serial_len =
141 strlen(&dev->se_sub_dev->t10_wwn.unit_serial[0]);
142 unit_serial_len++; /* For NULL Terminator */
144 if (((len + 4) + unit_serial_len) > cmd->data_length) {
145 len += unit_serial_len;
146 buf[2] = ((len >> 8) & 0xff);
147 buf[3] = (len & 0xff);
148 return 0;
150 len += sprintf((unsigned char *)&buf[4], "%s",
151 &dev->se_sub_dev->t10_wwn.unit_serial[0]);
152 len++; /* Extra Byte for NULL Terminator */
153 buf[3] = len;
155 return 0;
158 static void
159 target_parse_naa_6h_vendor_specific(struct se_device *dev, unsigned char *buf)
161 unsigned char *p = &dev->se_sub_dev->t10_wwn.unit_serial[0];
162 int cnt;
163 bool next = true;
166 * Generate up to 36 bits of VENDOR SPECIFIC IDENTIFIER starting on
167 * byte 3 bit 3-0 for NAA IEEE Registered Extended DESIGNATOR field
168 * format, followed by 64 bits of VENDOR SPECIFIC IDENTIFIER EXTENSION
169 * to complete the payload. These are based from VPD=0x80 PRODUCT SERIAL
170 * NUMBER set via vpd_unit_serial in target_core_configfs.c to ensure
171 * per device uniqeness.
173 for (cnt = 0; *p && cnt < 13; p++) {
174 int val = hex_to_bin(*p);
176 if (val < 0)
177 continue;
179 if (next) {
180 next = false;
181 buf[cnt++] |= val;
182 } else {
183 next = true;
184 buf[cnt] = val << 4;
190 * Device identification VPD, for a complete list of
191 * DESIGNATOR TYPEs see spc4r17 Table 459.
193 static int
194 target_emulate_evpd_83(struct se_cmd *cmd, unsigned char *buf)
196 struct se_device *dev = cmd->se_dev;
197 struct se_lun *lun = cmd->se_lun;
198 struct se_port *port = NULL;
199 struct se_portal_group *tpg = NULL;
200 struct t10_alua_lu_gp_member *lu_gp_mem;
201 struct t10_alua_tg_pt_gp *tg_pt_gp;
202 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
203 unsigned char *prod = &dev->se_sub_dev->t10_wwn.model[0];
204 u32 prod_len;
205 u32 unit_serial_len, off = 0;
206 u16 len = 0, id_len;
208 off = 4;
211 * NAA IEEE Registered Extended Assigned designator format, see
212 * spc4r17 section 7.7.3.6.5
214 * We depend upon a target_core_mod/ConfigFS provided
215 * /sys/kernel/config/target/core/$HBA/$DEV/wwn/vpd_unit_serial
216 * value in order to return the NAA id.
218 if (!(dev->se_sub_dev->su_dev_flags & SDF_EMULATED_VPD_UNIT_SERIAL))
219 goto check_t10_vend_desc;
221 if (off + 20 > cmd->data_length)
222 goto check_t10_vend_desc;
224 /* CODE SET == Binary */
225 buf[off++] = 0x1;
227 /* Set ASSOCIATION == addressed logical unit: 0)b */
228 buf[off] = 0x00;
230 /* Identifier/Designator type == NAA identifier */
231 buf[off++] |= 0x3;
232 off++;
234 /* Identifier/Designator length */
235 buf[off++] = 0x10;
238 * Start NAA IEEE Registered Extended Identifier/Designator
240 buf[off++] = (0x6 << 4);
243 * Use OpenFabrics IEEE Company ID: 00 14 05
245 buf[off++] = 0x01;
246 buf[off++] = 0x40;
247 buf[off] = (0x5 << 4);
250 * Return ConfigFS Unit Serial Number information for
251 * VENDOR_SPECIFIC_IDENTIFIER and
252 * VENDOR_SPECIFIC_IDENTIFIER_EXTENTION
254 target_parse_naa_6h_vendor_specific(dev, &buf[off]);
256 len = 20;
257 off = (len + 4);
259 check_t10_vend_desc:
261 * T10 Vendor Identifier Page, see spc4r17 section 7.7.3.4
263 id_len = 8; /* For Vendor field */
264 prod_len = 4; /* For VPD Header */
265 prod_len += 8; /* For Vendor field */
266 prod_len += strlen(prod);
267 prod_len++; /* For : */
269 if (dev->se_sub_dev->su_dev_flags &
270 SDF_EMULATED_VPD_UNIT_SERIAL) {
271 unit_serial_len =
272 strlen(&dev->se_sub_dev->t10_wwn.unit_serial[0]);
273 unit_serial_len++; /* For NULL Terminator */
275 if ((len + (id_len + 4) +
276 (prod_len + unit_serial_len)) >
277 cmd->data_length) {
278 len += (prod_len + unit_serial_len);
279 goto check_port;
281 id_len += sprintf((unsigned char *)&buf[off+12],
282 "%s:%s", prod,
283 &dev->se_sub_dev->t10_wwn.unit_serial[0]);
285 buf[off] = 0x2; /* ASCII */
286 buf[off+1] = 0x1; /* T10 Vendor ID */
287 buf[off+2] = 0x0;
288 memcpy((unsigned char *)&buf[off+4], "LIO-ORG", 8);
289 /* Extra Byte for NULL Terminator */
290 id_len++;
291 /* Identifier Length */
292 buf[off+3] = id_len;
293 /* Header size for Designation descriptor */
294 len += (id_len + 4);
295 off += (id_len + 4);
297 * struct se_port is only set for INQUIRY VPD=1 through $FABRIC_MOD
299 check_port:
300 port = lun->lun_sep;
301 if (port) {
302 struct t10_alua_lu_gp *lu_gp;
303 u32 padding, scsi_name_len;
304 u16 lu_gp_id = 0;
305 u16 tg_pt_gp_id = 0;
306 u16 tpgt;
308 tpg = port->sep_tpg;
310 * Relative target port identifer, see spc4r17
311 * section 7.7.3.7
313 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
314 * section 7.5.1 Table 362
316 if (((len + 4) + 8) > cmd->data_length) {
317 len += 8;
318 goto check_tpgi;
320 buf[off] =
321 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
322 buf[off++] |= 0x1; /* CODE SET == Binary */
323 buf[off] = 0x80; /* Set PIV=1 */
324 /* Set ASSOCIATION == target port: 01b */
325 buf[off] |= 0x10;
326 /* DESIGNATOR TYPE == Relative target port identifer */
327 buf[off++] |= 0x4;
328 off++; /* Skip over Reserved */
329 buf[off++] = 4; /* DESIGNATOR LENGTH */
330 /* Skip over Obsolete field in RTPI payload
331 * in Table 472 */
332 off += 2;
333 buf[off++] = ((port->sep_rtpi >> 8) & 0xff);
334 buf[off++] = (port->sep_rtpi & 0xff);
335 len += 8; /* Header size + Designation descriptor */
337 * Target port group identifier, see spc4r17
338 * section 7.7.3.8
340 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
341 * section 7.5.1 Table 362
343 check_tpgi:
344 if (dev->se_sub_dev->t10_alua.alua_type !=
345 SPC3_ALUA_EMULATED)
346 goto check_scsi_name;
348 if (((len + 4) + 8) > cmd->data_length) {
349 len += 8;
350 goto check_lu_gp;
352 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
353 if (!tg_pt_gp_mem)
354 goto check_lu_gp;
356 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
357 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
358 if (!tg_pt_gp) {
359 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
360 goto check_lu_gp;
362 tg_pt_gp_id = tg_pt_gp->tg_pt_gp_id;
363 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
365 buf[off] =
366 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
367 buf[off++] |= 0x1; /* CODE SET == Binary */
368 buf[off] = 0x80; /* Set PIV=1 */
369 /* Set ASSOCIATION == target port: 01b */
370 buf[off] |= 0x10;
371 /* DESIGNATOR TYPE == Target port group identifier */
372 buf[off++] |= 0x5;
373 off++; /* Skip over Reserved */
374 buf[off++] = 4; /* DESIGNATOR LENGTH */
375 off += 2; /* Skip over Reserved Field */
376 buf[off++] = ((tg_pt_gp_id >> 8) & 0xff);
377 buf[off++] = (tg_pt_gp_id & 0xff);
378 len += 8; /* Header size + Designation descriptor */
380 * Logical Unit Group identifier, see spc4r17
381 * section 7.7.3.8
383 check_lu_gp:
384 if (((len + 4) + 8) > cmd->data_length) {
385 len += 8;
386 goto check_scsi_name;
388 lu_gp_mem = dev->dev_alua_lu_gp_mem;
389 if (!lu_gp_mem)
390 goto check_scsi_name;
392 spin_lock(&lu_gp_mem->lu_gp_mem_lock);
393 lu_gp = lu_gp_mem->lu_gp;
394 if (!lu_gp) {
395 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
396 goto check_scsi_name;
398 lu_gp_id = lu_gp->lu_gp_id;
399 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
401 buf[off++] |= 0x1; /* CODE SET == Binary */
402 /* DESIGNATOR TYPE == Logical Unit Group identifier */
403 buf[off++] |= 0x6;
404 off++; /* Skip over Reserved */
405 buf[off++] = 4; /* DESIGNATOR LENGTH */
406 off += 2; /* Skip over Reserved Field */
407 buf[off++] = ((lu_gp_id >> 8) & 0xff);
408 buf[off++] = (lu_gp_id & 0xff);
409 len += 8; /* Header size + Designation descriptor */
411 * SCSI name string designator, see spc4r17
412 * section 7.7.3.11
414 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
415 * section 7.5.1 Table 362
417 check_scsi_name:
418 scsi_name_len = strlen(tpg->se_tpg_tfo->tpg_get_wwn(tpg));
419 /* UTF-8 ",t,0x<16-bit TPGT>" + NULL Terminator */
420 scsi_name_len += 10;
421 /* Check for 4-byte padding */
422 padding = ((-scsi_name_len) & 3);
423 if (padding != 0)
424 scsi_name_len += padding;
425 /* Header size + Designation descriptor */
426 scsi_name_len += 4;
428 if (((len + 4) + scsi_name_len) > cmd->data_length) {
429 len += scsi_name_len;
430 goto set_len;
432 buf[off] =
433 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
434 buf[off++] |= 0x3; /* CODE SET == UTF-8 */
435 buf[off] = 0x80; /* Set PIV=1 */
436 /* Set ASSOCIATION == target port: 01b */
437 buf[off] |= 0x10;
438 /* DESIGNATOR TYPE == SCSI name string */
439 buf[off++] |= 0x8;
440 off += 2; /* Skip over Reserved and length */
442 * SCSI name string identifer containing, $FABRIC_MOD
443 * dependent information. For LIO-Target and iSCSI
444 * Target Port, this means "<iSCSI name>,t,0x<TPGT> in
445 * UTF-8 encoding.
447 tpgt = tpg->se_tpg_tfo->tpg_get_tag(tpg);
448 scsi_name_len = sprintf(&buf[off], "%s,t,0x%04x",
449 tpg->se_tpg_tfo->tpg_get_wwn(tpg), tpgt);
450 scsi_name_len += 1 /* Include NULL terminator */;
452 * The null-terminated, null-padded (see 4.4.2) SCSI
453 * NAME STRING field contains a UTF-8 format string.
454 * The number of bytes in the SCSI NAME STRING field
455 * (i.e., the value in the DESIGNATOR LENGTH field)
456 * shall be no larger than 256 and shall be a multiple
457 * of four.
459 if (padding)
460 scsi_name_len += padding;
462 buf[off-1] = scsi_name_len;
463 off += scsi_name_len;
464 /* Header size + Designation descriptor */
465 len += (scsi_name_len + 4);
467 set_len:
468 buf[2] = ((len >> 8) & 0xff);
469 buf[3] = (len & 0xff); /* Page Length for VPD 0x83 */
470 return 0;
473 /* Extended INQUIRY Data VPD Page */
474 static int
475 target_emulate_evpd_86(struct se_cmd *cmd, unsigned char *buf)
477 if (cmd->data_length < 60)
478 return 0;
480 buf[2] = 0x3c;
481 /* Set HEADSUP, ORDSUP, SIMPSUP */
482 buf[5] = 0x07;
484 /* If WriteCache emulation is enabled, set V_SUP */
485 if (cmd->se_dev->se_sub_dev->se_dev_attrib.emulate_write_cache > 0)
486 buf[6] = 0x01;
487 return 0;
490 /* Block Limits VPD page */
491 static int
492 target_emulate_evpd_b0(struct se_cmd *cmd, unsigned char *buf)
494 struct se_device *dev = cmd->se_dev;
495 int have_tp = 0;
498 * Following sbc3r22 section 6.5.3 Block Limits VPD page, when
499 * emulate_tpu=1 or emulate_tpws=1 we will be expect a
500 * different page length for Thin Provisioning.
502 if (dev->se_sub_dev->se_dev_attrib.emulate_tpu || dev->se_sub_dev->se_dev_attrib.emulate_tpws)
503 have_tp = 1;
505 if (cmd->data_length < (0x10 + 4)) {
506 pr_debug("Received data_length: %u"
507 " too small for EVPD 0xb0\n",
508 cmd->data_length);
509 return -EINVAL;
512 if (have_tp && cmd->data_length < (0x3c + 4)) {
513 pr_debug("Received data_length: %u"
514 " too small for TPE=1 EVPD 0xb0\n",
515 cmd->data_length);
516 have_tp = 0;
519 buf[0] = dev->transport->get_device_type(dev);
520 buf[3] = have_tp ? 0x3c : 0x10;
522 /* Set WSNZ to 1 */
523 buf[4] = 0x01;
526 * Set OPTIMAL TRANSFER LENGTH GRANULARITY
528 put_unaligned_be16(1, &buf[6]);
531 * Set MAXIMUM TRANSFER LENGTH
533 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.max_sectors, &buf[8]);
536 * Set OPTIMAL TRANSFER LENGTH
538 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.optimal_sectors, &buf[12]);
541 * Exit now if we don't support TP or the initiator sent a too
542 * short buffer.
544 if (!have_tp || cmd->data_length < (0x3c + 4))
545 return 0;
548 * Set MAXIMUM UNMAP LBA COUNT
550 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.max_unmap_lba_count, &buf[20]);
553 * Set MAXIMUM UNMAP BLOCK DESCRIPTOR COUNT
555 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.max_unmap_block_desc_count,
556 &buf[24]);
559 * Set OPTIMAL UNMAP GRANULARITY
561 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.unmap_granularity, &buf[28]);
564 * UNMAP GRANULARITY ALIGNMENT
566 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.unmap_granularity_alignment,
567 &buf[32]);
568 if (dev->se_sub_dev->se_dev_attrib.unmap_granularity_alignment != 0)
569 buf[32] |= 0x80; /* Set the UGAVALID bit */
571 return 0;
574 /* Block Device Characteristics VPD page */
575 static int
576 target_emulate_evpd_b1(struct se_cmd *cmd, unsigned char *buf)
578 struct se_device *dev = cmd->se_dev;
580 buf[0] = dev->transport->get_device_type(dev);
581 buf[3] = 0x3c;
583 if (cmd->data_length >= 5 &&
584 dev->se_sub_dev->se_dev_attrib.is_nonrot)
585 buf[5] = 1;
587 return 0;
590 /* Thin Provisioning VPD */
591 static int
592 target_emulate_evpd_b2(struct se_cmd *cmd, unsigned char *buf)
594 struct se_device *dev = cmd->se_dev;
597 * From sbc3r22 section 6.5.4 Thin Provisioning VPD page:
599 * The PAGE LENGTH field is defined in SPC-4. If the DP bit is set to
600 * zero, then the page length shall be set to 0004h. If the DP bit
601 * is set to one, then the page length shall be set to the value
602 * defined in table 162.
604 buf[0] = dev->transport->get_device_type(dev);
607 * Set Hardcoded length mentioned above for DP=0
609 put_unaligned_be16(0x0004, &buf[2]);
612 * The THRESHOLD EXPONENT field indicates the threshold set size in
613 * LBAs as a power of 2 (i.e., the threshold set size is equal to
614 * 2(threshold exponent)).
616 * Note that this is currently set to 0x00 as mkp says it will be
617 * changing again. We can enable this once it has settled in T10
618 * and is actually used by Linux/SCSI ML code.
620 buf[4] = 0x00;
623 * A TPU bit set to one indicates that the device server supports
624 * the UNMAP command (see 5.25). A TPU bit set to zero indicates
625 * that the device server does not support the UNMAP command.
627 if (dev->se_sub_dev->se_dev_attrib.emulate_tpu != 0)
628 buf[5] = 0x80;
631 * A TPWS bit set to one indicates that the device server supports
632 * the use of the WRITE SAME (16) command (see 5.42) to unmap LBAs.
633 * A TPWS bit set to zero indicates that the device server does not
634 * support the use of the WRITE SAME (16) command to unmap LBAs.
636 if (dev->se_sub_dev->se_dev_attrib.emulate_tpws != 0)
637 buf[5] |= 0x40;
639 return 0;
642 static int
643 target_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf);
645 static struct {
646 uint8_t page;
647 int (*emulate)(struct se_cmd *, unsigned char *);
648 } evpd_handlers[] = {
649 { .page = 0x00, .emulate = target_emulate_evpd_00 },
650 { .page = 0x80, .emulate = target_emulate_evpd_80 },
651 { .page = 0x83, .emulate = target_emulate_evpd_83 },
652 { .page = 0x86, .emulate = target_emulate_evpd_86 },
653 { .page = 0xb0, .emulate = target_emulate_evpd_b0 },
654 { .page = 0xb1, .emulate = target_emulate_evpd_b1 },
655 { .page = 0xb2, .emulate = target_emulate_evpd_b2 },
658 /* supported vital product data pages */
659 static int
660 target_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf)
662 int p;
664 if (cmd->data_length < 8)
665 return 0;
667 * Only report the INQUIRY EVPD=1 pages after a valid NAA
668 * Registered Extended LUN WWN has been set via ConfigFS
669 * during device creation/restart.
671 if (cmd->se_dev->se_sub_dev->su_dev_flags &
672 SDF_EMULATED_VPD_UNIT_SERIAL) {
673 buf[3] = ARRAY_SIZE(evpd_handlers);
674 for (p = 0; p < min_t(int, ARRAY_SIZE(evpd_handlers),
675 cmd->data_length - 4); ++p)
676 buf[p + 4] = evpd_handlers[p].page;
679 return 0;
682 static int
683 target_emulate_inquiry(struct se_cmd *cmd)
685 struct se_device *dev = cmd->se_dev;
686 unsigned char *buf;
687 unsigned char *cdb = cmd->t_task_cdb;
688 int p, ret;
690 if (!(cdb[1] & 0x1))
691 return target_emulate_inquiry_std(cmd);
694 * Make sure we at least have 4 bytes of INQUIRY response
695 * payload for 0x00 going back for EVPD=1. Note that 0x80
696 * and 0x83 will check for enough payload data length and
697 * jump to set_len: label when there is not enough inquiry EVPD
698 * payload length left for the next outgoing EVPD metadata
700 if (cmd->data_length < 4) {
701 pr_err("SCSI Inquiry payload length: %u"
702 " too small for EVPD=1\n", cmd->data_length);
703 return -EINVAL;
706 buf = transport_kmap_first_data_page(cmd);
708 buf[0] = dev->transport->get_device_type(dev);
710 for (p = 0; p < ARRAY_SIZE(evpd_handlers); ++p)
711 if (cdb[2] == evpd_handlers[p].page) {
712 buf[1] = cdb[2];
713 ret = evpd_handlers[p].emulate(cmd, buf);
714 transport_kunmap_first_data_page(cmd);
715 return ret;
718 transport_kunmap_first_data_page(cmd);
719 pr_err("Unknown VPD Code: 0x%02x\n", cdb[2]);
720 return -EINVAL;
723 static int
724 target_emulate_readcapacity(struct se_cmd *cmd)
726 struct se_device *dev = cmd->se_dev;
727 unsigned char *buf;
728 unsigned long long blocks_long = dev->transport->get_blocks(dev);
729 u32 blocks;
731 if (blocks_long >= 0x00000000ffffffff)
732 blocks = 0xffffffff;
733 else
734 blocks = (u32)blocks_long;
736 buf = transport_kmap_first_data_page(cmd);
738 buf[0] = (blocks >> 24) & 0xff;
739 buf[1] = (blocks >> 16) & 0xff;
740 buf[2] = (blocks >> 8) & 0xff;
741 buf[3] = blocks & 0xff;
742 buf[4] = (dev->se_sub_dev->se_dev_attrib.block_size >> 24) & 0xff;
743 buf[5] = (dev->se_sub_dev->se_dev_attrib.block_size >> 16) & 0xff;
744 buf[6] = (dev->se_sub_dev->se_dev_attrib.block_size >> 8) & 0xff;
745 buf[7] = dev->se_sub_dev->se_dev_attrib.block_size & 0xff;
747 * Set max 32-bit blocks to signal SERVICE ACTION READ_CAPACITY_16
749 if (dev->se_sub_dev->se_dev_attrib.emulate_tpu || dev->se_sub_dev->se_dev_attrib.emulate_tpws)
750 put_unaligned_be32(0xFFFFFFFF, &buf[0]);
752 transport_kunmap_first_data_page(cmd);
754 return 0;
757 static int
758 target_emulate_readcapacity_16(struct se_cmd *cmd)
760 struct se_device *dev = cmd->se_dev;
761 unsigned char *buf;
762 unsigned long long blocks = dev->transport->get_blocks(dev);
764 buf = transport_kmap_first_data_page(cmd);
766 buf[0] = (blocks >> 56) & 0xff;
767 buf[1] = (blocks >> 48) & 0xff;
768 buf[2] = (blocks >> 40) & 0xff;
769 buf[3] = (blocks >> 32) & 0xff;
770 buf[4] = (blocks >> 24) & 0xff;
771 buf[5] = (blocks >> 16) & 0xff;
772 buf[6] = (blocks >> 8) & 0xff;
773 buf[7] = blocks & 0xff;
774 buf[8] = (dev->se_sub_dev->se_dev_attrib.block_size >> 24) & 0xff;
775 buf[9] = (dev->se_sub_dev->se_dev_attrib.block_size >> 16) & 0xff;
776 buf[10] = (dev->se_sub_dev->se_dev_attrib.block_size >> 8) & 0xff;
777 buf[11] = dev->se_sub_dev->se_dev_attrib.block_size & 0xff;
779 * Set Thin Provisioning Enable bit following sbc3r22 in section
780 * READ CAPACITY (16) byte 14 if emulate_tpu or emulate_tpws is enabled.
782 if (dev->se_sub_dev->se_dev_attrib.emulate_tpu || dev->se_sub_dev->se_dev_attrib.emulate_tpws)
783 buf[14] = 0x80;
785 transport_kunmap_first_data_page(cmd);
787 return 0;
790 static int
791 target_modesense_rwrecovery(unsigned char *p)
793 p[0] = 0x01;
794 p[1] = 0x0a;
796 return 12;
799 static int
800 target_modesense_control(struct se_device *dev, unsigned char *p)
802 p[0] = 0x0a;
803 p[1] = 0x0a;
804 p[2] = 2;
806 * From spc4r23, 7.4.7 Control mode page
808 * The QUEUE ALGORITHM MODIFIER field (see table 368) specifies
809 * restrictions on the algorithm used for reordering commands
810 * having the SIMPLE task attribute (see SAM-4).
812 * Table 368 -- QUEUE ALGORITHM MODIFIER field
813 * Code Description
814 * 0h Restricted reordering
815 * 1h Unrestricted reordering allowed
816 * 2h to 7h Reserved
817 * 8h to Fh Vendor specific
819 * A value of zero in the QUEUE ALGORITHM MODIFIER field specifies that
820 * the device server shall order the processing sequence of commands
821 * having the SIMPLE task attribute such that data integrity is maintained
822 * for that I_T nexus (i.e., if the transmission of new SCSI transport protocol
823 * requests is halted at any time, the final value of all data observable
824 * on the medium shall be the same as if all the commands had been processed
825 * with the ORDERED task attribute).
827 * A value of one in the QUEUE ALGORITHM MODIFIER field specifies that the
828 * device server may reorder the processing sequence of commands having the
829 * SIMPLE task attribute in any manner. Any data integrity exposures related to
830 * command sequence order shall be explicitly handled by the application client
831 * through the selection of appropriate ommands and task attributes.
833 p[3] = (dev->se_sub_dev->se_dev_attrib.emulate_rest_reord == 1) ? 0x00 : 0x10;
835 * From spc4r17, section 7.4.6 Control mode Page
837 * Unit Attention interlocks control (UN_INTLCK_CTRL) to code 00b
839 * 00b: The logical unit shall clear any unit attention condition
840 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
841 * status and shall not establish a unit attention condition when a com-
842 * mand is completed with BUSY, TASK SET FULL, or RESERVATION CONFLICT
843 * status.
845 * 10b: The logical unit shall not clear any unit attention condition
846 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
847 * status and shall not establish a unit attention condition when
848 * a command is completed with BUSY, TASK SET FULL, or RESERVATION
849 * CONFLICT status.
851 * 11b a The logical unit shall not clear any unit attention condition
852 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
853 * status and shall establish a unit attention condition for the
854 * initiator port associated with the I_T nexus on which the BUSY,
855 * TASK SET FULL, or RESERVATION CONFLICT status is being returned.
856 * Depending on the status, the additional sense code shall be set to
857 * PREVIOUS BUSY STATUS, PREVIOUS TASK SET FULL STATUS, or PREVIOUS
858 * RESERVATION CONFLICT STATUS. Until it is cleared by a REQUEST SENSE
859 * command, a unit attention condition shall be established only once
860 * for a BUSY, TASK SET FULL, or RESERVATION CONFLICT status regardless
861 * to the number of commands completed with one of those status codes.
863 p[4] = (dev->se_sub_dev->se_dev_attrib.emulate_ua_intlck_ctrl == 2) ? 0x30 :
864 (dev->se_sub_dev->se_dev_attrib.emulate_ua_intlck_ctrl == 1) ? 0x20 : 0x00;
866 * From spc4r17, section 7.4.6 Control mode Page
868 * Task Aborted Status (TAS) bit set to zero.
870 * A task aborted status (TAS) bit set to zero specifies that aborted
871 * tasks shall be terminated by the device server without any response
872 * to the application client. A TAS bit set to one specifies that tasks
873 * aborted by the actions of an I_T nexus other than the I_T nexus on
874 * which the command was received shall be completed with TASK ABORTED
875 * status (see SAM-4).
877 p[5] = (dev->se_sub_dev->se_dev_attrib.emulate_tas) ? 0x40 : 0x00;
878 p[8] = 0xff;
879 p[9] = 0xff;
880 p[11] = 30;
882 return 12;
885 static int
886 target_modesense_caching(struct se_device *dev, unsigned char *p)
888 p[0] = 0x08;
889 p[1] = 0x12;
890 if (dev->se_sub_dev->se_dev_attrib.emulate_write_cache > 0)
891 p[2] = 0x04; /* Write Cache Enable */
892 p[12] = 0x20; /* Disabled Read Ahead */
894 return 20;
897 static void
898 target_modesense_write_protect(unsigned char *buf, int type)
901 * I believe that the WP bit (bit 7) in the mode header is the same for
902 * all device types..
904 switch (type) {
905 case TYPE_DISK:
906 case TYPE_TAPE:
907 default:
908 buf[0] |= 0x80; /* WP bit */
909 break;
913 static void
914 target_modesense_dpofua(unsigned char *buf, int type)
916 switch (type) {
917 case TYPE_DISK:
918 buf[0] |= 0x10; /* DPOFUA bit */
919 break;
920 default:
921 break;
925 static int
926 target_emulate_modesense(struct se_cmd *cmd, int ten)
928 struct se_device *dev = cmd->se_dev;
929 char *cdb = cmd->t_task_cdb;
930 unsigned char *rbuf;
931 int type = dev->transport->get_device_type(dev);
932 int offset = (ten) ? 8 : 4;
933 int length = 0;
934 unsigned char buf[SE_MODE_PAGE_BUF];
936 memset(buf, 0, SE_MODE_PAGE_BUF);
938 switch (cdb[2] & 0x3f) {
939 case 0x01:
940 length = target_modesense_rwrecovery(&buf[offset]);
941 break;
942 case 0x08:
943 length = target_modesense_caching(dev, &buf[offset]);
944 break;
945 case 0x0a:
946 length = target_modesense_control(dev, &buf[offset]);
947 break;
948 case 0x3f:
949 length = target_modesense_rwrecovery(&buf[offset]);
950 length += target_modesense_caching(dev, &buf[offset+length]);
951 length += target_modesense_control(dev, &buf[offset+length]);
952 break;
953 default:
954 pr_err("MODE SENSE: unimplemented page/subpage: 0x%02x/0x%02x\n",
955 cdb[2] & 0x3f, cdb[3]);
956 return PYX_TRANSPORT_UNKNOWN_MODE_PAGE;
958 offset += length;
960 if (ten) {
961 offset -= 2;
962 buf[0] = (offset >> 8) & 0xff;
963 buf[1] = offset & 0xff;
965 if ((cmd->se_lun->lun_access & TRANSPORT_LUNFLAGS_READ_ONLY) ||
966 (cmd->se_deve &&
967 (cmd->se_deve->lun_flags & TRANSPORT_LUNFLAGS_READ_ONLY)))
968 target_modesense_write_protect(&buf[3], type);
970 if ((dev->se_sub_dev->se_dev_attrib.emulate_write_cache > 0) &&
971 (dev->se_sub_dev->se_dev_attrib.emulate_fua_write > 0))
972 target_modesense_dpofua(&buf[3], type);
974 if ((offset + 2) > cmd->data_length)
975 offset = cmd->data_length;
977 } else {
978 offset -= 1;
979 buf[0] = offset & 0xff;
981 if ((cmd->se_lun->lun_access & TRANSPORT_LUNFLAGS_READ_ONLY) ||
982 (cmd->se_deve &&
983 (cmd->se_deve->lun_flags & TRANSPORT_LUNFLAGS_READ_ONLY)))
984 target_modesense_write_protect(&buf[2], type);
986 if ((dev->se_sub_dev->se_dev_attrib.emulate_write_cache > 0) &&
987 (dev->se_sub_dev->se_dev_attrib.emulate_fua_write > 0))
988 target_modesense_dpofua(&buf[2], type);
990 if ((offset + 1) > cmd->data_length)
991 offset = cmd->data_length;
994 rbuf = transport_kmap_first_data_page(cmd);
995 memcpy(rbuf, buf, offset);
996 transport_kunmap_first_data_page(cmd);
998 return 0;
1001 static int
1002 target_emulate_request_sense(struct se_cmd *cmd)
1004 unsigned char *cdb = cmd->t_task_cdb;
1005 unsigned char *buf;
1006 u8 ua_asc = 0, ua_ascq = 0;
1007 int err = 0;
1009 if (cdb[1] & 0x01) {
1010 pr_err("REQUEST_SENSE description emulation not"
1011 " supported\n");
1012 return PYX_TRANSPORT_INVALID_CDB_FIELD;
1015 buf = transport_kmap_first_data_page(cmd);
1017 if (!core_scsi3_ua_clear_for_request_sense(cmd, &ua_asc, &ua_ascq)) {
1019 * CURRENT ERROR, UNIT ATTENTION
1021 buf[0] = 0x70;
1022 buf[SPC_SENSE_KEY_OFFSET] = UNIT_ATTENTION;
1024 * Make sure request data length is enough for additional
1025 * sense data.
1027 if (cmd->data_length <= 18) {
1028 buf[7] = 0x00;
1029 err = -EINVAL;
1030 goto end;
1033 * The Additional Sense Code (ASC) from the UNIT ATTENTION
1035 buf[SPC_ASC_KEY_OFFSET] = ua_asc;
1036 buf[SPC_ASCQ_KEY_OFFSET] = ua_ascq;
1037 buf[7] = 0x0A;
1038 } else {
1040 * CURRENT ERROR, NO SENSE
1042 buf[0] = 0x70;
1043 buf[SPC_SENSE_KEY_OFFSET] = NO_SENSE;
1045 * Make sure request data length is enough for additional
1046 * sense data.
1048 if (cmd->data_length <= 18) {
1049 buf[7] = 0x00;
1050 err = -EINVAL;
1051 goto end;
1054 * NO ADDITIONAL SENSE INFORMATION
1056 buf[SPC_ASC_KEY_OFFSET] = 0x00;
1057 buf[7] = 0x0A;
1060 end:
1061 transport_kunmap_first_data_page(cmd);
1063 return 0;
1067 * Used for TCM/IBLOCK and TCM/FILEIO for block/blk-lib.c level discard support.
1068 * Note this is not used for TCM/pSCSI passthrough
1070 static int
1071 target_emulate_unmap(struct se_task *task)
1073 struct se_cmd *cmd = task->task_se_cmd;
1074 struct se_device *dev = cmd->se_dev;
1075 unsigned char *buf, *ptr = NULL;
1076 unsigned char *cdb = &cmd->t_task_cdb[0];
1077 sector_t lba;
1078 unsigned int size = cmd->data_length, range;
1079 int ret = 0, offset;
1080 unsigned short dl, bd_dl;
1082 /* First UNMAP block descriptor starts at 8 byte offset */
1083 offset = 8;
1084 size -= 8;
1085 dl = get_unaligned_be16(&cdb[0]);
1086 bd_dl = get_unaligned_be16(&cdb[2]);
1088 buf = transport_kmap_first_data_page(cmd);
1090 ptr = &buf[offset];
1091 pr_debug("UNMAP: Sub: %s Using dl: %hu bd_dl: %hu size: %hu"
1092 " ptr: %p\n", dev->transport->name, dl, bd_dl, size, ptr);
1094 while (size) {
1095 lba = get_unaligned_be64(&ptr[0]);
1096 range = get_unaligned_be32(&ptr[8]);
1097 pr_debug("UNMAP: Using lba: %llu and range: %u\n",
1098 (unsigned long long)lba, range);
1100 ret = dev->transport->do_discard(dev, lba, range);
1101 if (ret < 0) {
1102 pr_err("blkdev_issue_discard() failed: %d\n",
1103 ret);
1104 goto err;
1107 ptr += 16;
1108 size -= 16;
1111 err:
1112 transport_kunmap_first_data_page(cmd);
1114 return ret;
1118 * Used for TCM/IBLOCK and TCM/FILEIO for block/blk-lib.c level discard support.
1119 * Note this is not used for TCM/pSCSI passthrough
1121 static int
1122 target_emulate_write_same(struct se_task *task, u32 num_blocks)
1124 struct se_cmd *cmd = task->task_se_cmd;
1125 struct se_device *dev = cmd->se_dev;
1126 sector_t range;
1127 sector_t lba = cmd->t_task_lba;
1128 int ret;
1130 * Use the explicit range when non zero is supplied, otherwise calculate
1131 * the remaining range based on ->get_blocks() - starting LBA.
1133 if (num_blocks != 0)
1134 range = num_blocks;
1135 else
1136 range = (dev->transport->get_blocks(dev) - lba);
1138 pr_debug("WRITE_SAME UNMAP: LBA: %llu Range: %llu\n",
1139 (unsigned long long)lba, (unsigned long long)range);
1141 ret = dev->transport->do_discard(dev, lba, range);
1142 if (ret < 0) {
1143 pr_debug("blkdev_issue_discard() failed for WRITE_SAME\n");
1144 return ret;
1147 return 0;
1151 transport_emulate_control_cdb(struct se_task *task)
1153 struct se_cmd *cmd = task->task_se_cmd;
1154 struct se_device *dev = cmd->se_dev;
1155 unsigned short service_action;
1156 int ret = 0;
1158 switch (cmd->t_task_cdb[0]) {
1159 case INQUIRY:
1160 ret = target_emulate_inquiry(cmd);
1161 break;
1162 case READ_CAPACITY:
1163 ret = target_emulate_readcapacity(cmd);
1164 break;
1165 case MODE_SENSE:
1166 ret = target_emulate_modesense(cmd, 0);
1167 break;
1168 case MODE_SENSE_10:
1169 ret = target_emulate_modesense(cmd, 1);
1170 break;
1171 case SERVICE_ACTION_IN:
1172 switch (cmd->t_task_cdb[1] & 0x1f) {
1173 case SAI_READ_CAPACITY_16:
1174 ret = target_emulate_readcapacity_16(cmd);
1175 break;
1176 default:
1177 pr_err("Unsupported SA: 0x%02x\n",
1178 cmd->t_task_cdb[1] & 0x1f);
1179 return PYX_TRANSPORT_UNKNOWN_SAM_OPCODE;
1181 break;
1182 case REQUEST_SENSE:
1183 ret = target_emulate_request_sense(cmd);
1184 break;
1185 case UNMAP:
1186 if (!dev->transport->do_discard) {
1187 pr_err("UNMAP emulation not supported for: %s\n",
1188 dev->transport->name);
1189 return PYX_TRANSPORT_UNKNOWN_SAM_OPCODE;
1191 ret = target_emulate_unmap(task);
1192 break;
1193 case WRITE_SAME:
1194 if (!dev->transport->do_discard) {
1195 pr_err("WRITE_SAME emulation not supported"
1196 " for: %s\n", dev->transport->name);
1197 return PYX_TRANSPORT_UNKNOWN_SAM_OPCODE;
1199 ret = target_emulate_write_same(task,
1200 get_unaligned_be16(&cmd->t_task_cdb[7]));
1201 break;
1202 case WRITE_SAME_16:
1203 if (!dev->transport->do_discard) {
1204 pr_err("WRITE_SAME_16 emulation not supported"
1205 " for: %s\n", dev->transport->name);
1206 return PYX_TRANSPORT_UNKNOWN_SAM_OPCODE;
1208 ret = target_emulate_write_same(task,
1209 get_unaligned_be32(&cmd->t_task_cdb[10]));
1210 break;
1211 case VARIABLE_LENGTH_CMD:
1212 service_action =
1213 get_unaligned_be16(&cmd->t_task_cdb[8]);
1214 switch (service_action) {
1215 case WRITE_SAME_32:
1216 if (!dev->transport->do_discard) {
1217 pr_err("WRITE_SAME_32 SA emulation not"
1218 " supported for: %s\n",
1219 dev->transport->name);
1220 return PYX_TRANSPORT_UNKNOWN_SAM_OPCODE;
1222 ret = target_emulate_write_same(task,
1223 get_unaligned_be32(&cmd->t_task_cdb[28]));
1224 break;
1225 default:
1226 pr_err("Unsupported VARIABLE_LENGTH_CMD SA:"
1227 " 0x%02x\n", service_action);
1228 break;
1230 break;
1231 case SYNCHRONIZE_CACHE:
1232 case 0x91: /* SYNCHRONIZE_CACHE_16: */
1233 if (!dev->transport->do_sync_cache) {
1234 pr_err("SYNCHRONIZE_CACHE emulation not supported"
1235 " for: %s\n", dev->transport->name);
1236 return PYX_TRANSPORT_UNKNOWN_SAM_OPCODE;
1238 dev->transport->do_sync_cache(task);
1239 break;
1240 case ALLOW_MEDIUM_REMOVAL:
1241 case ERASE:
1242 case REZERO_UNIT:
1243 case SEEK_10:
1244 case SPACE:
1245 case START_STOP:
1246 case TEST_UNIT_READY:
1247 case VERIFY:
1248 case WRITE_FILEMARKS:
1249 break;
1250 default:
1251 pr_err("Unsupported SCSI Opcode: 0x%02x for %s\n",
1252 cmd->t_task_cdb[0], dev->transport->name);
1253 return PYX_TRANSPORT_UNKNOWN_SAM_OPCODE;
1256 if (ret < 0)
1257 return ret;
1259 * Handle the successful completion here unless a caller
1260 * has explictly requested an asychronous completion.
1262 if (!(cmd->se_cmd_flags & SCF_EMULATE_CDB_ASYNC)) {
1263 task->task_scsi_status = GOOD;
1264 transport_complete_task(task, 1);
1267 return PYX_TRANSPORT_SENT_TO_TRANSPORT;
1271 * Write a CDB into @cdb that is based on the one the intiator sent us,
1272 * but updated to only cover the sectors that the current task handles.
1274 void target_get_task_cdb(struct se_task *task, unsigned char *cdb)
1276 struct se_cmd *cmd = task->task_se_cmd;
1277 unsigned int cdb_len = scsi_command_size(cmd->t_task_cdb);
1279 memcpy(cdb, cmd->t_task_cdb, cdb_len);
1280 if (cmd->se_cmd_flags & SCF_SCSI_DATA_SG_IO_CDB) {
1281 unsigned long long lba = task->task_lba;
1282 u32 sectors = task->task_sectors;
1284 switch (cdb_len) {
1285 case 6:
1286 /* 21-bit LBA and 8-bit sectors */
1287 cdb[1] = (lba >> 16) & 0x1f;
1288 cdb[2] = (lba >> 8) & 0xff;
1289 cdb[3] = lba & 0xff;
1290 cdb[4] = sectors & 0xff;
1291 break;
1292 case 10:
1293 /* 32-bit LBA and 16-bit sectors */
1294 put_unaligned_be32(lba, &cdb[2]);
1295 put_unaligned_be16(sectors, &cdb[7]);
1296 break;
1297 case 12:
1298 /* 32-bit LBA and 32-bit sectors */
1299 put_unaligned_be32(lba, &cdb[2]);
1300 put_unaligned_be32(sectors, &cdb[6]);
1301 break;
1302 case 16:
1303 /* 64-bit LBA and 32-bit sectors */
1304 put_unaligned_be64(lba, &cdb[2]);
1305 put_unaligned_be32(sectors, &cdb[10]);
1306 break;
1307 case 32:
1308 /* 64-bit LBA and 32-bit sectors, extended CDB */
1309 put_unaligned_be64(lba, &cdb[12]);
1310 put_unaligned_be32(sectors, &cdb[28]);
1311 break;
1312 default:
1313 BUG();
1317 EXPORT_SYMBOL(target_get_task_cdb);