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