Loading...
1/*
2 * CDB emulation for non-READ/WRITE commands.
3 *
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
8 *
9 * Nicholas A. Bellinger <nab@kernel.org>
10 *
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.
15 *
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.
20 *
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.
24 */
25
26#include <linux/kernel.h>
27#include <linux/ctype.h>
28#include <asm/unaligned.h>
29#include <scsi/scsi.h>
30
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"
35
36static void
37target_fill_alua_data(struct se_port *port, unsigned char *buf)
38{
39 struct t10_alua_tg_pt_gp *tg_pt_gp;
40 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
41
42 /*
43 * Set SCCS for MAINTENANCE_IN + REPORT_TARGET_PORT_GROUPS.
44 */
45 buf[5] = 0x80;
46
47 /*
48 * Set TPGS field for explict and/or implict ALUA access type
49 * and opteration.
50 *
51 * See spc4r17 section 6.4.2 Table 135
52 */
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;
58
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);
64}
65
66static int
67target_emulate_inquiry_std(struct se_cmd *cmd)
68{
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;
73
74 /*
75 * Make sure we at least have 6 bytes of INQUIRY response
76 * payload going back for EVPD=0
77 */
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;
82 }
83
84 buf = transport_kmap_first_data_page(cmd);
85
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;
92 }
93 buf[2] = dev->transport->get_device_rev(dev);
94
95 /*
96 * Enable SCCS and TPGS fields for Emulated ALUA
97 */
98 if (dev->se_sub_dev->t10_alua.alua_type == SPC3_ALUA_EMULATED)
99 target_fill_alua_data(lun->lun_sep, buf);
100
101 if (cmd->data_length < 8) {
102 buf[4] = 1; /* Set additional length to 1 */
103 goto out;
104 }
105
106 buf[7] = 0x32; /* Sync=1 and CmdQue=1 */
107
108 /*
109 * Do not include vendor, product, reversion info in INQUIRY
110 * response payload for cdbs with a small allocation length.
111 */
112 if (cmd->data_length < 36) {
113 buf[4] = 3; /* Set additional length to 3 */
114 goto out;
115 }
116
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 */
123
124out:
125 transport_kunmap_first_data_page(cmd);
126 return 0;
127}
128
129/* unit serial number */
130static int
131target_emulate_evpd_80(struct se_cmd *cmd, unsigned char *buf)
132{
133 struct se_device *dev = cmd->se_dev;
134 u16 len = 0;
135
136 if (dev->se_sub_dev->su_dev_flags &
137 SDF_EMULATED_VPD_UNIT_SERIAL) {
138 u32 unit_serial_len;
139
140 unit_serial_len =
141 strlen(&dev->se_sub_dev->t10_wwn.unit_serial[0]);
142 unit_serial_len++; /* For NULL Terminator */
143
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;
149 }
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;
154 }
155 return 0;
156}
157
158static void
159target_parse_naa_6h_vendor_specific(struct se_device *dev, unsigned char *buf_off)
160{
161 unsigned char *p = &dev->se_sub_dev->t10_wwn.unit_serial[0];
162 unsigned char *buf = buf_off;
163 int cnt = 0, next = 1;
164 /*
165 * Generate up to 36 bits of VENDOR SPECIFIC IDENTIFIER starting on
166 * byte 3 bit 3-0 for NAA IEEE Registered Extended DESIGNATOR field
167 * format, followed by 64 bits of VENDOR SPECIFIC IDENTIFIER EXTENSION
168 * to complete the payload. These are based from VPD=0x80 PRODUCT SERIAL
169 * NUMBER set via vpd_unit_serial in target_core_configfs.c to ensure
170 * per device uniqeness.
171 */
172 while (*p != '\0') {
173 if (cnt >= 13)
174 break;
175 if (!isxdigit(*p)) {
176 p++;
177 continue;
178 }
179 if (next != 0) {
180 buf[cnt++] |= hex_to_bin(*p++);
181 next = 0;
182 } else {
183 buf[cnt] = hex_to_bin(*p++) << 4;
184 next = 1;
185 }
186 }
187}
188
189/*
190 * Device identification VPD, for a complete list of
191 * DESIGNATOR TYPEs see spc4r17 Table 459.
192 */
193static int
194target_emulate_evpd_83(struct se_cmd *cmd, unsigned char *buf)
195{
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;
207
208 off = 4;
209
210 /*
211 * NAA IEEE Registered Extended Assigned designator format, see
212 * spc4r17 section 7.7.3.6.5
213 *
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.
217 */
218 if (!(dev->se_sub_dev->su_dev_flags & SDF_EMULATED_VPD_UNIT_SERIAL))
219 goto check_t10_vend_desc;
220
221 if (off + 20 > cmd->data_length)
222 goto check_t10_vend_desc;
223
224 /* CODE SET == Binary */
225 buf[off++] = 0x1;
226
227 /* Set ASSOCIATION == addressed logical unit: 0)b */
228 buf[off] = 0x00;
229
230 /* Identifier/Designator type == NAA identifier */
231 buf[off++] |= 0x3;
232 off++;
233
234 /* Identifier/Designator length */
235 buf[off++] = 0x10;
236
237 /*
238 * Start NAA IEEE Registered Extended Identifier/Designator
239 */
240 buf[off++] = (0x6 << 4);
241
242 /*
243 * Use OpenFabrics IEEE Company ID: 00 14 05
244 */
245 buf[off++] = 0x01;
246 buf[off++] = 0x40;
247 buf[off] = (0x5 << 4);
248
249 /*
250 * Return ConfigFS Unit Serial Number information for
251 * VENDOR_SPECIFIC_IDENTIFIER and
252 * VENDOR_SPECIFIC_IDENTIFIER_EXTENTION
253 */
254 target_parse_naa_6h_vendor_specific(dev, &buf[off]);
255
256 len = 20;
257 off = (len + 4);
258
259check_t10_vend_desc:
260 /*
261 * T10 Vendor Identifier Page, see spc4r17 section 7.7.3.4
262 */
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 : */
268
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 */
274
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;
280 }
281 id_len += sprintf((unsigned char *)&buf[off+12],
282 "%s:%s", prod,
283 &dev->se_sub_dev->t10_wwn.unit_serial[0]);
284 }
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);
296 /*
297 * struct se_port is only set for INQUIRY VPD=1 through $FABRIC_MOD
298 */
299check_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;
307
308 tpg = port->sep_tpg;
309 /*
310 * Relative target port identifer, see spc4r17
311 * section 7.7.3.7
312 *
313 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
314 * section 7.5.1 Table 362
315 */
316 if (((len + 4) + 8) > cmd->data_length) {
317 len += 8;
318 goto check_tpgi;
319 }
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 */
336 /*
337 * Target port group identifier, see spc4r17
338 * section 7.7.3.8
339 *
340 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
341 * section 7.5.1 Table 362
342 */
343check_tpgi:
344 if (dev->se_sub_dev->t10_alua.alua_type !=
345 SPC3_ALUA_EMULATED)
346 goto check_scsi_name;
347
348 if (((len + 4) + 8) > cmd->data_length) {
349 len += 8;
350 goto check_lu_gp;
351 }
352 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
353 if (!tg_pt_gp_mem)
354 goto check_lu_gp;
355
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;
361 }
362 tg_pt_gp_id = tg_pt_gp->tg_pt_gp_id;
363 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
364
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 */
379 /*
380 * Logical Unit Group identifier, see spc4r17
381 * section 7.7.3.8
382 */
383check_lu_gp:
384 if (((len + 4) + 8) > cmd->data_length) {
385 len += 8;
386 goto check_scsi_name;
387 }
388 lu_gp_mem = dev->dev_alua_lu_gp_mem;
389 if (!lu_gp_mem)
390 goto check_scsi_name;
391
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;
397 }
398 lu_gp_id = lu_gp->lu_gp_id;
399 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
400
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 */
410 /*
411 * SCSI name string designator, see spc4r17
412 * section 7.7.3.11
413 *
414 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
415 * section 7.5.1 Table 362
416 */
417check_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;
427
428 if (((len + 4) + scsi_name_len) > cmd->data_length) {
429 len += scsi_name_len;
430 goto set_len;
431 }
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 */
441 /*
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.
446 */
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 */;
451 /*
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.
458 */
459 if (padding)
460 scsi_name_len += padding;
461
462 buf[off-1] = scsi_name_len;
463 off += scsi_name_len;
464 /* Header size + Designation descriptor */
465 len += (scsi_name_len + 4);
466 }
467set_len:
468 buf[2] = ((len >> 8) & 0xff);
469 buf[3] = (len & 0xff); /* Page Length for VPD 0x83 */
470 return 0;
471}
472
473/* Extended INQUIRY Data VPD Page */
474static int
475target_emulate_evpd_86(struct se_cmd *cmd, unsigned char *buf)
476{
477 if (cmd->data_length < 60)
478 return 0;
479
480 buf[2] = 0x3c;
481 /* Set HEADSUP, ORDSUP, SIMPSUP */
482 buf[5] = 0x07;
483
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;
488}
489
490/* Block Limits VPD page */
491static int
492target_emulate_evpd_b0(struct se_cmd *cmd, unsigned char *buf)
493{
494 struct se_device *dev = cmd->se_dev;
495 int have_tp = 0;
496
497 /*
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.
501 */
502 if (dev->se_sub_dev->se_dev_attrib.emulate_tpu || dev->se_sub_dev->se_dev_attrib.emulate_tpws)
503 have_tp = 1;
504
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;
510 }
511
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;
517 }
518
519 buf[0] = dev->transport->get_device_type(dev);
520 buf[3] = have_tp ? 0x3c : 0x10;
521
522 /* Set WSNZ to 1 */
523 buf[4] = 0x01;
524
525 /*
526 * Set OPTIMAL TRANSFER LENGTH GRANULARITY
527 */
528 put_unaligned_be16(1, &buf[6]);
529
530 /*
531 * Set MAXIMUM TRANSFER LENGTH
532 */
533 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.max_sectors, &buf[8]);
534
535 /*
536 * Set OPTIMAL TRANSFER LENGTH
537 */
538 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.optimal_sectors, &buf[12]);
539
540 /*
541 * Exit now if we don't support TP or the initiator sent a too
542 * short buffer.
543 */
544 if (!have_tp || cmd->data_length < (0x3c + 4))
545 return 0;
546
547 /*
548 * Set MAXIMUM UNMAP LBA COUNT
549 */
550 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.max_unmap_lba_count, &buf[20]);
551
552 /*
553 * Set MAXIMUM UNMAP BLOCK DESCRIPTOR COUNT
554 */
555 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.max_unmap_block_desc_count,
556 &buf[24]);
557
558 /*
559 * Set OPTIMAL UNMAP GRANULARITY
560 */
561 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.unmap_granularity, &buf[28]);
562
563 /*
564 * UNMAP GRANULARITY ALIGNMENT
565 */
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 */
570
571 return 0;
572}
573
574/* Block Device Characteristics VPD page */
575static int
576target_emulate_evpd_b1(struct se_cmd *cmd, unsigned char *buf)
577{
578 struct se_device *dev = cmd->se_dev;
579
580 buf[0] = dev->transport->get_device_type(dev);
581 buf[3] = 0x3c;
582
583 if (cmd->data_length >= 5 &&
584 dev->se_sub_dev->se_dev_attrib.is_nonrot)
585 buf[5] = 1;
586
587 return 0;
588}
589
590/* Thin Provisioning VPD */
591static int
592target_emulate_evpd_b2(struct se_cmd *cmd, unsigned char *buf)
593{
594 struct se_device *dev = cmd->se_dev;
595
596 /*
597 * From sbc3r22 section 6.5.4 Thin Provisioning VPD page:
598 *
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.
603 */
604 buf[0] = dev->transport->get_device_type(dev);
605
606 /*
607 * Set Hardcoded length mentioned above for DP=0
608 */
609 put_unaligned_be16(0x0004, &buf[2]);
610
611 /*
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)).
615 *
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.
619 */
620 buf[4] = 0x00;
621
622 /*
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.
626 */
627 if (dev->se_sub_dev->se_dev_attrib.emulate_tpu != 0)
628 buf[5] = 0x80;
629
630 /*
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.
635 */
636 if (dev->se_sub_dev->se_dev_attrib.emulate_tpws != 0)
637 buf[5] |= 0x40;
638
639 return 0;
640}
641
642static int
643target_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf);
644
645static 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 },
656};
657
658/* supported vital product data pages */
659static int
660target_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf)
661{
662 int p;
663
664 if (cmd->data_length < 8)
665 return 0;
666 /*
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.
670 */
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;
677 }
678
679 return 0;
680}
681
682static int
683target_emulate_inquiry(struct se_cmd *cmd)
684{
685 struct se_device *dev = cmd->se_dev;
686 unsigned char *buf;
687 unsigned char *cdb = cmd->t_task_cdb;
688 int p, ret;
689
690 if (!(cdb[1] & 0x1))
691 return target_emulate_inquiry_std(cmd);
692
693 /*
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
699 */
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;
704 }
705
706 buf = transport_kmap_first_data_page(cmd);
707
708 buf[0] = dev->transport->get_device_type(dev);
709
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;
716 }
717
718 transport_kunmap_first_data_page(cmd);
719 pr_err("Unknown VPD Code: 0x%02x\n", cdb[2]);
720 return -EINVAL;
721}
722
723static int
724target_emulate_readcapacity(struct se_cmd *cmd)
725{
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;
730
731 if (blocks_long >= 0x00000000ffffffff)
732 blocks = 0xffffffff;
733 else
734 blocks = (u32)blocks_long;
735
736 buf = transport_kmap_first_data_page(cmd);
737
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;
746 /*
747 * Set max 32-bit blocks to signal SERVICE ACTION READ_CAPACITY_16
748 */
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]);
751
752 transport_kunmap_first_data_page(cmd);
753
754 return 0;
755}
756
757static int
758target_emulate_readcapacity_16(struct se_cmd *cmd)
759{
760 struct se_device *dev = cmd->se_dev;
761 unsigned char *buf;
762 unsigned long long blocks = dev->transport->get_blocks(dev);
763
764 buf = transport_kmap_first_data_page(cmd);
765
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;
778 /*
779 * Set Thin Provisioning Enable bit following sbc3r22 in section
780 * READ CAPACITY (16) byte 14 if emulate_tpu or emulate_tpws is enabled.
781 */
782 if (dev->se_sub_dev->se_dev_attrib.emulate_tpu || dev->se_sub_dev->se_dev_attrib.emulate_tpws)
783 buf[14] = 0x80;
784
785 transport_kunmap_first_data_page(cmd);
786
787 return 0;
788}
789
790static int
791target_modesense_rwrecovery(unsigned char *p)
792{
793 p[0] = 0x01;
794 p[1] = 0x0a;
795
796 return 12;
797}
798
799static int
800target_modesense_control(struct se_device *dev, unsigned char *p)
801{
802 p[0] = 0x0a;
803 p[1] = 0x0a;
804 p[2] = 2;
805 /*
806 * From spc4r23, 7.4.7 Control mode page
807 *
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).
811 *
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
818 *
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).
826 *
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.
832 */
833 p[3] = (dev->se_sub_dev->se_dev_attrib.emulate_rest_reord == 1) ? 0x00 : 0x10;
834 /*
835 * From spc4r17, section 7.4.6 Control mode Page
836 *
837 * Unit Attention interlocks control (UN_INTLCK_CTRL) to code 00b
838 *
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.
844 *
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.
850 *
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.
862 */
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;
865 /*
866 * From spc4r17, section 7.4.6 Control mode Page
867 *
868 * Task Aborted Status (TAS) bit set to zero.
869 *
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).
876 */
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;
881
882 return 12;
883}
884
885static int
886target_modesense_caching(struct se_device *dev, unsigned char *p)
887{
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 */
893
894 return 20;
895}
896
897static void
898target_modesense_write_protect(unsigned char *buf, int type)
899{
900 /*
901 * I believe that the WP bit (bit 7) in the mode header is the same for
902 * all device types..
903 */
904 switch (type) {
905 case TYPE_DISK:
906 case TYPE_TAPE:
907 default:
908 buf[0] |= 0x80; /* WP bit */
909 break;
910 }
911}
912
913static void
914target_modesense_dpofua(unsigned char *buf, int type)
915{
916 switch (type) {
917 case TYPE_DISK:
918 buf[0] |= 0x10; /* DPOFUA bit */
919 break;
920 default:
921 break;
922 }
923}
924
925static int
926target_emulate_modesense(struct se_cmd *cmd, int ten)
927{
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];
935
936 memset(buf, 0, SE_MODE_PAGE_BUF);
937
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;
957 }
958 offset += length;
959
960 if (ten) {
961 offset -= 2;
962 buf[0] = (offset >> 8) & 0xff;
963 buf[1] = offset & 0xff;
964
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);
969
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);
973
974 if ((offset + 2) > cmd->data_length)
975 offset = cmd->data_length;
976
977 } else {
978 offset -= 1;
979 buf[0] = offset & 0xff;
980
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);
985
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);
989
990 if ((offset + 1) > cmd->data_length)
991 offset = cmd->data_length;
992 }
993
994 rbuf = transport_kmap_first_data_page(cmd);
995 memcpy(rbuf, buf, offset);
996 transport_kunmap_first_data_page(cmd);
997
998 return 0;
999}
1000
1001static int
1002target_emulate_request_sense(struct se_cmd *cmd)
1003{
1004 unsigned char *cdb = cmd->t_task_cdb;
1005 unsigned char *buf;
1006 u8 ua_asc = 0, ua_ascq = 0;
1007 int err = 0;
1008
1009 if (cdb[1] & 0x01) {
1010 pr_err("REQUEST_SENSE description emulation not"
1011 " supported\n");
1012 return PYX_TRANSPORT_INVALID_CDB_FIELD;
1013 }
1014
1015 buf = transport_kmap_first_data_page(cmd);
1016
1017 if (!core_scsi3_ua_clear_for_request_sense(cmd, &ua_asc, &ua_ascq)) {
1018 /*
1019 * CURRENT ERROR, UNIT ATTENTION
1020 */
1021 buf[0] = 0x70;
1022 buf[SPC_SENSE_KEY_OFFSET] = UNIT_ATTENTION;
1023 /*
1024 * Make sure request data length is enough for additional
1025 * sense data.
1026 */
1027 if (cmd->data_length <= 18) {
1028 buf[7] = 0x00;
1029 err = -EINVAL;
1030 goto end;
1031 }
1032 /*
1033 * The Additional Sense Code (ASC) from the UNIT ATTENTION
1034 */
1035 buf[SPC_ASC_KEY_OFFSET] = ua_asc;
1036 buf[SPC_ASCQ_KEY_OFFSET] = ua_ascq;
1037 buf[7] = 0x0A;
1038 } else {
1039 /*
1040 * CURRENT ERROR, NO SENSE
1041 */
1042 buf[0] = 0x70;
1043 buf[SPC_SENSE_KEY_OFFSET] = NO_SENSE;
1044 /*
1045 * Make sure request data length is enough for additional
1046 * sense data.
1047 */
1048 if (cmd->data_length <= 18) {
1049 buf[7] = 0x00;
1050 err = -EINVAL;
1051 goto end;
1052 }
1053 /*
1054 * NO ADDITIONAL SENSE INFORMATION
1055 */
1056 buf[SPC_ASC_KEY_OFFSET] = 0x00;
1057 buf[7] = 0x0A;
1058 }
1059
1060end:
1061 transport_kunmap_first_data_page(cmd);
1062
1063 return 0;
1064}
1065
1066/*
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
1069 */
1070static int
1071target_emulate_unmap(struct se_task *task)
1072{
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;
1081
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]);
1087
1088 buf = transport_kmap_first_data_page(cmd);
1089
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);
1093
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);
1099
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;
1105 }
1106
1107 ptr += 16;
1108 size -= 16;
1109 }
1110
1111err:
1112 transport_kunmap_first_data_page(cmd);
1113
1114 return ret;
1115}
1116
1117/*
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
1120 */
1121static int
1122target_emulate_write_same(struct se_task *task, u32 num_blocks)
1123{
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;
1129 /*
1130 * Use the explicit range when non zero is supplied, otherwise calculate
1131 * the remaining range based on ->get_blocks() - starting LBA.
1132 */
1133 if (num_blocks != 0)
1134 range = num_blocks;
1135 else
1136 range = (dev->transport->get_blocks(dev) - lba);
1137
1138 pr_debug("WRITE_SAME UNMAP: LBA: %llu Range: %llu\n",
1139 (unsigned long long)lba, (unsigned long long)range);
1140
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;
1145 }
1146
1147 return 0;
1148}
1149
1150int
1151transport_emulate_control_cdb(struct se_task *task)
1152{
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;
1157
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;
1180 }
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;
1190 }
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;
1198 }
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;
1207 }
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;
1221 }
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;
1229 }
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;
1237 }
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;
1254 }
1255
1256 if (ret < 0)
1257 return ret;
1258 /*
1259 * Handle the successful completion here unless a caller
1260 * has explictly requested an asychronous completion.
1261 */
1262 if (!(cmd->se_cmd_flags & SCF_EMULATE_CDB_ASYNC)) {
1263 task->task_scsi_status = GOOD;
1264 transport_complete_task(task, 1);
1265 }
1266
1267 return PYX_TRANSPORT_SENT_TO_TRANSPORT;
1268}
1/*
2 * CDB emulation for non-READ/WRITE commands.
3 *
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
8 *
9 * Nicholas A. Bellinger <nab@kernel.org>
10 *
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.
15 *
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.
20 *
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.
24 */
25
26#include <linux/kernel.h>
27#include <linux/module.h>
28#include <asm/unaligned.h>
29#include <scsi/scsi.h>
30
31#include <target/target_core_base.h>
32#include <target/target_core_backend.h>
33#include <target/target_core_fabric.h>
34
35#include "target_core_internal.h"
36#include "target_core_ua.h"
37
38static void
39target_fill_alua_data(struct se_port *port, unsigned char *buf)
40{
41 struct t10_alua_tg_pt_gp *tg_pt_gp;
42 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
43
44 /*
45 * Set SCCS for MAINTENANCE_IN + REPORT_TARGET_PORT_GROUPS.
46 */
47 buf[5] = 0x80;
48
49 /*
50 * Set TPGS field for explict and/or implict ALUA access type
51 * and opteration.
52 *
53 * See spc4r17 section 6.4.2 Table 135
54 */
55 if (!port)
56 return;
57 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
58 if (!tg_pt_gp_mem)
59 return;
60
61 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
62 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
63 if (tg_pt_gp)
64 buf[5] |= tg_pt_gp->tg_pt_gp_alua_access_type;
65 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
66}
67
68static int
69target_emulate_inquiry_std(struct se_cmd *cmd, char *buf)
70{
71 struct se_lun *lun = cmd->se_lun;
72 struct se_device *dev = cmd->se_dev;
73
74 /* Set RMB (removable media) for tape devices */
75 if (dev->transport->get_device_type(dev) == TYPE_TAPE)
76 buf[1] = 0x80;
77
78 buf[2] = dev->transport->get_device_rev(dev);
79
80 /*
81 * NORMACA and HISUP = 0, RESPONSE DATA FORMAT = 2
82 *
83 * SPC4 says:
84 * A RESPONSE DATA FORMAT field set to 2h indicates that the
85 * standard INQUIRY data is in the format defined in this
86 * standard. Response data format values less than 2h are
87 * obsolete. Response data format values greater than 2h are
88 * reserved.
89 */
90 buf[3] = 2;
91
92 /*
93 * Enable SCCS and TPGS fields for Emulated ALUA
94 */
95 if (dev->se_sub_dev->t10_alua.alua_type == SPC3_ALUA_EMULATED)
96 target_fill_alua_data(lun->lun_sep, buf);
97
98 buf[7] = 0x2; /* CmdQue=1 */
99
100 snprintf(&buf[8], 8, "LIO-ORG");
101 snprintf(&buf[16], 16, "%s", dev->se_sub_dev->t10_wwn.model);
102 snprintf(&buf[32], 4, "%s", dev->se_sub_dev->t10_wwn.revision);
103 buf[4] = 31; /* Set additional length to 31 */
104
105 return 0;
106}
107
108/* unit serial number */
109static int
110target_emulate_evpd_80(struct se_cmd *cmd, unsigned char *buf)
111{
112 struct se_device *dev = cmd->se_dev;
113 u16 len = 0;
114
115 if (dev->se_sub_dev->su_dev_flags &
116 SDF_EMULATED_VPD_UNIT_SERIAL) {
117 u32 unit_serial_len;
118
119 unit_serial_len = strlen(dev->se_sub_dev->t10_wwn.unit_serial);
120 unit_serial_len++; /* For NULL Terminator */
121
122 len += sprintf(&buf[4], "%s",
123 dev->se_sub_dev->t10_wwn.unit_serial);
124 len++; /* Extra Byte for NULL Terminator */
125 buf[3] = len;
126 }
127 return 0;
128}
129
130static void
131target_parse_naa_6h_vendor_specific(struct se_device *dev, unsigned char *buf)
132{
133 unsigned char *p = &dev->se_sub_dev->t10_wwn.unit_serial[0];
134 int cnt;
135 bool next = true;
136
137 /*
138 * Generate up to 36 bits of VENDOR SPECIFIC IDENTIFIER starting on
139 * byte 3 bit 3-0 for NAA IEEE Registered Extended DESIGNATOR field
140 * format, followed by 64 bits of VENDOR SPECIFIC IDENTIFIER EXTENSION
141 * to complete the payload. These are based from VPD=0x80 PRODUCT SERIAL
142 * NUMBER set via vpd_unit_serial in target_core_configfs.c to ensure
143 * per device uniqeness.
144 */
145 for (cnt = 0; *p && cnt < 13; p++) {
146 int val = hex_to_bin(*p);
147
148 if (val < 0)
149 continue;
150
151 if (next) {
152 next = false;
153 buf[cnt++] |= val;
154 } else {
155 next = true;
156 buf[cnt] = val << 4;
157 }
158 }
159}
160
161/*
162 * Device identification VPD, for a complete list of
163 * DESIGNATOR TYPEs see spc4r17 Table 459.
164 */
165static int
166target_emulate_evpd_83(struct se_cmd *cmd, unsigned char *buf)
167{
168 struct se_device *dev = cmd->se_dev;
169 struct se_lun *lun = cmd->se_lun;
170 struct se_port *port = NULL;
171 struct se_portal_group *tpg = NULL;
172 struct t10_alua_lu_gp_member *lu_gp_mem;
173 struct t10_alua_tg_pt_gp *tg_pt_gp;
174 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
175 unsigned char *prod = &dev->se_sub_dev->t10_wwn.model[0];
176 u32 prod_len;
177 u32 unit_serial_len, off = 0;
178 u16 len = 0, id_len;
179
180 off = 4;
181
182 /*
183 * NAA IEEE Registered Extended Assigned designator format, see
184 * spc4r17 section 7.7.3.6.5
185 *
186 * We depend upon a target_core_mod/ConfigFS provided
187 * /sys/kernel/config/target/core/$HBA/$DEV/wwn/vpd_unit_serial
188 * value in order to return the NAA id.
189 */
190 if (!(dev->se_sub_dev->su_dev_flags & SDF_EMULATED_VPD_UNIT_SERIAL))
191 goto check_t10_vend_desc;
192
193 /* CODE SET == Binary */
194 buf[off++] = 0x1;
195
196 /* Set ASSOCIATION == addressed logical unit: 0)b */
197 buf[off] = 0x00;
198
199 /* Identifier/Designator type == NAA identifier */
200 buf[off++] |= 0x3;
201 off++;
202
203 /* Identifier/Designator length */
204 buf[off++] = 0x10;
205
206 /*
207 * Start NAA IEEE Registered Extended Identifier/Designator
208 */
209 buf[off++] = (0x6 << 4);
210
211 /*
212 * Use OpenFabrics IEEE Company ID: 00 14 05
213 */
214 buf[off++] = 0x01;
215 buf[off++] = 0x40;
216 buf[off] = (0x5 << 4);
217
218 /*
219 * Return ConfigFS Unit Serial Number information for
220 * VENDOR_SPECIFIC_IDENTIFIER and
221 * VENDOR_SPECIFIC_IDENTIFIER_EXTENTION
222 */
223 target_parse_naa_6h_vendor_specific(dev, &buf[off]);
224
225 len = 20;
226 off = (len + 4);
227
228check_t10_vend_desc:
229 /*
230 * T10 Vendor Identifier Page, see spc4r17 section 7.7.3.4
231 */
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 : */
237
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 */
243
244 id_len += sprintf(&buf[off+12], "%s:%s", prod,
245 &dev->se_sub_dev->t10_wwn.unit_serial[0]);
246 }
247 buf[off] = 0x2; /* ASCII */
248 buf[off+1] = 0x1; /* T10 Vendor ID */
249 buf[off+2] = 0x0;
250 memcpy(&buf[off+4], "LIO-ORG", 8);
251 /* Extra Byte for NULL Terminator */
252 id_len++;
253 /* Identifier Length */
254 buf[off+3] = id_len;
255 /* Header size for Designation descriptor */
256 len += (id_len + 4);
257 off += (id_len + 4);
258 /*
259 * struct se_port is only set for INQUIRY VPD=1 through $FABRIC_MOD
260 */
261 port = lun->lun_sep;
262 if (port) {
263 struct t10_alua_lu_gp *lu_gp;
264 u32 padding, scsi_name_len;
265 u16 lu_gp_id = 0;
266 u16 tg_pt_gp_id = 0;
267 u16 tpgt;
268
269 tpg = port->sep_tpg;
270 /*
271 * Relative target port identifer, see spc4r17
272 * section 7.7.3.7
273 *
274 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
275 * section 7.5.1 Table 362
276 */
277 buf[off] =
278 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
279 buf[off++] |= 0x1; /* CODE SET == Binary */
280 buf[off] = 0x80; /* Set PIV=1 */
281 /* Set ASSOCIATION == target port: 01b */
282 buf[off] |= 0x10;
283 /* DESIGNATOR TYPE == Relative target port identifer */
284 buf[off++] |= 0x4;
285 off++; /* Skip over Reserved */
286 buf[off++] = 4; /* DESIGNATOR LENGTH */
287 /* Skip over Obsolete field in RTPI payload
288 * in Table 472 */
289 off += 2;
290 buf[off++] = ((port->sep_rtpi >> 8) & 0xff);
291 buf[off++] = (port->sep_rtpi & 0xff);
292 len += 8; /* Header size + Designation descriptor */
293 /*
294 * Target port group identifier, see spc4r17
295 * section 7.7.3.8
296 *
297 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
298 * section 7.5.1 Table 362
299 */
300 if (dev->se_sub_dev->t10_alua.alua_type !=
301 SPC3_ALUA_EMULATED)
302 goto check_scsi_name;
303
304 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
305 if (!tg_pt_gp_mem)
306 goto check_lu_gp;
307
308 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
309 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
310 if (!tg_pt_gp) {
311 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
312 goto check_lu_gp;
313 }
314 tg_pt_gp_id = tg_pt_gp->tg_pt_gp_id;
315 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
316
317 buf[off] =
318 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
319 buf[off++] |= 0x1; /* CODE SET == Binary */
320 buf[off] = 0x80; /* Set PIV=1 */
321 /* Set ASSOCIATION == target port: 01b */
322 buf[off] |= 0x10;
323 /* DESIGNATOR TYPE == Target port group identifier */
324 buf[off++] |= 0x5;
325 off++; /* Skip over Reserved */
326 buf[off++] = 4; /* DESIGNATOR LENGTH */
327 off += 2; /* Skip over Reserved Field */
328 buf[off++] = ((tg_pt_gp_id >> 8) & 0xff);
329 buf[off++] = (tg_pt_gp_id & 0xff);
330 len += 8; /* Header size + Designation descriptor */
331 /*
332 * Logical Unit Group identifier, see spc4r17
333 * section 7.7.3.8
334 */
335check_lu_gp:
336 lu_gp_mem = dev->dev_alua_lu_gp_mem;
337 if (!lu_gp_mem)
338 goto check_scsi_name;
339
340 spin_lock(&lu_gp_mem->lu_gp_mem_lock);
341 lu_gp = lu_gp_mem->lu_gp;
342 if (!lu_gp) {
343 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
344 goto check_scsi_name;
345 }
346 lu_gp_id = lu_gp->lu_gp_id;
347 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
348
349 buf[off++] |= 0x1; /* CODE SET == Binary */
350 /* DESIGNATOR TYPE == Logical Unit Group identifier */
351 buf[off++] |= 0x6;
352 off++; /* Skip over Reserved */
353 buf[off++] = 4; /* DESIGNATOR LENGTH */
354 off += 2; /* Skip over Reserved Field */
355 buf[off++] = ((lu_gp_id >> 8) & 0xff);
356 buf[off++] = (lu_gp_id & 0xff);
357 len += 8; /* Header size + Designation descriptor */
358 /*
359 * SCSI name string designator, see spc4r17
360 * section 7.7.3.11
361 *
362 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
363 * section 7.5.1 Table 362
364 */
365check_scsi_name:
366 scsi_name_len = strlen(tpg->se_tpg_tfo->tpg_get_wwn(tpg));
367 /* UTF-8 ",t,0x<16-bit TPGT>" + NULL Terminator */
368 scsi_name_len += 10;
369 /* Check for 4-byte padding */
370 padding = ((-scsi_name_len) & 3);
371 if (padding != 0)
372 scsi_name_len += padding;
373 /* Header size + Designation descriptor */
374 scsi_name_len += 4;
375
376 buf[off] =
377 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
378 buf[off++] |= 0x3; /* CODE SET == UTF-8 */
379 buf[off] = 0x80; /* Set PIV=1 */
380 /* Set ASSOCIATION == target port: 01b */
381 buf[off] |= 0x10;
382 /* DESIGNATOR TYPE == SCSI name string */
383 buf[off++] |= 0x8;
384 off += 2; /* Skip over Reserved and length */
385 /*
386 * SCSI name string identifer containing, $FABRIC_MOD
387 * dependent information. For LIO-Target and iSCSI
388 * Target Port, this means "<iSCSI name>,t,0x<TPGT> in
389 * UTF-8 encoding.
390 */
391 tpgt = tpg->se_tpg_tfo->tpg_get_tag(tpg);
392 scsi_name_len = sprintf(&buf[off], "%s,t,0x%04x",
393 tpg->se_tpg_tfo->tpg_get_wwn(tpg), tpgt);
394 scsi_name_len += 1 /* Include NULL terminator */;
395 /*
396 * The null-terminated, null-padded (see 4.4.2) SCSI
397 * NAME STRING field contains a UTF-8 format string.
398 * The number of bytes in the SCSI NAME STRING field
399 * (i.e., the value in the DESIGNATOR LENGTH field)
400 * shall be no larger than 256 and shall be a multiple
401 * of four.
402 */
403 if (padding)
404 scsi_name_len += padding;
405
406 buf[off-1] = scsi_name_len;
407 off += scsi_name_len;
408 /* Header size + Designation descriptor */
409 len += (scsi_name_len + 4);
410 }
411 buf[2] = ((len >> 8) & 0xff);
412 buf[3] = (len & 0xff); /* Page Length for VPD 0x83 */
413 return 0;
414}
415
416/* Extended INQUIRY Data VPD Page */
417static int
418target_emulate_evpd_86(struct se_cmd *cmd, unsigned char *buf)
419{
420 buf[3] = 0x3c;
421 /* Set HEADSUP, ORDSUP, SIMPSUP */
422 buf[5] = 0x07;
423
424 /* If WriteCache emulation is enabled, set V_SUP */
425 if (cmd->se_dev->se_sub_dev->se_dev_attrib.emulate_write_cache > 0)
426 buf[6] = 0x01;
427 return 0;
428}
429
430/* Block Limits VPD page */
431static int
432target_emulate_evpd_b0(struct se_cmd *cmd, unsigned char *buf)
433{
434 struct se_device *dev = cmd->se_dev;
435 u32 max_sectors;
436 int have_tp = 0;
437
438 /*
439 * Following sbc3r22 section 6.5.3 Block Limits VPD page, when
440 * emulate_tpu=1 or emulate_tpws=1 we will be expect a
441 * different page length for Thin Provisioning.
442 */
443 if (dev->se_sub_dev->se_dev_attrib.emulate_tpu || dev->se_sub_dev->se_dev_attrib.emulate_tpws)
444 have_tp = 1;
445
446 buf[0] = dev->transport->get_device_type(dev);
447 buf[3] = have_tp ? 0x3c : 0x10;
448
449 /* Set WSNZ to 1 */
450 buf[4] = 0x01;
451
452 /*
453 * Set OPTIMAL TRANSFER LENGTH GRANULARITY
454 */
455 put_unaligned_be16(1, &buf[6]);
456
457 /*
458 * Set MAXIMUM TRANSFER LENGTH
459 */
460 max_sectors = min(dev->se_sub_dev->se_dev_attrib.fabric_max_sectors,
461 dev->se_sub_dev->se_dev_attrib.hw_max_sectors);
462 put_unaligned_be32(max_sectors, &buf[8]);
463
464 /*
465 * Set OPTIMAL TRANSFER LENGTH
466 */
467 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.optimal_sectors, &buf[12]);
468
469 /*
470 * Exit now if we don't support TP.
471 */
472 if (!have_tp)
473 return 0;
474
475 /*
476 * Set MAXIMUM UNMAP LBA COUNT
477 */
478 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.max_unmap_lba_count, &buf[20]);
479
480 /*
481 * Set MAXIMUM UNMAP BLOCK DESCRIPTOR COUNT
482 */
483 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.max_unmap_block_desc_count,
484 &buf[24]);
485
486 /*
487 * Set OPTIMAL UNMAP GRANULARITY
488 */
489 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.unmap_granularity, &buf[28]);
490
491 /*
492 * UNMAP GRANULARITY ALIGNMENT
493 */
494 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.unmap_granularity_alignment,
495 &buf[32]);
496 if (dev->se_sub_dev->se_dev_attrib.unmap_granularity_alignment != 0)
497 buf[32] |= 0x80; /* Set the UGAVALID bit */
498
499 return 0;
500}
501
502/* Block Device Characteristics VPD page */
503static int
504target_emulate_evpd_b1(struct se_cmd *cmd, unsigned char *buf)
505{
506 struct se_device *dev = cmd->se_dev;
507
508 buf[0] = dev->transport->get_device_type(dev);
509 buf[3] = 0x3c;
510 buf[5] = dev->se_sub_dev->se_dev_attrib.is_nonrot ? 1 : 0;
511
512 return 0;
513}
514
515/* Thin Provisioning VPD */
516static int
517target_emulate_evpd_b2(struct se_cmd *cmd, unsigned char *buf)
518{
519 struct se_device *dev = cmd->se_dev;
520
521 /*
522 * From sbc3r22 section 6.5.4 Thin Provisioning VPD page:
523 *
524 * The PAGE LENGTH field is defined in SPC-4. If the DP bit is set to
525 * zero, then the page length shall be set to 0004h. If the DP bit
526 * is set to one, then the page length shall be set to the value
527 * defined in table 162.
528 */
529 buf[0] = dev->transport->get_device_type(dev);
530
531 /*
532 * Set Hardcoded length mentioned above for DP=0
533 */
534 put_unaligned_be16(0x0004, &buf[2]);
535
536 /*
537 * The THRESHOLD EXPONENT field indicates the threshold set size in
538 * LBAs as a power of 2 (i.e., the threshold set size is equal to
539 * 2(threshold exponent)).
540 *
541 * Note that this is currently set to 0x00 as mkp says it will be
542 * changing again. We can enable this once it has settled in T10
543 * and is actually used by Linux/SCSI ML code.
544 */
545 buf[4] = 0x00;
546
547 /*
548 * A TPU bit set to one indicates that the device server supports
549 * the UNMAP command (see 5.25). A TPU bit set to zero indicates
550 * that the device server does not support the UNMAP command.
551 */
552 if (dev->se_sub_dev->se_dev_attrib.emulate_tpu != 0)
553 buf[5] = 0x80;
554
555 /*
556 * A TPWS bit set to one indicates that the device server supports
557 * the use of the WRITE SAME (16) command (see 5.42) to unmap LBAs.
558 * A TPWS bit set to zero indicates that the device server does not
559 * support the use of the WRITE SAME (16) command to unmap LBAs.
560 */
561 if (dev->se_sub_dev->se_dev_attrib.emulate_tpws != 0)
562 buf[5] |= 0x40;
563
564 return 0;
565}
566
567static int
568target_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf);
569
570static struct {
571 uint8_t page;
572 int (*emulate)(struct se_cmd *, unsigned char *);
573} evpd_handlers[] = {
574 { .page = 0x00, .emulate = target_emulate_evpd_00 },
575 { .page = 0x80, .emulate = target_emulate_evpd_80 },
576 { .page = 0x83, .emulate = target_emulate_evpd_83 },
577 { .page = 0x86, .emulate = target_emulate_evpd_86 },
578 { .page = 0xb0, .emulate = target_emulate_evpd_b0 },
579 { .page = 0xb1, .emulate = target_emulate_evpd_b1 },
580 { .page = 0xb2, .emulate = target_emulate_evpd_b2 },
581};
582
583/* supported vital product data pages */
584static int
585target_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf)
586{
587 int p;
588
589 /*
590 * Only report the INQUIRY EVPD=1 pages after a valid NAA
591 * Registered Extended LUN WWN has been set via ConfigFS
592 * during device creation/restart.
593 */
594 if (cmd->se_dev->se_sub_dev->su_dev_flags &
595 SDF_EMULATED_VPD_UNIT_SERIAL) {
596 buf[3] = ARRAY_SIZE(evpd_handlers);
597 for (p = 0; p < ARRAY_SIZE(evpd_handlers); ++p)
598 buf[p + 4] = evpd_handlers[p].page;
599 }
600
601 return 0;
602}
603
604int target_emulate_inquiry(struct se_cmd *cmd)
605{
606 struct se_device *dev = cmd->se_dev;
607 struct se_portal_group *tpg = cmd->se_lun->lun_sep->sep_tpg;
608 unsigned char *buf, *map_buf;
609 unsigned char *cdb = cmd->t_task_cdb;
610 int p, ret;
611
612 map_buf = transport_kmap_data_sg(cmd);
613 /*
614 * If SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC is not set, then we
615 * know we actually allocated a full page. Otherwise, if the
616 * data buffer is too small, allocate a temporary buffer so we
617 * don't have to worry about overruns in all our INQUIRY
618 * emulation handling.
619 */
620 if (cmd->data_length < SE_INQUIRY_BUF &&
621 (cmd->se_cmd_flags & SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC)) {
622 buf = kzalloc(SE_INQUIRY_BUF, GFP_KERNEL);
623 if (!buf) {
624 transport_kunmap_data_sg(cmd);
625 cmd->scsi_sense_reason = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
626 return -ENOMEM;
627 }
628 } else {
629 buf = map_buf;
630 }
631
632 if (dev == tpg->tpg_virt_lun0.lun_se_dev)
633 buf[0] = 0x3f; /* Not connected */
634 else
635 buf[0] = dev->transport->get_device_type(dev);
636
637 if (!(cdb[1] & 0x1)) {
638 if (cdb[2]) {
639 pr_err("INQUIRY with EVPD==0 but PAGE CODE=%02x\n",
640 cdb[2]);
641 cmd->scsi_sense_reason = TCM_INVALID_CDB_FIELD;
642 ret = -EINVAL;
643 goto out;
644 }
645
646 ret = target_emulate_inquiry_std(cmd, buf);
647 goto out;
648 }
649
650 for (p = 0; p < ARRAY_SIZE(evpd_handlers); ++p) {
651 if (cdb[2] == evpd_handlers[p].page) {
652 buf[1] = cdb[2];
653 ret = evpd_handlers[p].emulate(cmd, buf);
654 goto out;
655 }
656 }
657
658 pr_err("Unknown VPD Code: 0x%02x\n", cdb[2]);
659 cmd->scsi_sense_reason = TCM_INVALID_CDB_FIELD;
660 ret = -EINVAL;
661
662out:
663 if (buf != map_buf) {
664 memcpy(map_buf, buf, cmd->data_length);
665 kfree(buf);
666 }
667 transport_kunmap_data_sg(cmd);
668
669 if (!ret)
670 target_complete_cmd(cmd, GOOD);
671 return ret;
672}
673
674int target_emulate_readcapacity(struct se_cmd *cmd)
675{
676 struct se_device *dev = cmd->se_dev;
677 unsigned char *buf;
678 unsigned long long blocks_long = dev->transport->get_blocks(dev);
679 u32 blocks;
680
681 if (blocks_long >= 0x00000000ffffffff)
682 blocks = 0xffffffff;
683 else
684 blocks = (u32)blocks_long;
685
686 buf = transport_kmap_data_sg(cmd);
687
688 buf[0] = (blocks >> 24) & 0xff;
689 buf[1] = (blocks >> 16) & 0xff;
690 buf[2] = (blocks >> 8) & 0xff;
691 buf[3] = blocks & 0xff;
692 buf[4] = (dev->se_sub_dev->se_dev_attrib.block_size >> 24) & 0xff;
693 buf[5] = (dev->se_sub_dev->se_dev_attrib.block_size >> 16) & 0xff;
694 buf[6] = (dev->se_sub_dev->se_dev_attrib.block_size >> 8) & 0xff;
695 buf[7] = dev->se_sub_dev->se_dev_attrib.block_size & 0xff;
696
697 transport_kunmap_data_sg(cmd);
698
699 target_complete_cmd(cmd, GOOD);
700 return 0;
701}
702
703int target_emulate_readcapacity_16(struct se_cmd *cmd)
704{
705 struct se_device *dev = cmd->se_dev;
706 unsigned char *buf;
707 unsigned long long blocks = dev->transport->get_blocks(dev);
708
709 buf = transport_kmap_data_sg(cmd);
710
711 buf[0] = (blocks >> 56) & 0xff;
712 buf[1] = (blocks >> 48) & 0xff;
713 buf[2] = (blocks >> 40) & 0xff;
714 buf[3] = (blocks >> 32) & 0xff;
715 buf[4] = (blocks >> 24) & 0xff;
716 buf[5] = (blocks >> 16) & 0xff;
717 buf[6] = (blocks >> 8) & 0xff;
718 buf[7] = blocks & 0xff;
719 buf[8] = (dev->se_sub_dev->se_dev_attrib.block_size >> 24) & 0xff;
720 buf[9] = (dev->se_sub_dev->se_dev_attrib.block_size >> 16) & 0xff;
721 buf[10] = (dev->se_sub_dev->se_dev_attrib.block_size >> 8) & 0xff;
722 buf[11] = dev->se_sub_dev->se_dev_attrib.block_size & 0xff;
723 /*
724 * Set Thin Provisioning Enable bit following sbc3r22 in section
725 * READ CAPACITY (16) byte 14 if emulate_tpu or emulate_tpws is enabled.
726 */
727 if (dev->se_sub_dev->se_dev_attrib.emulate_tpu || dev->se_sub_dev->se_dev_attrib.emulate_tpws)
728 buf[14] = 0x80;
729
730 transport_kunmap_data_sg(cmd);
731
732 target_complete_cmd(cmd, GOOD);
733 return 0;
734}
735
736static int
737target_modesense_rwrecovery(unsigned char *p)
738{
739 p[0] = 0x01;
740 p[1] = 0x0a;
741
742 return 12;
743}
744
745static int
746target_modesense_control(struct se_device *dev, unsigned char *p)
747{
748 p[0] = 0x0a;
749 p[1] = 0x0a;
750 p[2] = 2;
751 /*
752 * From spc4r23, 7.4.7 Control mode page
753 *
754 * The QUEUE ALGORITHM MODIFIER field (see table 368) specifies
755 * restrictions on the algorithm used for reordering commands
756 * having the SIMPLE task attribute (see SAM-4).
757 *
758 * Table 368 -- QUEUE ALGORITHM MODIFIER field
759 * Code Description
760 * 0h Restricted reordering
761 * 1h Unrestricted reordering allowed
762 * 2h to 7h Reserved
763 * 8h to Fh Vendor specific
764 *
765 * A value of zero in the QUEUE ALGORITHM MODIFIER field specifies that
766 * the device server shall order the processing sequence of commands
767 * having the SIMPLE task attribute such that data integrity is maintained
768 * for that I_T nexus (i.e., if the transmission of new SCSI transport protocol
769 * requests is halted at any time, the final value of all data observable
770 * on the medium shall be the same as if all the commands had been processed
771 * with the ORDERED task attribute).
772 *
773 * A value of one in the QUEUE ALGORITHM MODIFIER field specifies that the
774 * device server may reorder the processing sequence of commands having the
775 * SIMPLE task attribute in any manner. Any data integrity exposures related to
776 * command sequence order shall be explicitly handled by the application client
777 * through the selection of appropriate ommands and task attributes.
778 */
779 p[3] = (dev->se_sub_dev->se_dev_attrib.emulate_rest_reord == 1) ? 0x00 : 0x10;
780 /*
781 * From spc4r17, section 7.4.6 Control mode Page
782 *
783 * Unit Attention interlocks control (UN_INTLCK_CTRL) to code 00b
784 *
785 * 00b: The logical unit shall clear any unit attention condition
786 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
787 * status and shall not establish a unit attention condition when a com-
788 * mand is completed with BUSY, TASK SET FULL, or RESERVATION CONFLICT
789 * status.
790 *
791 * 10b: The logical unit shall not clear any unit attention condition
792 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
793 * status and shall not establish a unit attention condition when
794 * a command is completed with BUSY, TASK SET FULL, or RESERVATION
795 * CONFLICT status.
796 *
797 * 11b a The logical unit shall not clear any unit attention condition
798 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
799 * status and shall establish a unit attention condition for the
800 * initiator port associated with the I_T nexus on which the BUSY,
801 * TASK SET FULL, or RESERVATION CONFLICT status is being returned.
802 * Depending on the status, the additional sense code shall be set to
803 * PREVIOUS BUSY STATUS, PREVIOUS TASK SET FULL STATUS, or PREVIOUS
804 * RESERVATION CONFLICT STATUS. Until it is cleared by a REQUEST SENSE
805 * command, a unit attention condition shall be established only once
806 * for a BUSY, TASK SET FULL, or RESERVATION CONFLICT status regardless
807 * to the number of commands completed with one of those status codes.
808 */
809 p[4] = (dev->se_sub_dev->se_dev_attrib.emulate_ua_intlck_ctrl == 2) ? 0x30 :
810 (dev->se_sub_dev->se_dev_attrib.emulate_ua_intlck_ctrl == 1) ? 0x20 : 0x00;
811 /*
812 * From spc4r17, section 7.4.6 Control mode Page
813 *
814 * Task Aborted Status (TAS) bit set to zero.
815 *
816 * A task aborted status (TAS) bit set to zero specifies that aborted
817 * tasks shall be terminated by the device server without any response
818 * to the application client. A TAS bit set to one specifies that tasks
819 * aborted by the actions of an I_T nexus other than the I_T nexus on
820 * which the command was received shall be completed with TASK ABORTED
821 * status (see SAM-4).
822 */
823 p[5] = (dev->se_sub_dev->se_dev_attrib.emulate_tas) ? 0x40 : 0x00;
824 p[8] = 0xff;
825 p[9] = 0xff;
826 p[11] = 30;
827
828 return 12;
829}
830
831static int
832target_modesense_caching(struct se_device *dev, unsigned char *p)
833{
834 p[0] = 0x08;
835 p[1] = 0x12;
836 if (dev->se_sub_dev->se_dev_attrib.emulate_write_cache > 0)
837 p[2] = 0x04; /* Write Cache Enable */
838 p[12] = 0x20; /* Disabled Read Ahead */
839
840 return 20;
841}
842
843static void
844target_modesense_write_protect(unsigned char *buf, int type)
845{
846 /*
847 * I believe that the WP bit (bit 7) in the mode header is the same for
848 * all device types..
849 */
850 switch (type) {
851 case TYPE_DISK:
852 case TYPE_TAPE:
853 default:
854 buf[0] |= 0x80; /* WP bit */
855 break;
856 }
857}
858
859static void
860target_modesense_dpofua(unsigned char *buf, int type)
861{
862 switch (type) {
863 case TYPE_DISK:
864 buf[0] |= 0x10; /* DPOFUA bit */
865 break;
866 default:
867 break;
868 }
869}
870
871int target_emulate_modesense(struct se_cmd *cmd)
872{
873 struct se_device *dev = cmd->se_dev;
874 char *cdb = cmd->t_task_cdb;
875 unsigned char *rbuf;
876 int type = dev->transport->get_device_type(dev);
877 int ten = (cmd->t_task_cdb[0] == MODE_SENSE_10);
878 int offset = ten ? 8 : 4;
879 int length = 0;
880 unsigned char buf[SE_MODE_PAGE_BUF];
881
882 memset(buf, 0, SE_MODE_PAGE_BUF);
883
884 switch (cdb[2] & 0x3f) {
885 case 0x01:
886 length = target_modesense_rwrecovery(&buf[offset]);
887 break;
888 case 0x08:
889 length = target_modesense_caching(dev, &buf[offset]);
890 break;
891 case 0x0a:
892 length = target_modesense_control(dev, &buf[offset]);
893 break;
894 case 0x3f:
895 length = target_modesense_rwrecovery(&buf[offset]);
896 length += target_modesense_caching(dev, &buf[offset+length]);
897 length += target_modesense_control(dev, &buf[offset+length]);
898 break;
899 default:
900 pr_err("MODE SENSE: unimplemented page/subpage: 0x%02x/0x%02x\n",
901 cdb[2] & 0x3f, cdb[3]);
902 cmd->scsi_sense_reason = TCM_UNKNOWN_MODE_PAGE;
903 return -EINVAL;
904 }
905 offset += length;
906
907 if (ten) {
908 offset -= 2;
909 buf[0] = (offset >> 8) & 0xff;
910 buf[1] = offset & 0xff;
911
912 if ((cmd->se_lun->lun_access & TRANSPORT_LUNFLAGS_READ_ONLY) ||
913 (cmd->se_deve &&
914 (cmd->se_deve->lun_flags & TRANSPORT_LUNFLAGS_READ_ONLY)))
915 target_modesense_write_protect(&buf[3], type);
916
917 if ((dev->se_sub_dev->se_dev_attrib.emulate_write_cache > 0) &&
918 (dev->se_sub_dev->se_dev_attrib.emulate_fua_write > 0))
919 target_modesense_dpofua(&buf[3], type);
920
921 if ((offset + 2) > cmd->data_length)
922 offset = cmd->data_length;
923
924 } else {
925 offset -= 1;
926 buf[0] = offset & 0xff;
927
928 if ((cmd->se_lun->lun_access & TRANSPORT_LUNFLAGS_READ_ONLY) ||
929 (cmd->se_deve &&
930 (cmd->se_deve->lun_flags & TRANSPORT_LUNFLAGS_READ_ONLY)))
931 target_modesense_write_protect(&buf[2], type);
932
933 if ((dev->se_sub_dev->se_dev_attrib.emulate_write_cache > 0) &&
934 (dev->se_sub_dev->se_dev_attrib.emulate_fua_write > 0))
935 target_modesense_dpofua(&buf[2], type);
936
937 if ((offset + 1) > cmd->data_length)
938 offset = cmd->data_length;
939 }
940
941 rbuf = transport_kmap_data_sg(cmd);
942 memcpy(rbuf, buf, offset);
943 transport_kunmap_data_sg(cmd);
944
945 target_complete_cmd(cmd, GOOD);
946 return 0;
947}
948
949int target_emulate_request_sense(struct se_cmd *cmd)
950{
951 unsigned char *cdb = cmd->t_task_cdb;
952 unsigned char *buf;
953 u8 ua_asc = 0, ua_ascq = 0;
954 int err = 0;
955
956 if (cdb[1] & 0x01) {
957 pr_err("REQUEST_SENSE description emulation not"
958 " supported\n");
959 cmd->scsi_sense_reason = TCM_INVALID_CDB_FIELD;
960 return -ENOSYS;
961 }
962
963 buf = transport_kmap_data_sg(cmd);
964
965 if (!core_scsi3_ua_clear_for_request_sense(cmd, &ua_asc, &ua_ascq)) {
966 /*
967 * CURRENT ERROR, UNIT ATTENTION
968 */
969 buf[0] = 0x70;
970 buf[SPC_SENSE_KEY_OFFSET] = UNIT_ATTENTION;
971
972 if (cmd->data_length < 18) {
973 buf[7] = 0x00;
974 err = -EINVAL;
975 goto end;
976 }
977 /*
978 * The Additional Sense Code (ASC) from the UNIT ATTENTION
979 */
980 buf[SPC_ASC_KEY_OFFSET] = ua_asc;
981 buf[SPC_ASCQ_KEY_OFFSET] = ua_ascq;
982 buf[7] = 0x0A;
983 } else {
984 /*
985 * CURRENT ERROR, NO SENSE
986 */
987 buf[0] = 0x70;
988 buf[SPC_SENSE_KEY_OFFSET] = NO_SENSE;
989
990 if (cmd->data_length < 18) {
991 buf[7] = 0x00;
992 err = -EINVAL;
993 goto end;
994 }
995 /*
996 * NO ADDITIONAL SENSE INFORMATION
997 */
998 buf[SPC_ASC_KEY_OFFSET] = 0x00;
999 buf[7] = 0x0A;
1000 }
1001
1002end:
1003 transport_kunmap_data_sg(cmd);
1004 target_complete_cmd(cmd, GOOD);
1005 return 0;
1006}
1007
1008/*
1009 * Used for TCM/IBLOCK and TCM/FILEIO for block/blk-lib.c level discard support.
1010 * Note this is not used for TCM/pSCSI passthrough
1011 */
1012int target_emulate_unmap(struct se_cmd *cmd)
1013{
1014 struct se_device *dev = cmd->se_dev;
1015 unsigned char *buf, *ptr = NULL;
1016 sector_t lba;
1017 int size = cmd->data_length;
1018 u32 range;
1019 int ret = 0;
1020 int dl, bd_dl;
1021
1022 if (!dev->transport->do_discard) {
1023 pr_err("UNMAP emulation not supported for: %s\n",
1024 dev->transport->name);
1025 cmd->scsi_sense_reason = TCM_UNSUPPORTED_SCSI_OPCODE;
1026 return -ENOSYS;
1027 }
1028
1029 buf = transport_kmap_data_sg(cmd);
1030
1031 dl = get_unaligned_be16(&buf[0]);
1032 bd_dl = get_unaligned_be16(&buf[2]);
1033
1034 size = min(size - 8, bd_dl);
1035 if (size / 16 > dev->se_sub_dev->se_dev_attrib.max_unmap_block_desc_count) {
1036 cmd->scsi_sense_reason = TCM_INVALID_PARAMETER_LIST;
1037 ret = -EINVAL;
1038 goto err;
1039 }
1040
1041 /* First UNMAP block descriptor starts at 8 byte offset */
1042 ptr = &buf[8];
1043 pr_debug("UNMAP: Sub: %s Using dl: %u bd_dl: %u size: %u"
1044 " ptr: %p\n", dev->transport->name, dl, bd_dl, size, ptr);
1045
1046 while (size >= 16) {
1047 lba = get_unaligned_be64(&ptr[0]);
1048 range = get_unaligned_be32(&ptr[8]);
1049 pr_debug("UNMAP: Using lba: %llu and range: %u\n",
1050 (unsigned long long)lba, range);
1051
1052 if (range > dev->se_sub_dev->se_dev_attrib.max_unmap_lba_count) {
1053 cmd->scsi_sense_reason = TCM_INVALID_PARAMETER_LIST;
1054 ret = -EINVAL;
1055 goto err;
1056 }
1057
1058 if (lba + range > dev->transport->get_blocks(dev) + 1) {
1059 cmd->scsi_sense_reason = TCM_ADDRESS_OUT_OF_RANGE;
1060 ret = -EINVAL;
1061 goto err;
1062 }
1063
1064 ret = dev->transport->do_discard(dev, lba, range);
1065 if (ret < 0) {
1066 pr_err("blkdev_issue_discard() failed: %d\n",
1067 ret);
1068 goto err;
1069 }
1070
1071 ptr += 16;
1072 size -= 16;
1073 }
1074
1075err:
1076 transport_kunmap_data_sg(cmd);
1077 if (!ret)
1078 target_complete_cmd(cmd, GOOD);
1079 return ret;
1080}
1081
1082/*
1083 * Used for TCM/IBLOCK and TCM/FILEIO for block/blk-lib.c level discard support.
1084 * Note this is not used for TCM/pSCSI passthrough
1085 */
1086int target_emulate_write_same(struct se_cmd *cmd)
1087{
1088 struct se_device *dev = cmd->se_dev;
1089 sector_t range;
1090 sector_t lba = cmd->t_task_lba;
1091 u32 num_blocks;
1092 int ret;
1093
1094 if (!dev->transport->do_discard) {
1095 pr_err("WRITE_SAME emulation not supported"
1096 " for: %s\n", dev->transport->name);
1097 cmd->scsi_sense_reason = TCM_UNSUPPORTED_SCSI_OPCODE;
1098 return -ENOSYS;
1099 }
1100
1101 if (cmd->t_task_cdb[0] == WRITE_SAME)
1102 num_blocks = get_unaligned_be16(&cmd->t_task_cdb[7]);
1103 else if (cmd->t_task_cdb[0] == WRITE_SAME_16)
1104 num_blocks = get_unaligned_be32(&cmd->t_task_cdb[10]);
1105 else /* WRITE_SAME_32 via VARIABLE_LENGTH_CMD */
1106 num_blocks = get_unaligned_be32(&cmd->t_task_cdb[28]);
1107
1108 /*
1109 * Use the explicit range when non zero is supplied, otherwise calculate
1110 * the remaining range based on ->get_blocks() - starting LBA.
1111 */
1112 if (num_blocks != 0)
1113 range = num_blocks;
1114 else
1115 range = (dev->transport->get_blocks(dev) - lba) + 1;
1116
1117 pr_debug("WRITE_SAME UNMAP: LBA: %llu Range: %llu\n",
1118 (unsigned long long)lba, (unsigned long long)range);
1119
1120 ret = dev->transport->do_discard(dev, lba, range);
1121 if (ret < 0) {
1122 pr_debug("blkdev_issue_discard() failed for WRITE_SAME\n");
1123 return ret;
1124 }
1125
1126 target_complete_cmd(cmd, GOOD);
1127 return 0;
1128}
1129
1130int target_emulate_synchronize_cache(struct se_cmd *cmd)
1131{
1132 if (!cmd->se_dev->transport->do_sync_cache) {
1133 pr_err("SYNCHRONIZE_CACHE emulation not supported"
1134 " for: %s\n", cmd->se_dev->transport->name);
1135 cmd->scsi_sense_reason = TCM_UNSUPPORTED_SCSI_OPCODE;
1136 return -ENOSYS;
1137 }
1138
1139 cmd->se_dev->transport->do_sync_cache(cmd);
1140 return 0;
1141}
1142
1143int target_emulate_noop(struct se_cmd *cmd)
1144{
1145 target_complete_cmd(cmd, GOOD);
1146 return 0;
1147}