Merge remote-tracking branch 'moduleh/module.h-split'
[linux-2.6/next.git] / drivers / target / target_core_cdb.c
blob89ae923c5da6e28362039fe2fd6a611459747752
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 <asm/unaligned.h>
28 #include <scsi/scsi.h>
30 #include <target/target_core_base.h>
31 #include <target/target_core_transport.h>
32 #include <target/target_core_fabric_ops.h>
33 #include "target_core_ua.h"
35 static void
36 target_fill_alua_data(struct se_port *port, unsigned char *buf)
38 struct t10_alua_tg_pt_gp *tg_pt_gp;
39 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
42 * Set SCCS for MAINTENANCE_IN + REPORT_TARGET_PORT_GROUPS.
44 buf[5] = 0x80;
47 * Set TPGS field for explict and/or implict ALUA access type
48 * and opteration.
50 * See spc4r17 section 6.4.2 Table 135
52 if (!port)
53 return;
54 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
55 if (!tg_pt_gp_mem)
56 return;
58 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
59 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
60 if (tg_pt_gp)
61 buf[5] |= tg_pt_gp->tg_pt_gp_alua_access_type;
62 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
65 static int
66 target_emulate_inquiry_std(struct se_cmd *cmd)
68 struct se_lun *lun = cmd->se_lun;
69 struct se_device *dev = cmd->se_dev;
70 struct se_portal_group *tpg = lun->lun_sep->sep_tpg;
71 unsigned char *buf;
74 * Make sure we at least have 6 bytes of INQUIRY response
75 * payload going back for EVPD=0
77 if (cmd->data_length < 6) {
78 pr_err("SCSI Inquiry payload length: %u"
79 " too small for EVPD=0\n", cmd->data_length);
80 return -EINVAL;
83 buf = transport_kmap_first_data_page(cmd);
85 if (dev == tpg->tpg_virt_lun0.lun_se_dev) {
86 buf[0] = 0x3f; /* Not connected */
87 } else {
88 buf[0] = dev->transport->get_device_type(dev);
89 if (buf[0] == TYPE_TAPE)
90 buf[1] = 0x80;
92 buf[2] = dev->transport->get_device_rev(dev);
95 * Enable SCCS and TPGS fields for Emulated ALUA
97 if (dev->se_sub_dev->t10_alua.alua_type == SPC3_ALUA_EMULATED)
98 target_fill_alua_data(lun->lun_sep, buf);
100 if (cmd->data_length < 8) {
101 buf[4] = 1; /* Set additional length to 1 */
102 goto out;
105 buf[7] = 0x32; /* Sync=1 and CmdQue=1 */
108 * Do not include vendor, product, reversion info in INQUIRY
109 * response payload for cdbs with a small allocation length.
111 if (cmd->data_length < 36) {
112 buf[4] = 3; /* Set additional length to 3 */
113 goto out;
116 snprintf((unsigned char *)&buf[8], 8, "LIO-ORG");
117 snprintf((unsigned char *)&buf[16], 16, "%s",
118 &dev->se_sub_dev->t10_wwn.model[0]);
119 snprintf((unsigned char *)&buf[32], 4, "%s",
120 &dev->se_sub_dev->t10_wwn.revision[0]);
121 buf[4] = 31; /* Set additional length to 31 */
123 out:
124 transport_kunmap_first_data_page(cmd);
125 return 0;
128 /* unit serial number */
129 static int
130 target_emulate_evpd_80(struct se_cmd *cmd, unsigned char *buf)
132 struct se_device *dev = cmd->se_dev;
133 u16 len = 0;
135 if (dev->se_sub_dev->su_dev_flags &
136 SDF_EMULATED_VPD_UNIT_SERIAL) {
137 u32 unit_serial_len;
139 unit_serial_len =
140 strlen(&dev->se_sub_dev->t10_wwn.unit_serial[0]);
141 unit_serial_len++; /* For NULL Terminator */
143 if (((len + 4) + unit_serial_len) > cmd->data_length) {
144 len += unit_serial_len;
145 buf[2] = ((len >> 8) & 0xff);
146 buf[3] = (len & 0xff);
147 return 0;
149 len += sprintf((unsigned char *)&buf[4], "%s",
150 &dev->se_sub_dev->t10_wwn.unit_serial[0]);
151 len++; /* Extra Byte for NULL Terminator */
152 buf[3] = len;
154 return 0;
158 * Device identification VPD, for a complete list of
159 * DESIGNATOR TYPEs see spc4r17 Table 459.
161 static int
162 target_emulate_evpd_83(struct se_cmd *cmd, unsigned char *buf)
164 struct se_device *dev = cmd->se_dev;
165 struct se_lun *lun = cmd->se_lun;
166 struct se_port *port = NULL;
167 struct se_portal_group *tpg = NULL;
168 struct t10_alua_lu_gp_member *lu_gp_mem;
169 struct t10_alua_tg_pt_gp *tg_pt_gp;
170 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
171 unsigned char *prod = &dev->se_sub_dev->t10_wwn.model[0];
172 u32 prod_len;
173 u32 unit_serial_len, off = 0;
174 u16 len = 0, id_len;
176 off = 4;
179 * NAA IEEE Registered Extended Assigned designator format, see
180 * spc4r17 section 7.7.3.6.5
182 * We depend upon a target_core_mod/ConfigFS provided
183 * /sys/kernel/config/target/core/$HBA/$DEV/wwn/vpd_unit_serial
184 * value in order to return the NAA id.
186 if (!(dev->se_sub_dev->su_dev_flags & SDF_EMULATED_VPD_UNIT_SERIAL))
187 goto check_t10_vend_desc;
189 if (off + 20 > cmd->data_length)
190 goto check_t10_vend_desc;
192 /* CODE SET == Binary */
193 buf[off++] = 0x1;
195 /* Set ASSOCIATION == addressed logical unit: 0)b */
196 buf[off] = 0x00;
198 /* Identifier/Designator type == NAA identifier */
199 buf[off++] |= 0x3;
200 off++;
202 /* Identifier/Designator length */
203 buf[off++] = 0x10;
206 * Start NAA IEEE Registered Extended Identifier/Designator
208 buf[off++] = (0x6 << 4);
211 * Use OpenFabrics IEEE Company ID: 00 14 05
213 buf[off++] = 0x01;
214 buf[off++] = 0x40;
215 buf[off] = (0x5 << 4);
218 * Return ConfigFS Unit Serial Number information for
219 * VENDOR_SPECIFIC_IDENTIFIER and
220 * VENDOR_SPECIFIC_IDENTIFIER_EXTENTION
222 buf[off++] |= hex_to_bin(dev->se_sub_dev->t10_wwn.unit_serial[0]);
223 hex2bin(&buf[off], &dev->se_sub_dev->t10_wwn.unit_serial[1], 12);
225 len = 20;
226 off = (len + 4);
228 check_t10_vend_desc:
230 * T10 Vendor Identifier Page, see spc4r17 section 7.7.3.4
232 id_len = 8; /* For Vendor field */
233 prod_len = 4; /* For VPD Header */
234 prod_len += 8; /* For Vendor field */
235 prod_len += strlen(prod);
236 prod_len++; /* For : */
238 if (dev->se_sub_dev->su_dev_flags &
239 SDF_EMULATED_VPD_UNIT_SERIAL) {
240 unit_serial_len =
241 strlen(&dev->se_sub_dev->t10_wwn.unit_serial[0]);
242 unit_serial_len++; /* For NULL Terminator */
244 if ((len + (id_len + 4) +
245 (prod_len + unit_serial_len)) >
246 cmd->data_length) {
247 len += (prod_len + unit_serial_len);
248 goto check_port;
250 id_len += sprintf((unsigned char *)&buf[off+12],
251 "%s:%s", prod,
252 &dev->se_sub_dev->t10_wwn.unit_serial[0]);
254 buf[off] = 0x2; /* ASCII */
255 buf[off+1] = 0x1; /* T10 Vendor ID */
256 buf[off+2] = 0x0;
257 memcpy((unsigned char *)&buf[off+4], "LIO-ORG", 8);
258 /* Extra Byte for NULL Terminator */
259 id_len++;
260 /* Identifier Length */
261 buf[off+3] = id_len;
262 /* Header size for Designation descriptor */
263 len += (id_len + 4);
264 off += (id_len + 4);
266 * struct se_port is only set for INQUIRY VPD=1 through $FABRIC_MOD
268 check_port:
269 port = lun->lun_sep;
270 if (port) {
271 struct t10_alua_lu_gp *lu_gp;
272 u32 padding, scsi_name_len;
273 u16 lu_gp_id = 0;
274 u16 tg_pt_gp_id = 0;
275 u16 tpgt;
277 tpg = port->sep_tpg;
279 * Relative target port identifer, see spc4r17
280 * section 7.7.3.7
282 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
283 * section 7.5.1 Table 362
285 if (((len + 4) + 8) > cmd->data_length) {
286 len += 8;
287 goto check_tpgi;
289 buf[off] =
290 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
291 buf[off++] |= 0x1; /* CODE SET == Binary */
292 buf[off] = 0x80; /* Set PIV=1 */
293 /* Set ASSOCIATION == target port: 01b */
294 buf[off] |= 0x10;
295 /* DESIGNATOR TYPE == Relative target port identifer */
296 buf[off++] |= 0x4;
297 off++; /* Skip over Reserved */
298 buf[off++] = 4; /* DESIGNATOR LENGTH */
299 /* Skip over Obsolete field in RTPI payload
300 * in Table 472 */
301 off += 2;
302 buf[off++] = ((port->sep_rtpi >> 8) & 0xff);
303 buf[off++] = (port->sep_rtpi & 0xff);
304 len += 8; /* Header size + Designation descriptor */
306 * Target port group identifier, see spc4r17
307 * section 7.7.3.8
309 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
310 * section 7.5.1 Table 362
312 check_tpgi:
313 if (dev->se_sub_dev->t10_alua.alua_type !=
314 SPC3_ALUA_EMULATED)
315 goto check_scsi_name;
317 if (((len + 4) + 8) > cmd->data_length) {
318 len += 8;
319 goto check_lu_gp;
321 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
322 if (!tg_pt_gp_mem)
323 goto check_lu_gp;
325 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
326 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
327 if (!tg_pt_gp) {
328 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
329 goto check_lu_gp;
331 tg_pt_gp_id = tg_pt_gp->tg_pt_gp_id;
332 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
334 buf[off] =
335 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
336 buf[off++] |= 0x1; /* CODE SET == Binary */
337 buf[off] = 0x80; /* Set PIV=1 */
338 /* Set ASSOCIATION == target port: 01b */
339 buf[off] |= 0x10;
340 /* DESIGNATOR TYPE == Target port group identifier */
341 buf[off++] |= 0x5;
342 off++; /* Skip over Reserved */
343 buf[off++] = 4; /* DESIGNATOR LENGTH */
344 off += 2; /* Skip over Reserved Field */
345 buf[off++] = ((tg_pt_gp_id >> 8) & 0xff);
346 buf[off++] = (tg_pt_gp_id & 0xff);
347 len += 8; /* Header size + Designation descriptor */
349 * Logical Unit Group identifier, see spc4r17
350 * section 7.7.3.8
352 check_lu_gp:
353 if (((len + 4) + 8) > cmd->data_length) {
354 len += 8;
355 goto check_scsi_name;
357 lu_gp_mem = dev->dev_alua_lu_gp_mem;
358 if (!lu_gp_mem)
359 goto check_scsi_name;
361 spin_lock(&lu_gp_mem->lu_gp_mem_lock);
362 lu_gp = lu_gp_mem->lu_gp;
363 if (!lu_gp) {
364 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
365 goto check_scsi_name;
367 lu_gp_id = lu_gp->lu_gp_id;
368 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
370 buf[off++] |= 0x1; /* CODE SET == Binary */
371 /* DESIGNATOR TYPE == Logical Unit Group identifier */
372 buf[off++] |= 0x6;
373 off++; /* Skip over Reserved */
374 buf[off++] = 4; /* DESIGNATOR LENGTH */
375 off += 2; /* Skip over Reserved Field */
376 buf[off++] = ((lu_gp_id >> 8) & 0xff);
377 buf[off++] = (lu_gp_id & 0xff);
378 len += 8; /* Header size + Designation descriptor */
380 * SCSI name string designator, see spc4r17
381 * section 7.7.3.11
383 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
384 * section 7.5.1 Table 362
386 check_scsi_name:
387 scsi_name_len = strlen(tpg->se_tpg_tfo->tpg_get_wwn(tpg));
388 /* UTF-8 ",t,0x<16-bit TPGT>" + NULL Terminator */
389 scsi_name_len += 10;
390 /* Check for 4-byte padding */
391 padding = ((-scsi_name_len) & 3);
392 if (padding != 0)
393 scsi_name_len += padding;
394 /* Header size + Designation descriptor */
395 scsi_name_len += 4;
397 if (((len + 4) + scsi_name_len) > cmd->data_length) {
398 len += scsi_name_len;
399 goto set_len;
401 buf[off] =
402 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
403 buf[off++] |= 0x3; /* CODE SET == UTF-8 */
404 buf[off] = 0x80; /* Set PIV=1 */
405 /* Set ASSOCIATION == target port: 01b */
406 buf[off] |= 0x10;
407 /* DESIGNATOR TYPE == SCSI name string */
408 buf[off++] |= 0x8;
409 off += 2; /* Skip over Reserved and length */
411 * SCSI name string identifer containing, $FABRIC_MOD
412 * dependent information. For LIO-Target and iSCSI
413 * Target Port, this means "<iSCSI name>,t,0x<TPGT> in
414 * UTF-8 encoding.
416 tpgt = tpg->se_tpg_tfo->tpg_get_tag(tpg);
417 scsi_name_len = sprintf(&buf[off], "%s,t,0x%04x",
418 tpg->se_tpg_tfo->tpg_get_wwn(tpg), tpgt);
419 scsi_name_len += 1 /* Include NULL terminator */;
421 * The null-terminated, null-padded (see 4.4.2) SCSI
422 * NAME STRING field contains a UTF-8 format string.
423 * The number of bytes in the SCSI NAME STRING field
424 * (i.e., the value in the DESIGNATOR LENGTH field)
425 * shall be no larger than 256 and shall be a multiple
426 * of four.
428 if (padding)
429 scsi_name_len += padding;
431 buf[off-1] = scsi_name_len;
432 off += scsi_name_len;
433 /* Header size + Designation descriptor */
434 len += (scsi_name_len + 4);
436 set_len:
437 buf[2] = ((len >> 8) & 0xff);
438 buf[3] = (len & 0xff); /* Page Length for VPD 0x83 */
439 return 0;
442 /* Extended INQUIRY Data VPD Page */
443 static int
444 target_emulate_evpd_86(struct se_cmd *cmd, unsigned char *buf)
446 if (cmd->data_length < 60)
447 return 0;
449 buf[2] = 0x3c;
450 /* Set HEADSUP, ORDSUP, SIMPSUP */
451 buf[5] = 0x07;
453 /* If WriteCache emulation is enabled, set V_SUP */
454 if (cmd->se_dev->se_sub_dev->se_dev_attrib.emulate_write_cache > 0)
455 buf[6] = 0x01;
456 return 0;
459 /* Block Limits VPD page */
460 static int
461 target_emulate_evpd_b0(struct se_cmd *cmd, unsigned char *buf)
463 struct se_device *dev = cmd->se_dev;
464 int have_tp = 0;
467 * Following sbc3r22 section 6.5.3 Block Limits VPD page, when
468 * emulate_tpu=1 or emulate_tpws=1 we will be expect a
469 * different page length for Thin Provisioning.
471 if (dev->se_sub_dev->se_dev_attrib.emulate_tpu || dev->se_sub_dev->se_dev_attrib.emulate_tpws)
472 have_tp = 1;
474 if (cmd->data_length < (0x10 + 4)) {
475 pr_debug("Received data_length: %u"
476 " too small for EVPD 0xb0\n",
477 cmd->data_length);
478 return -EINVAL;
481 if (have_tp && cmd->data_length < (0x3c + 4)) {
482 pr_debug("Received data_length: %u"
483 " too small for TPE=1 EVPD 0xb0\n",
484 cmd->data_length);
485 have_tp = 0;
488 buf[0] = dev->transport->get_device_type(dev);
489 buf[3] = have_tp ? 0x3c : 0x10;
491 /* Set WSNZ to 1 */
492 buf[4] = 0x01;
495 * Set OPTIMAL TRANSFER LENGTH GRANULARITY
497 put_unaligned_be16(1, &buf[6]);
500 * Set MAXIMUM TRANSFER LENGTH
502 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.max_sectors, &buf[8]);
505 * Set OPTIMAL TRANSFER LENGTH
507 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.optimal_sectors, &buf[12]);
510 * Exit now if we don't support TP or the initiator sent a too
511 * short buffer.
513 if (!have_tp || cmd->data_length < (0x3c + 4))
514 return 0;
517 * Set MAXIMUM UNMAP LBA COUNT
519 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.max_unmap_lba_count, &buf[20]);
522 * Set MAXIMUM UNMAP BLOCK DESCRIPTOR COUNT
524 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.max_unmap_block_desc_count,
525 &buf[24]);
528 * Set OPTIMAL UNMAP GRANULARITY
530 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.unmap_granularity, &buf[28]);
533 * UNMAP GRANULARITY ALIGNMENT
535 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.unmap_granularity_alignment,
536 &buf[32]);
537 if (dev->se_sub_dev->se_dev_attrib.unmap_granularity_alignment != 0)
538 buf[32] |= 0x80; /* Set the UGAVALID bit */
540 return 0;
543 /* Block Device Characteristics VPD page */
544 static int
545 target_emulate_evpd_b1(struct se_cmd *cmd, unsigned char *buf)
547 struct se_device *dev = cmd->se_dev;
549 buf[0] = dev->transport->get_device_type(dev);
550 buf[3] = 0x3c;
552 if (cmd->data_length >= 5 &&
553 dev->se_sub_dev->se_dev_attrib.is_nonrot)
554 buf[5] = 1;
556 return 0;
559 /* Thin Provisioning VPD */
560 static int
561 target_emulate_evpd_b2(struct se_cmd *cmd, unsigned char *buf)
563 struct se_device *dev = cmd->se_dev;
566 * From sbc3r22 section 6.5.4 Thin Provisioning VPD page:
568 * The PAGE LENGTH field is defined in SPC-4. If the DP bit is set to
569 * zero, then the page length shall be set to 0004h. If the DP bit
570 * is set to one, then the page length shall be set to the value
571 * defined in table 162.
573 buf[0] = dev->transport->get_device_type(dev);
576 * Set Hardcoded length mentioned above for DP=0
578 put_unaligned_be16(0x0004, &buf[2]);
581 * The THRESHOLD EXPONENT field indicates the threshold set size in
582 * LBAs as a power of 2 (i.e., the threshold set size is equal to
583 * 2(threshold exponent)).
585 * Note that this is currently set to 0x00 as mkp says it will be
586 * changing again. We can enable this once it has settled in T10
587 * and is actually used by Linux/SCSI ML code.
589 buf[4] = 0x00;
592 * A TPU bit set to one indicates that the device server supports
593 * the UNMAP command (see 5.25). A TPU bit set to zero indicates
594 * that the device server does not support the UNMAP command.
596 if (dev->se_sub_dev->se_dev_attrib.emulate_tpu != 0)
597 buf[5] = 0x80;
600 * A TPWS bit set to one indicates that the device server supports
601 * the use of the WRITE SAME (16) command (see 5.42) to unmap LBAs.
602 * A TPWS bit set to zero indicates that the device server does not
603 * support the use of the WRITE SAME (16) command to unmap LBAs.
605 if (dev->se_sub_dev->se_dev_attrib.emulate_tpws != 0)
606 buf[5] |= 0x40;
608 return 0;
611 static int
612 target_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf);
614 static struct {
615 uint8_t page;
616 int (*emulate)(struct se_cmd *, unsigned char *);
617 } evpd_handlers[] = {
618 { .page = 0x00, .emulate = target_emulate_evpd_00 },
619 { .page = 0x80, .emulate = target_emulate_evpd_80 },
620 { .page = 0x83, .emulate = target_emulate_evpd_83 },
621 { .page = 0x86, .emulate = target_emulate_evpd_86 },
622 { .page = 0xb0, .emulate = target_emulate_evpd_b0 },
623 { .page = 0xb1, .emulate = target_emulate_evpd_b1 },
624 { .page = 0xb2, .emulate = target_emulate_evpd_b2 },
627 /* supported vital product data pages */
628 static int
629 target_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf)
631 int p;
633 if (cmd->data_length < 8)
634 return 0;
636 * Only report the INQUIRY EVPD=1 pages after a valid NAA
637 * Registered Extended LUN WWN has been set via ConfigFS
638 * during device creation/restart.
640 if (cmd->se_dev->se_sub_dev->su_dev_flags &
641 SDF_EMULATED_VPD_UNIT_SERIAL) {
642 buf[3] = ARRAY_SIZE(evpd_handlers);
643 for (p = 0; p < min_t(int, ARRAY_SIZE(evpd_handlers),
644 cmd->data_length - 4); ++p)
645 buf[p + 4] = evpd_handlers[p].page;
648 return 0;
651 static int
652 target_emulate_inquiry(struct se_cmd *cmd)
654 struct se_device *dev = cmd->se_dev;
655 unsigned char *buf;
656 unsigned char *cdb = cmd->t_task_cdb;
657 int p, ret;
659 if (!(cdb[1] & 0x1))
660 return target_emulate_inquiry_std(cmd);
663 * Make sure we at least have 4 bytes of INQUIRY response
664 * payload for 0x00 going back for EVPD=1. Note that 0x80
665 * and 0x83 will check for enough payload data length and
666 * jump to set_len: label when there is not enough inquiry EVPD
667 * payload length left for the next outgoing EVPD metadata
669 if (cmd->data_length < 4) {
670 pr_err("SCSI Inquiry payload length: %u"
671 " too small for EVPD=1\n", cmd->data_length);
672 return -EINVAL;
675 buf = transport_kmap_first_data_page(cmd);
677 buf[0] = dev->transport->get_device_type(dev);
679 for (p = 0; p < ARRAY_SIZE(evpd_handlers); ++p)
680 if (cdb[2] == evpd_handlers[p].page) {
681 buf[1] = cdb[2];
682 ret = evpd_handlers[p].emulate(cmd, buf);
683 transport_kunmap_first_data_page(cmd);
684 return ret;
687 transport_kunmap_first_data_page(cmd);
688 pr_err("Unknown VPD Code: 0x%02x\n", cdb[2]);
689 return -EINVAL;
692 static int
693 target_emulate_readcapacity(struct se_cmd *cmd)
695 struct se_device *dev = cmd->se_dev;
696 unsigned char *buf;
697 unsigned long long blocks_long = dev->transport->get_blocks(dev);
698 u32 blocks;
700 if (blocks_long >= 0x00000000ffffffff)
701 blocks = 0xffffffff;
702 else
703 blocks = (u32)blocks_long;
705 buf = transport_kmap_first_data_page(cmd);
707 buf[0] = (blocks >> 24) & 0xff;
708 buf[1] = (blocks >> 16) & 0xff;
709 buf[2] = (blocks >> 8) & 0xff;
710 buf[3] = blocks & 0xff;
711 buf[4] = (dev->se_sub_dev->se_dev_attrib.block_size >> 24) & 0xff;
712 buf[5] = (dev->se_sub_dev->se_dev_attrib.block_size >> 16) & 0xff;
713 buf[6] = (dev->se_sub_dev->se_dev_attrib.block_size >> 8) & 0xff;
714 buf[7] = dev->se_sub_dev->se_dev_attrib.block_size & 0xff;
716 * Set max 32-bit blocks to signal SERVICE ACTION READ_CAPACITY_16
718 if (dev->se_sub_dev->se_dev_attrib.emulate_tpu || dev->se_sub_dev->se_dev_attrib.emulate_tpws)
719 put_unaligned_be32(0xFFFFFFFF, &buf[0]);
721 transport_kunmap_first_data_page(cmd);
723 return 0;
726 static int
727 target_emulate_readcapacity_16(struct se_cmd *cmd)
729 struct se_device *dev = cmd->se_dev;
730 unsigned char *buf;
731 unsigned long long blocks = dev->transport->get_blocks(dev);
733 buf = transport_kmap_first_data_page(cmd);
735 buf[0] = (blocks >> 56) & 0xff;
736 buf[1] = (blocks >> 48) & 0xff;
737 buf[2] = (blocks >> 40) & 0xff;
738 buf[3] = (blocks >> 32) & 0xff;
739 buf[4] = (blocks >> 24) & 0xff;
740 buf[5] = (blocks >> 16) & 0xff;
741 buf[6] = (blocks >> 8) & 0xff;
742 buf[7] = blocks & 0xff;
743 buf[8] = (dev->se_sub_dev->se_dev_attrib.block_size >> 24) & 0xff;
744 buf[9] = (dev->se_sub_dev->se_dev_attrib.block_size >> 16) & 0xff;
745 buf[10] = (dev->se_sub_dev->se_dev_attrib.block_size >> 8) & 0xff;
746 buf[11] = dev->se_sub_dev->se_dev_attrib.block_size & 0xff;
748 * Set Thin Provisioning Enable bit following sbc3r22 in section
749 * READ CAPACITY (16) byte 14 if emulate_tpu or emulate_tpws is enabled.
751 if (dev->se_sub_dev->se_dev_attrib.emulate_tpu || dev->se_sub_dev->se_dev_attrib.emulate_tpws)
752 buf[14] = 0x80;
754 transport_kunmap_first_data_page(cmd);
756 return 0;
759 static int
760 target_modesense_rwrecovery(unsigned char *p)
762 p[0] = 0x01;
763 p[1] = 0x0a;
765 return 12;
768 static int
769 target_modesense_control(struct se_device *dev, unsigned char *p)
771 p[0] = 0x0a;
772 p[1] = 0x0a;
773 p[2] = 2;
775 * From spc4r23, 7.4.7 Control mode page
777 * The QUEUE ALGORITHM MODIFIER field (see table 368) specifies
778 * restrictions on the algorithm used for reordering commands
779 * having the SIMPLE task attribute (see SAM-4).
781 * Table 368 -- QUEUE ALGORITHM MODIFIER field
782 * Code Description
783 * 0h Restricted reordering
784 * 1h Unrestricted reordering allowed
785 * 2h to 7h Reserved
786 * 8h to Fh Vendor specific
788 * A value of zero in the QUEUE ALGORITHM MODIFIER field specifies that
789 * the device server shall order the processing sequence of commands
790 * having the SIMPLE task attribute such that data integrity is maintained
791 * for that I_T nexus (i.e., if the transmission of new SCSI transport protocol
792 * requests is halted at any time, the final value of all data observable
793 * on the medium shall be the same as if all the commands had been processed
794 * with the ORDERED task attribute).
796 * A value of one in the QUEUE ALGORITHM MODIFIER field specifies that the
797 * device server may reorder the processing sequence of commands having the
798 * SIMPLE task attribute in any manner. Any data integrity exposures related to
799 * command sequence order shall be explicitly handled by the application client
800 * through the selection of appropriate ommands and task attributes.
802 p[3] = (dev->se_sub_dev->se_dev_attrib.emulate_rest_reord == 1) ? 0x00 : 0x10;
804 * From spc4r17, section 7.4.6 Control mode Page
806 * Unit Attention interlocks control (UN_INTLCK_CTRL) to code 00b
808 * 00b: The logical unit shall clear any unit attention condition
809 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
810 * status and shall not establish a unit attention condition when a com-
811 * mand is completed with BUSY, TASK SET FULL, or RESERVATION CONFLICT
812 * status.
814 * 10b: The logical unit shall not clear any unit attention condition
815 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
816 * status and shall not establish a unit attention condition when
817 * a command is completed with BUSY, TASK SET FULL, or RESERVATION
818 * CONFLICT status.
820 * 11b a The logical unit shall not clear any unit attention condition
821 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
822 * status and shall establish a unit attention condition for the
823 * initiator port associated with the I_T nexus on which the BUSY,
824 * TASK SET FULL, or RESERVATION CONFLICT status is being returned.
825 * Depending on the status, the additional sense code shall be set to
826 * PREVIOUS BUSY STATUS, PREVIOUS TASK SET FULL STATUS, or PREVIOUS
827 * RESERVATION CONFLICT STATUS. Until it is cleared by a REQUEST SENSE
828 * command, a unit attention condition shall be established only once
829 * for a BUSY, TASK SET FULL, or RESERVATION CONFLICT status regardless
830 * to the number of commands completed with one of those status codes.
832 p[4] = (dev->se_sub_dev->se_dev_attrib.emulate_ua_intlck_ctrl == 2) ? 0x30 :
833 (dev->se_sub_dev->se_dev_attrib.emulate_ua_intlck_ctrl == 1) ? 0x20 : 0x00;
835 * From spc4r17, section 7.4.6 Control mode Page
837 * Task Aborted Status (TAS) bit set to zero.
839 * A task aborted status (TAS) bit set to zero specifies that aborted
840 * tasks shall be terminated by the device server without any response
841 * to the application client. A TAS bit set to one specifies that tasks
842 * aborted by the actions of an I_T nexus other than the I_T nexus on
843 * which the command was received shall be completed with TASK ABORTED
844 * status (see SAM-4).
846 p[5] = (dev->se_sub_dev->se_dev_attrib.emulate_tas) ? 0x40 : 0x00;
847 p[8] = 0xff;
848 p[9] = 0xff;
849 p[11] = 30;
851 return 12;
854 static int
855 target_modesense_caching(struct se_device *dev, unsigned char *p)
857 p[0] = 0x08;
858 p[1] = 0x12;
859 if (dev->se_sub_dev->se_dev_attrib.emulate_write_cache > 0)
860 p[2] = 0x04; /* Write Cache Enable */
861 p[12] = 0x20; /* Disabled Read Ahead */
863 return 20;
866 static void
867 target_modesense_write_protect(unsigned char *buf, int type)
870 * I believe that the WP bit (bit 7) in the mode header is the same for
871 * all device types..
873 switch (type) {
874 case TYPE_DISK:
875 case TYPE_TAPE:
876 default:
877 buf[0] |= 0x80; /* WP bit */
878 break;
882 static void
883 target_modesense_dpofua(unsigned char *buf, int type)
885 switch (type) {
886 case TYPE_DISK:
887 buf[0] |= 0x10; /* DPOFUA bit */
888 break;
889 default:
890 break;
894 static int
895 target_emulate_modesense(struct se_cmd *cmd, int ten)
897 struct se_device *dev = cmd->se_dev;
898 char *cdb = cmd->t_task_cdb;
899 unsigned char *rbuf;
900 int type = dev->transport->get_device_type(dev);
901 int offset = (ten) ? 8 : 4;
902 int length = 0;
903 unsigned char buf[SE_MODE_PAGE_BUF];
905 memset(buf, 0, SE_MODE_PAGE_BUF);
907 switch (cdb[2] & 0x3f) {
908 case 0x01:
909 length = target_modesense_rwrecovery(&buf[offset]);
910 break;
911 case 0x08:
912 length = target_modesense_caching(dev, &buf[offset]);
913 break;
914 case 0x0a:
915 length = target_modesense_control(dev, &buf[offset]);
916 break;
917 case 0x3f:
918 length = target_modesense_rwrecovery(&buf[offset]);
919 length += target_modesense_caching(dev, &buf[offset+length]);
920 length += target_modesense_control(dev, &buf[offset+length]);
921 break;
922 default:
923 pr_err("MODE SENSE: unimplemented page/subpage: 0x%02x/0x%02x\n",
924 cdb[2] & 0x3f, cdb[3]);
925 return PYX_TRANSPORT_UNKNOWN_MODE_PAGE;
927 offset += length;
929 if (ten) {
930 offset -= 2;
931 buf[0] = (offset >> 8) & 0xff;
932 buf[1] = offset & 0xff;
934 if ((cmd->se_lun->lun_access & TRANSPORT_LUNFLAGS_READ_ONLY) ||
935 (cmd->se_deve &&
936 (cmd->se_deve->lun_flags & TRANSPORT_LUNFLAGS_READ_ONLY)))
937 target_modesense_write_protect(&buf[3], type);
939 if ((dev->se_sub_dev->se_dev_attrib.emulate_write_cache > 0) &&
940 (dev->se_sub_dev->se_dev_attrib.emulate_fua_write > 0))
941 target_modesense_dpofua(&buf[3], type);
943 if ((offset + 2) > cmd->data_length)
944 offset = cmd->data_length;
946 } else {
947 offset -= 1;
948 buf[0] = offset & 0xff;
950 if ((cmd->se_lun->lun_access & TRANSPORT_LUNFLAGS_READ_ONLY) ||
951 (cmd->se_deve &&
952 (cmd->se_deve->lun_flags & TRANSPORT_LUNFLAGS_READ_ONLY)))
953 target_modesense_write_protect(&buf[2], type);
955 if ((dev->se_sub_dev->se_dev_attrib.emulate_write_cache > 0) &&
956 (dev->se_sub_dev->se_dev_attrib.emulate_fua_write > 0))
957 target_modesense_dpofua(&buf[2], type);
959 if ((offset + 1) > cmd->data_length)
960 offset = cmd->data_length;
963 rbuf = transport_kmap_first_data_page(cmd);
964 memcpy(rbuf, buf, offset);
965 transport_kunmap_first_data_page(cmd);
967 return 0;
970 static int
971 target_emulate_request_sense(struct se_cmd *cmd)
973 unsigned char *cdb = cmd->t_task_cdb;
974 unsigned char *buf;
975 u8 ua_asc = 0, ua_ascq = 0;
976 int err = 0;
978 if (cdb[1] & 0x01) {
979 pr_err("REQUEST_SENSE description emulation not"
980 " supported\n");
981 return PYX_TRANSPORT_INVALID_CDB_FIELD;
984 buf = transport_kmap_first_data_page(cmd);
986 if (!core_scsi3_ua_clear_for_request_sense(cmd, &ua_asc, &ua_ascq)) {
988 * CURRENT ERROR, UNIT ATTENTION
990 buf[0] = 0x70;
991 buf[SPC_SENSE_KEY_OFFSET] = UNIT_ATTENTION;
993 * Make sure request data length is enough for additional
994 * sense data.
996 if (cmd->data_length <= 18) {
997 buf[7] = 0x00;
998 err = -EINVAL;
999 goto end;
1002 * The Additional Sense Code (ASC) from the UNIT ATTENTION
1004 buf[SPC_ASC_KEY_OFFSET] = ua_asc;
1005 buf[SPC_ASCQ_KEY_OFFSET] = ua_ascq;
1006 buf[7] = 0x0A;
1007 } else {
1009 * CURRENT ERROR, NO SENSE
1011 buf[0] = 0x70;
1012 buf[SPC_SENSE_KEY_OFFSET] = NO_SENSE;
1014 * Make sure request data length is enough for additional
1015 * sense data.
1017 if (cmd->data_length <= 18) {
1018 buf[7] = 0x00;
1019 err = -EINVAL;
1020 goto end;
1023 * NO ADDITIONAL SENSE INFORMATION
1025 buf[SPC_ASC_KEY_OFFSET] = 0x00;
1026 buf[7] = 0x0A;
1029 end:
1030 transport_kunmap_first_data_page(cmd);
1032 return 0;
1036 * Used for TCM/IBLOCK and TCM/FILEIO for block/blk-lib.c level discard support.
1037 * Note this is not used for TCM/pSCSI passthrough
1039 static int
1040 target_emulate_unmap(struct se_task *task)
1042 struct se_cmd *cmd = task->task_se_cmd;
1043 struct se_device *dev = cmd->se_dev;
1044 unsigned char *buf, *ptr = NULL;
1045 unsigned char *cdb = &cmd->t_task_cdb[0];
1046 sector_t lba;
1047 unsigned int size = cmd->data_length, range;
1048 int ret = 0, offset;
1049 unsigned short dl, bd_dl;
1051 /* First UNMAP block descriptor starts at 8 byte offset */
1052 offset = 8;
1053 size -= 8;
1054 dl = get_unaligned_be16(&cdb[0]);
1055 bd_dl = get_unaligned_be16(&cdb[2]);
1057 buf = transport_kmap_first_data_page(cmd);
1059 ptr = &buf[offset];
1060 pr_debug("UNMAP: Sub: %s Using dl: %hu bd_dl: %hu size: %hu"
1061 " ptr: %p\n", dev->transport->name, dl, bd_dl, size, ptr);
1063 while (size) {
1064 lba = get_unaligned_be64(&ptr[0]);
1065 range = get_unaligned_be32(&ptr[8]);
1066 pr_debug("UNMAP: Using lba: %llu and range: %u\n",
1067 (unsigned long long)lba, range);
1069 ret = dev->transport->do_discard(dev, lba, range);
1070 if (ret < 0) {
1071 pr_err("blkdev_issue_discard() failed: %d\n",
1072 ret);
1073 goto err;
1076 ptr += 16;
1077 size -= 16;
1080 err:
1081 transport_kunmap_first_data_page(cmd);
1083 return ret;
1087 * Used for TCM/IBLOCK and TCM/FILEIO for block/blk-lib.c level discard support.
1088 * Note this is not used for TCM/pSCSI passthrough
1090 static int
1091 target_emulate_write_same(struct se_task *task, u32 num_blocks)
1093 struct se_cmd *cmd = task->task_se_cmd;
1094 struct se_device *dev = cmd->se_dev;
1095 sector_t range;
1096 sector_t lba = cmd->t_task_lba;
1097 int ret;
1099 * Use the explicit range when non zero is supplied, otherwise calculate
1100 * the remaining range based on ->get_blocks() - starting LBA.
1102 if (num_blocks != 0)
1103 range = num_blocks;
1104 else
1105 range = (dev->transport->get_blocks(dev) - lba);
1107 pr_debug("WRITE_SAME UNMAP: LBA: %llu Range: %llu\n",
1108 (unsigned long long)lba, (unsigned long long)range);
1110 ret = dev->transport->do_discard(dev, lba, range);
1111 if (ret < 0) {
1112 pr_debug("blkdev_issue_discard() failed for WRITE_SAME\n");
1113 return ret;
1116 return 0;
1120 transport_emulate_control_cdb(struct se_task *task)
1122 struct se_cmd *cmd = task->task_se_cmd;
1123 struct se_device *dev = cmd->se_dev;
1124 unsigned short service_action;
1125 int ret = 0;
1127 switch (cmd->t_task_cdb[0]) {
1128 case INQUIRY:
1129 ret = target_emulate_inquiry(cmd);
1130 break;
1131 case READ_CAPACITY:
1132 ret = target_emulate_readcapacity(cmd);
1133 break;
1134 case MODE_SENSE:
1135 ret = target_emulate_modesense(cmd, 0);
1136 break;
1137 case MODE_SENSE_10:
1138 ret = target_emulate_modesense(cmd, 1);
1139 break;
1140 case SERVICE_ACTION_IN:
1141 switch (cmd->t_task_cdb[1] & 0x1f) {
1142 case SAI_READ_CAPACITY_16:
1143 ret = target_emulate_readcapacity_16(cmd);
1144 break;
1145 default:
1146 pr_err("Unsupported SA: 0x%02x\n",
1147 cmd->t_task_cdb[1] & 0x1f);
1148 return PYX_TRANSPORT_UNKNOWN_SAM_OPCODE;
1150 break;
1151 case REQUEST_SENSE:
1152 ret = target_emulate_request_sense(cmd);
1153 break;
1154 case UNMAP:
1155 if (!dev->transport->do_discard) {
1156 pr_err("UNMAP emulation not supported for: %s\n",
1157 dev->transport->name);
1158 return PYX_TRANSPORT_UNKNOWN_SAM_OPCODE;
1160 ret = target_emulate_unmap(task);
1161 break;
1162 case WRITE_SAME:
1163 if (!dev->transport->do_discard) {
1164 pr_err("WRITE_SAME emulation not supported"
1165 " for: %s\n", dev->transport->name);
1166 return PYX_TRANSPORT_UNKNOWN_SAM_OPCODE;
1168 ret = target_emulate_write_same(task,
1169 get_unaligned_be16(&cmd->t_task_cdb[7]));
1170 break;
1171 case WRITE_SAME_16:
1172 if (!dev->transport->do_discard) {
1173 pr_err("WRITE_SAME_16 emulation not supported"
1174 " for: %s\n", dev->transport->name);
1175 return PYX_TRANSPORT_UNKNOWN_SAM_OPCODE;
1177 ret = target_emulate_write_same(task,
1178 get_unaligned_be32(&cmd->t_task_cdb[10]));
1179 break;
1180 case VARIABLE_LENGTH_CMD:
1181 service_action =
1182 get_unaligned_be16(&cmd->t_task_cdb[8]);
1183 switch (service_action) {
1184 case WRITE_SAME_32:
1185 if (!dev->transport->do_discard) {
1186 pr_err("WRITE_SAME_32 SA emulation not"
1187 " supported for: %s\n",
1188 dev->transport->name);
1189 return PYX_TRANSPORT_UNKNOWN_SAM_OPCODE;
1191 ret = target_emulate_write_same(task,
1192 get_unaligned_be32(&cmd->t_task_cdb[28]));
1193 break;
1194 default:
1195 pr_err("Unsupported VARIABLE_LENGTH_CMD SA:"
1196 " 0x%02x\n", service_action);
1197 break;
1199 break;
1200 case SYNCHRONIZE_CACHE:
1201 case 0x91: /* SYNCHRONIZE_CACHE_16: */
1202 if (!dev->transport->do_sync_cache) {
1203 pr_err("SYNCHRONIZE_CACHE emulation not supported"
1204 " for: %s\n", dev->transport->name);
1205 return PYX_TRANSPORT_UNKNOWN_SAM_OPCODE;
1207 dev->transport->do_sync_cache(task);
1208 break;
1209 case ALLOW_MEDIUM_REMOVAL:
1210 case ERASE:
1211 case REZERO_UNIT:
1212 case SEEK_10:
1213 case SPACE:
1214 case START_STOP:
1215 case TEST_UNIT_READY:
1216 case VERIFY:
1217 case WRITE_FILEMARKS:
1218 break;
1219 default:
1220 pr_err("Unsupported SCSI Opcode: 0x%02x for %s\n",
1221 cmd->t_task_cdb[0], dev->transport->name);
1222 return PYX_TRANSPORT_UNKNOWN_SAM_OPCODE;
1225 if (ret < 0)
1226 return ret;
1228 * Handle the successful completion here unless a caller
1229 * has explictly requested an asychronous completion.
1231 if (!(cmd->se_cmd_flags & SCF_EMULATE_CDB_ASYNC)) {
1232 task->task_scsi_status = GOOD;
1233 transport_complete_task(task, 1);
1236 return PYX_TRANSPORT_SENT_TO_TRANSPORT;