blob: 279d26062f698c733d5839f7cd863171c7a71a64 [file] [log] [blame]
Christoph Hellwig88455ec2012-05-20 11:59:13 -04001/*
2 * SCSI Primary Commands (SPC) parsing and emulation.
3 *
Nicholas Bellinger4c762512013-09-05 15:29:12 -07004 * (c) Copyright 2002-2013 Datera, Inc.
Christoph Hellwig88455ec2012-05-20 11:59:13 -04005 *
6 * Nicholas A. Bellinger <nab@kernel.org>
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
21 */
22
23#include <linux/kernel.h>
24#include <linux/module.h>
25#include <asm/unaligned.h>
26
27#include <scsi/scsi.h>
28#include <scsi/scsi_tcq.h>
29
30#include <target/target_core_base.h>
31#include <target/target_core_backend.h>
32#include <target/target_core_fabric.h>
33
34#include "target_core_internal.h"
Nicholas Bellingereba2ca42012-05-30 14:09:10 -070035#include "target_core_alua.h"
Christoph Hellwig88455ec2012-05-20 11:59:13 -040036#include "target_core_pr.h"
37#include "target_core_ua.h"
Nicholas Bellinger04b1b792013-08-22 12:29:59 -070038#include "target_core_xcopy.h"
Christoph Hellwig88455ec2012-05-20 11:59:13 -040039
Christoph Hellwig1fd032e2012-05-20 11:59:15 -040040static void spc_fill_alua_data(struct se_port *port, unsigned char *buf)
41{
42 struct t10_alua_tg_pt_gp *tg_pt_gp;
43 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
44
45 /*
46 * Set SCCS for MAINTENANCE_IN + REPORT_TARGET_PORT_GROUPS.
47 */
48 buf[5] = 0x80;
49
50 /*
Hannes Reinecke125d0112013-11-19 09:07:46 +010051 * Set TPGS field for explicit and/or implicit ALUA access type
Christoph Hellwig1fd032e2012-05-20 11:59:15 -040052 * and opteration.
53 *
54 * See spc4r17 section 6.4.2 Table 135
55 */
56 if (!port)
57 return;
58 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
59 if (!tg_pt_gp_mem)
60 return;
61
62 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
63 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
64 if (tg_pt_gp)
65 buf[5] |= tg_pt_gp->tg_pt_gp_alua_access_type;
66 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
67}
68
Hannes Reinecke0dfa1c52012-12-17 09:53:35 +010069sense_reason_t
70spc_emulate_inquiry_std(struct se_cmd *cmd, unsigned char *buf)
Christoph Hellwig1fd032e2012-05-20 11:59:15 -040071{
72 struct se_lun *lun = cmd->se_lun;
73 struct se_device *dev = cmd->se_dev;
74
75 /* Set RMB (removable media) for tape devices */
76 if (dev->transport->get_device_type(dev) == TYPE_TAPE)
77 buf[1] = 0x80;
78
Christoph Hellwig48c25672012-10-10 17:37:17 -040079 buf[2] = 0x05; /* SPC-3 */
Christoph Hellwig1fd032e2012-05-20 11:59:15 -040080
81 /*
82 * NORMACA and HISUP = 0, RESPONSE DATA FORMAT = 2
83 *
84 * SPC4 says:
85 * A RESPONSE DATA FORMAT field set to 2h indicates that the
86 * standard INQUIRY data is in the format defined in this
87 * standard. Response data format values less than 2h are
88 * obsolete. Response data format values greater than 2h are
89 * reserved.
90 */
91 buf[3] = 2;
92
93 /*
94 * Enable SCCS and TPGS fields for Emulated ALUA
95 */
Christoph Hellwigc87fbd52012-10-10 17:37:16 -040096 spc_fill_alua_data(lun->lun_sep, buf);
Christoph Hellwig1fd032e2012-05-20 11:59:15 -040097
Nicholas Bellingerd397a442013-08-22 14:17:20 -070098 /*
99 * Set Third-Party Copy (3PC) bit to indicate support for EXTENDED_COPY
100 */
101 if (dev->dev_attrib.emulate_3pc)
102 buf[5] |= 0x8;
103
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400104 buf[7] = 0x2; /* CmdQue=1 */
105
Nicholas Bellingeree60bdd2013-07-24 16:15:08 -0700106 memcpy(&buf[8], "LIO-ORG ", 8);
107 memset(&buf[16], 0x20, 16);
108 memcpy(&buf[16], dev->t10_wwn.model,
109 min_t(size_t, strlen(dev->t10_wwn.model), 16));
110 memcpy(&buf[32], dev->t10_wwn.revision,
111 min_t(size_t, strlen(dev->t10_wwn.revision), 4));
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400112 buf[4] = 31; /* Set additional length to 31 */
113
114 return 0;
115}
Hannes Reinecke0dfa1c52012-12-17 09:53:35 +0100116EXPORT_SYMBOL(spc_emulate_inquiry_std);
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400117
118/* unit serial number */
Christoph Hellwigde103c92012-11-06 12:24:09 -0800119static sense_reason_t
120spc_emulate_evpd_80(struct se_cmd *cmd, unsigned char *buf)
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400121{
122 struct se_device *dev = cmd->se_dev;
123 u16 len = 0;
124
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400125 if (dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL) {
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400126 u32 unit_serial_len;
127
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400128 unit_serial_len = strlen(dev->t10_wwn.unit_serial);
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400129 unit_serial_len++; /* For NULL Terminator */
130
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400131 len += sprintf(&buf[4], "%s", dev->t10_wwn.unit_serial);
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400132 len++; /* Extra Byte for NULL Terminator */
133 buf[3] = len;
134 }
135 return 0;
136}
137
Nicholas Bellinger68366022013-08-20 17:02:21 -0700138void spc_parse_naa_6h_vendor_specific(struct se_device *dev,
139 unsigned char *buf)
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400140{
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400141 unsigned char *p = &dev->t10_wwn.unit_serial[0];
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400142 int cnt;
143 bool next = true;
144
145 /*
146 * Generate up to 36 bits of VENDOR SPECIFIC IDENTIFIER starting on
147 * byte 3 bit 3-0 for NAA IEEE Registered Extended DESIGNATOR field
148 * format, followed by 64 bits of VENDOR SPECIFIC IDENTIFIER EXTENSION
149 * to complete the payload. These are based from VPD=0x80 PRODUCT SERIAL
150 * NUMBER set via vpd_unit_serial in target_core_configfs.c to ensure
151 * per device uniqeness.
152 */
153 for (cnt = 0; *p && cnt < 13; p++) {
154 int val = hex_to_bin(*p);
155
156 if (val < 0)
157 continue;
158
159 if (next) {
160 next = false;
161 buf[cnt++] |= val;
162 } else {
163 next = true;
164 buf[cnt] = val << 4;
165 }
166 }
167}
168
169/*
170 * Device identification VPD, for a complete list of
171 * DESIGNATOR TYPEs see spc4r17 Table 459.
172 */
Hannes Reinecke0dfa1c52012-12-17 09:53:35 +0100173sense_reason_t
Christoph Hellwigde103c92012-11-06 12:24:09 -0800174spc_emulate_evpd_83(struct se_cmd *cmd, unsigned char *buf)
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400175{
176 struct se_device *dev = cmd->se_dev;
177 struct se_lun *lun = cmd->se_lun;
178 struct se_port *port = NULL;
179 struct se_portal_group *tpg = NULL;
180 struct t10_alua_lu_gp_member *lu_gp_mem;
181 struct t10_alua_tg_pt_gp *tg_pt_gp;
182 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400183 unsigned char *prod = &dev->t10_wwn.model[0];
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400184 u32 prod_len;
185 u32 unit_serial_len, off = 0;
186 u16 len = 0, id_len;
187
188 off = 4;
189
190 /*
191 * NAA IEEE Registered Extended Assigned designator format, see
192 * spc4r17 section 7.7.3.6.5
193 *
194 * We depend upon a target_core_mod/ConfigFS provided
195 * /sys/kernel/config/target/core/$HBA/$DEV/wwn/vpd_unit_serial
196 * value in order to return the NAA id.
197 */
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400198 if (!(dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL))
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400199 goto check_t10_vend_desc;
200
201 /* CODE SET == Binary */
202 buf[off++] = 0x1;
203
204 /* Set ASSOCIATION == addressed logical unit: 0)b */
205 buf[off] = 0x00;
206
207 /* Identifier/Designator type == NAA identifier */
208 buf[off++] |= 0x3;
209 off++;
210
211 /* Identifier/Designator length */
212 buf[off++] = 0x10;
213
214 /*
215 * Start NAA IEEE Registered Extended Identifier/Designator
216 */
217 buf[off++] = (0x6 << 4);
218
219 /*
220 * Use OpenFabrics IEEE Company ID: 00 14 05
221 */
222 buf[off++] = 0x01;
223 buf[off++] = 0x40;
224 buf[off] = (0x5 << 4);
225
226 /*
227 * Return ConfigFS Unit Serial Number information for
228 * VENDOR_SPECIFIC_IDENTIFIER and
229 * VENDOR_SPECIFIC_IDENTIFIER_EXTENTION
230 */
231 spc_parse_naa_6h_vendor_specific(dev, &buf[off]);
232
233 len = 20;
234 off = (len + 4);
235
236check_t10_vend_desc:
237 /*
238 * T10 Vendor Identifier Page, see spc4r17 section 7.7.3.4
239 */
240 id_len = 8; /* For Vendor field */
241 prod_len = 4; /* For VPD Header */
242 prod_len += 8; /* For Vendor field */
243 prod_len += strlen(prod);
244 prod_len++; /* For : */
245
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400246 if (dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL) {
247 unit_serial_len = strlen(&dev->t10_wwn.unit_serial[0]);
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400248 unit_serial_len++; /* For NULL Terminator */
249
250 id_len += sprintf(&buf[off+12], "%s:%s", prod,
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400251 &dev->t10_wwn.unit_serial[0]);
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400252 }
253 buf[off] = 0x2; /* ASCII */
254 buf[off+1] = 0x1; /* T10 Vendor ID */
255 buf[off+2] = 0x0;
256 memcpy(&buf[off+4], "LIO-ORG", 8);
257 /* Extra Byte for NULL Terminator */
258 id_len++;
259 /* Identifier Length */
260 buf[off+3] = id_len;
261 /* Header size for Designation descriptor */
262 len += (id_len + 4);
263 off += (id_len + 4);
264 /*
265 * struct se_port is only set for INQUIRY VPD=1 through $FABRIC_MOD
266 */
267 port = lun->lun_sep;
268 if (port) {
269 struct t10_alua_lu_gp *lu_gp;
Hannes Reineckefbfe8582013-12-17 09:18:48 +0100270 u32 padding, scsi_name_len, scsi_target_len;
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400271 u16 lu_gp_id = 0;
272 u16 tg_pt_gp_id = 0;
273 u16 tpgt;
274
275 tpg = port->sep_tpg;
276 /*
277 * Relative target port identifer, see spc4r17
278 * section 7.7.3.7
279 *
280 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
281 * section 7.5.1 Table 362
282 */
283 buf[off] =
284 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
285 buf[off++] |= 0x1; /* CODE SET == Binary */
286 buf[off] = 0x80; /* Set PIV=1 */
287 /* Set ASSOCIATION == target port: 01b */
288 buf[off] |= 0x10;
289 /* DESIGNATOR TYPE == Relative target port identifer */
290 buf[off++] |= 0x4;
291 off++; /* Skip over Reserved */
292 buf[off++] = 4; /* DESIGNATOR LENGTH */
293 /* Skip over Obsolete field in RTPI payload
294 * in Table 472 */
295 off += 2;
296 buf[off++] = ((port->sep_rtpi >> 8) & 0xff);
297 buf[off++] = (port->sep_rtpi & 0xff);
298 len += 8; /* Header size + Designation descriptor */
299 /*
300 * Target port group identifier, see spc4r17
301 * section 7.7.3.8
302 *
303 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
304 * section 7.5.1 Table 362
305 */
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400306 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
307 if (!tg_pt_gp_mem)
308 goto check_lu_gp;
309
310 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
311 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
312 if (!tg_pt_gp) {
313 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
314 goto check_lu_gp;
315 }
316 tg_pt_gp_id = tg_pt_gp->tg_pt_gp_id;
317 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
318
319 buf[off] =
320 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
321 buf[off++] |= 0x1; /* CODE SET == Binary */
322 buf[off] = 0x80; /* Set PIV=1 */
323 /* Set ASSOCIATION == target port: 01b */
324 buf[off] |= 0x10;
325 /* DESIGNATOR TYPE == Target port group identifier */
326 buf[off++] |= 0x5;
327 off++; /* Skip over Reserved */
328 buf[off++] = 4; /* DESIGNATOR LENGTH */
329 off += 2; /* Skip over Reserved Field */
330 buf[off++] = ((tg_pt_gp_id >> 8) & 0xff);
331 buf[off++] = (tg_pt_gp_id & 0xff);
332 len += 8; /* Header size + Designation descriptor */
333 /*
334 * Logical Unit Group identifier, see spc4r17
335 * section 7.7.3.8
336 */
337check_lu_gp:
338 lu_gp_mem = dev->dev_alua_lu_gp_mem;
339 if (!lu_gp_mem)
340 goto check_scsi_name;
341
342 spin_lock(&lu_gp_mem->lu_gp_mem_lock);
343 lu_gp = lu_gp_mem->lu_gp;
344 if (!lu_gp) {
345 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
346 goto check_scsi_name;
347 }
348 lu_gp_id = lu_gp->lu_gp_id;
349 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
350
351 buf[off++] |= 0x1; /* CODE SET == Binary */
352 /* DESIGNATOR TYPE == Logical Unit Group identifier */
353 buf[off++] |= 0x6;
354 off++; /* Skip over Reserved */
355 buf[off++] = 4; /* DESIGNATOR LENGTH */
356 off += 2; /* Skip over Reserved Field */
357 buf[off++] = ((lu_gp_id >> 8) & 0xff);
358 buf[off++] = (lu_gp_id & 0xff);
359 len += 8; /* Header size + Designation descriptor */
360 /*
361 * SCSI name string designator, see spc4r17
362 * section 7.7.3.11
363 *
364 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
365 * section 7.5.1 Table 362
366 */
367check_scsi_name:
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400368 buf[off] =
369 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
370 buf[off++] |= 0x3; /* CODE SET == UTF-8 */
371 buf[off] = 0x80; /* Set PIV=1 */
372 /* Set ASSOCIATION == target port: 01b */
373 buf[off] |= 0x10;
374 /* DESIGNATOR TYPE == SCSI name string */
375 buf[off++] |= 0x8;
376 off += 2; /* Skip over Reserved and length */
377 /*
378 * SCSI name string identifer containing, $FABRIC_MOD
379 * dependent information. For LIO-Target and iSCSI
380 * Target Port, this means "<iSCSI name>,t,0x<TPGT> in
381 * UTF-8 encoding.
382 */
383 tpgt = tpg->se_tpg_tfo->tpg_get_tag(tpg);
384 scsi_name_len = sprintf(&buf[off], "%s,t,0x%04x",
385 tpg->se_tpg_tfo->tpg_get_wwn(tpg), tpgt);
386 scsi_name_len += 1 /* Include NULL terminator */;
387 /*
388 * The null-terminated, null-padded (see 4.4.2) SCSI
389 * NAME STRING field contains a UTF-8 format string.
390 * The number of bytes in the SCSI NAME STRING field
391 * (i.e., the value in the DESIGNATOR LENGTH field)
392 * shall be no larger than 256 and shall be a multiple
393 * of four.
394 */
Hannes Reinecke03ba84c2013-12-17 09:18:47 +0100395 padding = ((-scsi_name_len) & 3);
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400396 if (padding)
397 scsi_name_len += padding;
Hannes Reinecke03ba84c2013-12-17 09:18:47 +0100398 if (scsi_name_len > 256)
399 scsi_name_len = 256;
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400400
401 buf[off-1] = scsi_name_len;
402 off += scsi_name_len;
403 /* Header size + Designation descriptor */
404 len += (scsi_name_len + 4);
Hannes Reineckefbfe8582013-12-17 09:18:48 +0100405
406 /*
407 * Target device designator
408 */
409 buf[off] =
410 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
411 buf[off++] |= 0x3; /* CODE SET == UTF-8 */
412 buf[off] = 0x80; /* Set PIV=1 */
413 /* Set ASSOCIATION == target device: 10b */
414 buf[off] |= 0x20;
415 /* DESIGNATOR TYPE == SCSI name string */
416 buf[off++] |= 0x8;
417 off += 2; /* Skip over Reserved and length */
418 /*
419 * SCSI name string identifer containing, $FABRIC_MOD
420 * dependent information. For LIO-Target and iSCSI
421 * Target Port, this means "<iSCSI name>" in
422 * UTF-8 encoding.
423 */
424 scsi_target_len = sprintf(&buf[off], "%s",
425 tpg->se_tpg_tfo->tpg_get_wwn(tpg));
426 scsi_target_len += 1 /* Include NULL terminator */;
427 /*
428 * The null-terminated, null-padded (see 4.4.2) SCSI
429 * NAME STRING field contains a UTF-8 format string.
430 * The number of bytes in the SCSI NAME STRING field
431 * (i.e., the value in the DESIGNATOR LENGTH field)
432 * shall be no larger than 256 and shall be a multiple
433 * of four.
434 */
435 padding = ((-scsi_target_len) & 3);
436 if (padding)
437 scsi_target_len += padding;
438 if (scsi_name_len > 256)
439 scsi_name_len = 256;
440
441 buf[off-1] = scsi_target_len;
442 off += scsi_target_len;
443
444 /* Header size + Designation descriptor */
445 len += (scsi_target_len + 4);
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400446 }
447 buf[2] = ((len >> 8) & 0xff);
448 buf[3] = (len & 0xff); /* Page Length for VPD 0x83 */
449 return 0;
450}
Hannes Reinecke0dfa1c52012-12-17 09:53:35 +0100451EXPORT_SYMBOL(spc_emulate_evpd_83);
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400452
Nicholas Bellingerd0c8b252013-01-29 22:10:06 -0800453static bool
454spc_check_dev_wce(struct se_device *dev)
455{
456 bool wce = false;
457
458 if (dev->transport->get_write_cache)
459 wce = dev->transport->get_write_cache(dev);
460 else if (dev->dev_attrib.emulate_write_cache > 0)
461 wce = true;
462
463 return wce;
464}
465
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400466/* Extended INQUIRY Data VPD Page */
Christoph Hellwigde103c92012-11-06 12:24:09 -0800467static sense_reason_t
468spc_emulate_evpd_86(struct se_cmd *cmd, unsigned char *buf)
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400469{
Nicholas Bellingerd0c8b252013-01-29 22:10:06 -0800470 struct se_device *dev = cmd->se_dev;
471
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400472 buf[3] = 0x3c;
473 /* Set HEADSUP, ORDSUP, SIMPSUP */
474 buf[5] = 0x07;
475
476 /* If WriteCache emulation is enabled, set V_SUP */
Nicholas Bellingerd0c8b252013-01-29 22:10:06 -0800477 if (spc_check_dev_wce(dev))
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400478 buf[6] = 0x01;
Hannes Reineckec66094b2013-12-17 09:18:49 +0100479 /* If an LBA map is present set R_SUP */
480 spin_lock(&cmd->se_dev->t10_alua.lba_map_lock);
481 if (!list_empty(&dev->t10_alua.lba_map_list))
482 buf[8] = 0x10;
483 spin_unlock(&cmd->se_dev->t10_alua.lba_map_lock);
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400484 return 0;
485}
486
487/* Block Limits VPD page */
Christoph Hellwigde103c92012-11-06 12:24:09 -0800488static sense_reason_t
489spc_emulate_evpd_b0(struct se_cmd *cmd, unsigned char *buf)
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400490{
491 struct se_device *dev = cmd->se_dev;
492 u32 max_sectors;
493 int have_tp = 0;
Andy Grover7f7caf62013-11-11 08:59:17 -0800494 int opt, min;
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400495
496 /*
497 * Following spc3r22 section 6.5.3 Block Limits VPD page, when
498 * emulate_tpu=1 or emulate_tpws=1 we will be expect a
499 * different page length for Thin Provisioning.
500 */
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400501 if (dev->dev_attrib.emulate_tpu || dev->dev_attrib.emulate_tpws)
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400502 have_tp = 1;
503
504 buf[0] = dev->transport->get_device_type(dev);
505 buf[3] = have_tp ? 0x3c : 0x10;
506
507 /* Set WSNZ to 1 */
508 buf[4] = 0x01;
Nicholas Bellinger0123a9e2013-08-20 14:24:09 -0700509 /*
510 * Set MAXIMUM COMPARE AND WRITE LENGTH
511 */
512 if (dev->dev_attrib.emulate_caw)
513 buf[5] = 0x01;
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400514
515 /*
516 * Set OPTIMAL TRANSFER LENGTH GRANULARITY
517 */
Andy Grover7f7caf62013-11-11 08:59:17 -0800518 if (dev->transport->get_io_min && (min = dev->transport->get_io_min(dev)))
519 put_unaligned_be16(min / dev->dev_attrib.block_size, &buf[6]);
520 else
521 put_unaligned_be16(1, &buf[6]);
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400522
523 /*
524 * Set MAXIMUM TRANSFER LENGTH
525 */
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400526 max_sectors = min(dev->dev_attrib.fabric_max_sectors,
527 dev->dev_attrib.hw_max_sectors);
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400528 put_unaligned_be32(max_sectors, &buf[8]);
529
530 /*
531 * Set OPTIMAL TRANSFER LENGTH
532 */
Andy Grover7f7caf62013-11-11 08:59:17 -0800533 if (dev->transport->get_io_opt && (opt = dev->transport->get_io_opt(dev)))
534 put_unaligned_be32(opt / dev->dev_attrib.block_size, &buf[12]);
535 else
536 put_unaligned_be32(dev->dev_attrib.optimal_sectors, &buf[12]);
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400537
538 /*
539 * Exit now if we don't support TP.
540 */
541 if (!have_tp)
Nicholas Bellinger773cbaf2012-11-15 11:02:49 -0800542 goto max_write_same;
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400543
544 /*
545 * Set MAXIMUM UNMAP LBA COUNT
546 */
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400547 put_unaligned_be32(dev->dev_attrib.max_unmap_lba_count, &buf[20]);
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400548
549 /*
550 * Set MAXIMUM UNMAP BLOCK DESCRIPTOR COUNT
551 */
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400552 put_unaligned_be32(dev->dev_attrib.max_unmap_block_desc_count,
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400553 &buf[24]);
554
555 /*
556 * Set OPTIMAL UNMAP GRANULARITY
557 */
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400558 put_unaligned_be32(dev->dev_attrib.unmap_granularity, &buf[28]);
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400559
560 /*
561 * UNMAP GRANULARITY ALIGNMENT
562 */
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400563 put_unaligned_be32(dev->dev_attrib.unmap_granularity_alignment,
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400564 &buf[32]);
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400565 if (dev->dev_attrib.unmap_granularity_alignment != 0)
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400566 buf[32] |= 0x80; /* Set the UGAVALID bit */
567
Nicholas Bellinger773cbaf2012-11-15 11:02:49 -0800568 /*
569 * MAXIMUM WRITE SAME LENGTH
570 */
571max_write_same:
572 put_unaligned_be64(dev->dev_attrib.max_write_same_len, &buf[36]);
573
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400574 return 0;
575}
576
577/* Block Device Characteristics VPD page */
Christoph Hellwigde103c92012-11-06 12:24:09 -0800578static sense_reason_t
579spc_emulate_evpd_b1(struct se_cmd *cmd, unsigned char *buf)
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400580{
581 struct se_device *dev = cmd->se_dev;
582
583 buf[0] = dev->transport->get_device_type(dev);
584 buf[3] = 0x3c;
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400585 buf[5] = dev->dev_attrib.is_nonrot ? 1 : 0;
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400586
587 return 0;
588}
589
590/* Thin Provisioning VPD */
Christoph Hellwigde103c92012-11-06 12:24:09 -0800591static sense_reason_t
592spc_emulate_evpd_b2(struct se_cmd *cmd, unsigned char *buf)
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400593{
594 struct se_device *dev = cmd->se_dev;
595
596 /*
597 * From spc3r22 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 */
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400627 if (dev->dev_attrib.emulate_tpu != 0)
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400628 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 */
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400636 if (dev->dev_attrib.emulate_tpws != 0)
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400637 buf[5] |= 0x40;
638
639 return 0;
640}
641
Hannes Reineckec66094b2013-12-17 09:18:49 +0100642/* Referrals VPD page */
643static sense_reason_t
644spc_emulate_evpd_b3(struct se_cmd *cmd, unsigned char *buf)
645{
646 struct se_device *dev = cmd->se_dev;
647
648 buf[0] = dev->transport->get_device_type(dev);
649 buf[3] = 0x0c;
650 put_unaligned_be32(dev->t10_alua.lba_map_segment_size, &buf[8]);
651 put_unaligned_be32(dev->t10_alua.lba_map_segment_size, &buf[12]);
652
653 return 0;
654}
655
Christoph Hellwigde103c92012-11-06 12:24:09 -0800656static sense_reason_t
657spc_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf);
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400658
659static struct {
660 uint8_t page;
Christoph Hellwigde103c92012-11-06 12:24:09 -0800661 sense_reason_t (*emulate)(struct se_cmd *, unsigned char *);
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400662} evpd_handlers[] = {
663 { .page = 0x00, .emulate = spc_emulate_evpd_00 },
664 { .page = 0x80, .emulate = spc_emulate_evpd_80 },
665 { .page = 0x83, .emulate = spc_emulate_evpd_83 },
666 { .page = 0x86, .emulate = spc_emulate_evpd_86 },
667 { .page = 0xb0, .emulate = spc_emulate_evpd_b0 },
668 { .page = 0xb1, .emulate = spc_emulate_evpd_b1 },
669 { .page = 0xb2, .emulate = spc_emulate_evpd_b2 },
Hannes Reineckec66094b2013-12-17 09:18:49 +0100670 { .page = 0xb3, .emulate = spc_emulate_evpd_b3 },
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400671};
672
673/* supported vital product data pages */
Christoph Hellwigde103c92012-11-06 12:24:09 -0800674static sense_reason_t
675spc_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf)
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400676{
677 int p;
678
679 /*
680 * Only report the INQUIRY EVPD=1 pages after a valid NAA
681 * Registered Extended LUN WWN has been set via ConfigFS
682 * during device creation/restart.
683 */
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400684 if (cmd->se_dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL) {
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400685 buf[3] = ARRAY_SIZE(evpd_handlers);
686 for (p = 0; p < ARRAY_SIZE(evpd_handlers); ++p)
687 buf[p + 4] = evpd_handlers[p].page;
688 }
689
690 return 0;
691}
692
Christoph Hellwigde103c92012-11-06 12:24:09 -0800693static sense_reason_t
694spc_emulate_inquiry(struct se_cmd *cmd)
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400695{
696 struct se_device *dev = cmd->se_dev;
697 struct se_portal_group *tpg = cmd->se_lun->lun_sep->sep_tpg;
Paolo Bonziniffe7b0e2012-09-07 17:30:38 +0200698 unsigned char *rbuf;
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400699 unsigned char *cdb = cmd->t_task_cdb;
Nicholas Bellingerf82f3202013-12-19 14:13:28 -0800700 unsigned char *buf;
Christoph Hellwigde103c92012-11-06 12:24:09 -0800701 sense_reason_t ret;
702 int p;
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400703
Nicholas Bellingerf82f3202013-12-19 14:13:28 -0800704 buf = kzalloc(SE_INQUIRY_BUF, GFP_KERNEL);
705 if (!buf) {
706 pr_err("Unable to allocate response buffer for INQUIRY\n");
707 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
708 }
Nicholas Bellingerdea5f092012-10-31 22:04:26 -0700709
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400710 if (dev == tpg->tpg_virt_lun0.lun_se_dev)
711 buf[0] = 0x3f; /* Not connected */
712 else
713 buf[0] = dev->transport->get_device_type(dev);
714
715 if (!(cdb[1] & 0x1)) {
716 if (cdb[2]) {
717 pr_err("INQUIRY with EVPD==0 but PAGE CODE=%02x\n",
718 cdb[2]);
Christoph Hellwigde103c92012-11-06 12:24:09 -0800719 ret = TCM_INVALID_CDB_FIELD;
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400720 goto out;
721 }
722
723 ret = spc_emulate_inquiry_std(cmd, buf);
724 goto out;
725 }
726
727 for (p = 0; p < ARRAY_SIZE(evpd_handlers); ++p) {
728 if (cdb[2] == evpd_handlers[p].page) {
729 buf[1] = cdb[2];
730 ret = evpd_handlers[p].emulate(cmd, buf);
731 goto out;
732 }
733 }
734
735 pr_err("Unknown VPD Code: 0x%02x\n", cdb[2]);
Christoph Hellwigde103c92012-11-06 12:24:09 -0800736 ret = TCM_INVALID_CDB_FIELD;
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400737
738out:
Paolo Bonziniffe7b0e2012-09-07 17:30:38 +0200739 rbuf = transport_kmap_data_sg(cmd);
Nicholas Bellinger49df9fc2013-01-29 13:33:05 -0800740 if (rbuf) {
Nicholas Bellingerf82f3202013-12-19 14:13:28 -0800741 memcpy(rbuf, buf, min_t(u32, SE_INQUIRY_BUF, cmd->data_length));
Nicholas Bellinger49df9fc2013-01-29 13:33:05 -0800742 transport_kunmap_data_sg(cmd);
743 }
Nicholas Bellingerf82f3202013-12-19 14:13:28 -0800744 kfree(buf);
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400745
746 if (!ret)
747 target_complete_cmd(cmd, GOOD);
748 return ret;
749}
750
Roland Dreierd4b2b862012-10-31 09:16:48 -0700751static int spc_modesense_rwrecovery(struct se_device *dev, u8 pc, u8 *p)
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400752{
753 p[0] = 0x01;
754 p[1] = 0x0a;
755
Roland Dreierd4b2b862012-10-31 09:16:48 -0700756 /* No changeable values for now */
757 if (pc == 1)
758 goto out;
759
760out:
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400761 return 12;
762}
763
Roland Dreierd4b2b862012-10-31 09:16:48 -0700764static int spc_modesense_control(struct se_device *dev, u8 pc, u8 *p)
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400765{
766 p[0] = 0x0a;
767 p[1] = 0x0a;
Roland Dreierd4b2b862012-10-31 09:16:48 -0700768
769 /* No changeable values for now */
770 if (pc == 1)
771 goto out;
772
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400773 p[2] = 2;
774 /*
775 * From spc4r23, 7.4.7 Control mode page
776 *
777 * The QUEUE ALGORITHM MODIFIER field (see table 368) specifies
778 * restrictions on the algorithm used for reordering commands
779 * having the SIMPLE task attribute (see SAM-4).
780 *
781 * Table 368 -- QUEUE ALGORITHM MODIFIER field
782 * Code Description
783 * 0h Restricted reordering
784 * 1h Unrestricted reordering allowed
785 * 2h to 7h Reserved
786 * 8h to Fh Vendor specific
787 *
788 * A value of zero in the QUEUE ALGORITHM MODIFIER field specifies that
789 * the device server shall order the processing sequence of commands
790 * having the SIMPLE task attribute such that data integrity is maintained
791 * for that I_T nexus (i.e., if the transmission of new SCSI transport protocol
792 * requests is halted at any time, the final value of all data observable
793 * on the medium shall be the same as if all the commands had been processed
794 * with the ORDERED task attribute).
795 *
796 * A value of one in the QUEUE ALGORITHM MODIFIER field specifies that the
797 * device server may reorder the processing sequence of commands having the
798 * SIMPLE task attribute in any manner. Any data integrity exposures related to
799 * command sequence order shall be explicitly handled by the application client
800 * through the selection of appropriate ommands and task attributes.
801 */
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400802 p[3] = (dev->dev_attrib.emulate_rest_reord == 1) ? 0x00 : 0x10;
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400803 /*
804 * From spc4r17, section 7.4.6 Control mode Page
805 *
806 * Unit Attention interlocks control (UN_INTLCK_CTRL) to code 00b
807 *
808 * 00b: The logical unit shall clear any unit attention condition
809 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
810 * status and shall not establish a unit attention condition when a com-
811 * mand is completed with BUSY, TASK SET FULL, or RESERVATION CONFLICT
812 * status.
813 *
814 * 10b: The logical unit shall not clear any unit attention condition
815 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
816 * status and shall not establish a unit attention condition when
817 * a command is completed with BUSY, TASK SET FULL, or RESERVATION
818 * CONFLICT status.
819 *
820 * 11b a The logical unit shall not clear any unit attention condition
821 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
822 * status and shall establish a unit attention condition for the
823 * initiator port associated with the I_T nexus on which the BUSY,
824 * TASK SET FULL, or RESERVATION CONFLICT status is being returned.
825 * Depending on the status, the additional sense code shall be set to
826 * PREVIOUS BUSY STATUS, PREVIOUS TASK SET FULL STATUS, or PREVIOUS
827 * RESERVATION CONFLICT STATUS. Until it is cleared by a REQUEST SENSE
828 * command, a unit attention condition shall be established only once
829 * for a BUSY, TASK SET FULL, or RESERVATION CONFLICT status regardless
830 * to the number of commands completed with one of those status codes.
831 */
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400832 p[4] = (dev->dev_attrib.emulate_ua_intlck_ctrl == 2) ? 0x30 :
833 (dev->dev_attrib.emulate_ua_intlck_ctrl == 1) ? 0x20 : 0x00;
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400834 /*
835 * From spc4r17, section 7.4.6 Control mode Page
836 *
837 * Task Aborted Status (TAS) bit set to zero.
838 *
839 * A task aborted status (TAS) bit set to zero specifies that aborted
840 * tasks shall be terminated by the device server without any response
841 * to the application client. A TAS bit set to one specifies that tasks
842 * aborted by the actions of an I_T nexus other than the I_T nexus on
843 * which the command was received shall be completed with TASK ABORTED
844 * status (see SAM-4).
845 */
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400846 p[5] = (dev->dev_attrib.emulate_tas) ? 0x40 : 0x00;
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400847 p[8] = 0xff;
848 p[9] = 0xff;
849 p[11] = 30;
850
Roland Dreierd4b2b862012-10-31 09:16:48 -0700851out:
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400852 return 12;
853}
854
Roland Dreierd4b2b862012-10-31 09:16:48 -0700855static int spc_modesense_caching(struct se_device *dev, u8 pc, u8 *p)
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400856{
857 p[0] = 0x08;
858 p[1] = 0x12;
Roland Dreierd4b2b862012-10-31 09:16:48 -0700859
860 /* No changeable values for now */
861 if (pc == 1)
862 goto out;
863
Nicholas Bellingerd0c8b252013-01-29 22:10:06 -0800864 if (spc_check_dev_wce(dev))
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400865 p[2] = 0x04; /* Write Cache Enable */
866 p[12] = 0x20; /* Disabled Read Ahead */
867
Roland Dreierd4b2b862012-10-31 09:16:48 -0700868out:
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400869 return 20;
870}
871
Roland Dreier0f6d64c2012-10-31 09:16:49 -0700872static int spc_modesense_informational_exceptions(struct se_device *dev, u8 pc, unsigned char *p)
873{
874 p[0] = 0x1c;
875 p[1] = 0x0a;
876
877 /* No changeable values for now */
878 if (pc == 1)
879 goto out;
880
881out:
882 return 12;
883}
884
Roland Dreierd4b2b862012-10-31 09:16:48 -0700885static struct {
886 uint8_t page;
887 uint8_t subpage;
888 int (*emulate)(struct se_device *, u8, unsigned char *);
889} modesense_handlers[] = {
890 { .page = 0x01, .subpage = 0x00, .emulate = spc_modesense_rwrecovery },
891 { .page = 0x08, .subpage = 0x00, .emulate = spc_modesense_caching },
892 { .page = 0x0a, .subpage = 0x00, .emulate = spc_modesense_control },
Roland Dreier0f6d64c2012-10-31 09:16:49 -0700893 { .page = 0x1c, .subpage = 0x00, .emulate = spc_modesense_informational_exceptions },
Roland Dreierd4b2b862012-10-31 09:16:48 -0700894};
895
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400896static void spc_modesense_write_protect(unsigned char *buf, int type)
897{
898 /*
899 * I believe that the WP bit (bit 7) in the mode header is the same for
900 * all device types..
901 */
902 switch (type) {
903 case TYPE_DISK:
904 case TYPE_TAPE:
905 default:
906 buf[0] |= 0x80; /* WP bit */
907 break;
908 }
909}
910
911static void spc_modesense_dpofua(unsigned char *buf, int type)
912{
913 switch (type) {
914 case TYPE_DISK:
915 buf[0] |= 0x10; /* DPOFUA bit */
916 break;
917 default:
918 break;
919 }
920}
921
Roland Dreierd4b2b862012-10-31 09:16:48 -0700922static int spc_modesense_blockdesc(unsigned char *buf, u64 blocks, u32 block_size)
923{
924 *buf++ = 8;
925 put_unaligned_be32(min(blocks, 0xffffffffull), buf);
926 buf += 4;
927 put_unaligned_be32(block_size, buf);
928 return 9;
929}
930
931static int spc_modesense_long_blockdesc(unsigned char *buf, u64 blocks, u32 block_size)
932{
933 if (blocks <= 0xffffffff)
934 return spc_modesense_blockdesc(buf + 3, blocks, block_size) + 3;
935
936 *buf++ = 1; /* LONGLBA */
937 buf += 2;
938 *buf++ = 16;
939 put_unaligned_be64(blocks, buf);
940 buf += 12;
941 put_unaligned_be32(block_size, buf);
942
943 return 17;
944}
945
Christoph Hellwigde103c92012-11-06 12:24:09 -0800946static sense_reason_t spc_emulate_modesense(struct se_cmd *cmd)
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400947{
948 struct se_device *dev = cmd->se_dev;
949 char *cdb = cmd->t_task_cdb;
Nicholas Bellingercab96092013-01-29 14:10:01 -0800950 unsigned char buf[SE_MODE_PAGE_BUF], *rbuf;
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400951 int type = dev->transport->get_device_type(dev);
952 int ten = (cmd->t_task_cdb[0] == MODE_SENSE_10);
Roland Dreierd4b2b862012-10-31 09:16:48 -0700953 bool dbd = !!(cdb[1] & 0x08);
954 bool llba = ten ? !!(cdb[1] & 0x10) : false;
955 u8 pc = cdb[2] >> 6;
956 u8 page = cdb[2] & 0x3f;
957 u8 subpage = cdb[3];
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400958 int length = 0;
Roland Dreierd4b2b862012-10-31 09:16:48 -0700959 int ret;
960 int i;
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400961
Nicholas Bellingercab96092013-01-29 14:10:01 -0800962 memset(buf, 0, SE_MODE_PAGE_BUF);
963
Nicholas Bellingerfecae402012-11-01 18:43:03 -0700964 /*
965 * Skip over MODE DATA LENGTH + MEDIUM TYPE fields to byte 3 for
966 * MODE_SENSE_10 and byte 2 for MODE_SENSE (6).
967 */
968 length = ten ? 3 : 2;
Roland Dreierd4b2b862012-10-31 09:16:48 -0700969
970 /* DEVICE-SPECIFIC PARAMETER */
971 if ((cmd->se_lun->lun_access & TRANSPORT_LUNFLAGS_READ_ONLY) ||
972 (cmd->se_deve &&
973 (cmd->se_deve->lun_flags & TRANSPORT_LUNFLAGS_READ_ONLY)))
974 spc_modesense_write_protect(&buf[length], type);
975
Nicholas Bellingerd0c8b252013-01-29 22:10:06 -0800976 if ((spc_check_dev_wce(dev)) &&
Roland Dreierd4b2b862012-10-31 09:16:48 -0700977 (dev->dev_attrib.emulate_fua_write > 0))
978 spc_modesense_dpofua(&buf[length], type);
979
980 ++length;
981
982 /* BLOCK DESCRIPTOR */
983
984 /*
985 * For now we only include a block descriptor for disk (SBC)
986 * devices; other command sets use a slightly different format.
987 */
988 if (!dbd && type == TYPE_DISK) {
989 u64 blocks = dev->transport->get_blocks(dev);
990 u32 block_size = dev->dev_attrib.block_size;
991
992 if (ten) {
993 if (llba) {
994 length += spc_modesense_long_blockdesc(&buf[length],
995 blocks, block_size);
996 } else {
997 length += 3;
998 length += spc_modesense_blockdesc(&buf[length],
999 blocks, block_size);
1000 }
1001 } else {
1002 length += spc_modesense_blockdesc(&buf[length], blocks,
1003 block_size);
1004 }
1005 } else {
1006 if (ten)
1007 length += 4;
1008 else
1009 length += 1;
Paolo Bonzini7a3f3692012-09-07 17:30:39 +02001010 }
Christoph Hellwig1fd032e2012-05-20 11:59:15 -04001011
Roland Dreierd4b2b862012-10-31 09:16:48 -07001012 if (page == 0x3f) {
1013 if (subpage != 0x00 && subpage != 0xff) {
Christoph Hellwigde103c92012-11-06 12:24:09 -08001014 pr_warn("MODE_SENSE: Invalid subpage code: 0x%02x\n", subpage);
Christoph Hellwigde103c92012-11-06 12:24:09 -08001015 return TCM_INVALID_CDB_FIELD;
Roland Dreierd4b2b862012-10-31 09:16:48 -07001016 }
1017
1018 for (i = 0; i < ARRAY_SIZE(modesense_handlers); ++i) {
1019 /*
1020 * Tricky way to say all subpage 00h for
1021 * subpage==0, all subpages for subpage==0xff
1022 * (and we just checked above that those are
1023 * the only two possibilities).
1024 */
1025 if ((modesense_handlers[i].subpage & ~subpage) == 0) {
1026 ret = modesense_handlers[i].emulate(dev, pc, &buf[length]);
1027 if (!ten && length + ret >= 255)
1028 break;
1029 length += ret;
1030 }
1031 }
1032
1033 goto set_length;
1034 }
1035
1036 for (i = 0; i < ARRAY_SIZE(modesense_handlers); ++i)
1037 if (modesense_handlers[i].page == page &&
1038 modesense_handlers[i].subpage == subpage) {
1039 length += modesense_handlers[i].emulate(dev, pc, &buf[length]);
1040 goto set_length;
1041 }
1042
1043 /*
1044 * We don't intend to implement:
1045 * - obsolete page 03h "format parameters" (checked by Solaris)
1046 */
1047 if (page != 0x03)
1048 pr_err("MODE SENSE: unimplemented page/subpage: 0x%02x/0x%02x\n",
1049 page, subpage);
1050
Christoph Hellwigde103c92012-11-06 12:24:09 -08001051 return TCM_UNKNOWN_MODE_PAGE;
Roland Dreierd4b2b862012-10-31 09:16:48 -07001052
1053set_length:
1054 if (ten)
1055 put_unaligned_be16(length - 2, buf);
1056 else
1057 buf[0] = length - 1;
1058
Nicholas Bellingercab96092013-01-29 14:10:01 -08001059 rbuf = transport_kmap_data_sg(cmd);
1060 if (rbuf) {
1061 memcpy(rbuf, buf, min_t(u32, SE_MODE_PAGE_BUF, cmd->data_length));
1062 transport_kunmap_data_sg(cmd);
Roland Dreierd4b2b862012-10-31 09:16:48 -07001063 }
1064
Christoph Hellwig1fd032e2012-05-20 11:59:15 -04001065 target_complete_cmd(cmd, GOOD);
1066 return 0;
1067}
1068
Christoph Hellwigde103c92012-11-06 12:24:09 -08001069static sense_reason_t spc_emulate_modeselect(struct se_cmd *cmd)
Roland Dreier3a3c5e42012-10-31 09:16:50 -07001070{
1071 struct se_device *dev = cmd->se_dev;
1072 char *cdb = cmd->t_task_cdb;
1073 bool ten = cdb[0] == MODE_SELECT_10;
1074 int off = ten ? 8 : 4;
1075 bool pf = !!(cdb[1] & 0x10);
1076 u8 page, subpage;
1077 unsigned char *buf;
1078 unsigned char tbuf[SE_MODE_PAGE_BUF];
1079 int length;
1080 int ret = 0;
1081 int i;
1082
Roland Dreier71f41fe2013-02-08 15:18:40 -08001083 if (!cmd->data_length) {
1084 target_complete_cmd(cmd, GOOD);
1085 return 0;
1086 }
1087
1088 if (cmd->data_length < off + 2)
1089 return TCM_PARAMETER_LIST_LENGTH_ERROR;
1090
Roland Dreier3a3c5e42012-10-31 09:16:50 -07001091 buf = transport_kmap_data_sg(cmd);
Christoph Hellwigde103c92012-11-06 12:24:09 -08001092 if (!buf)
1093 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
Roland Dreier3a3c5e42012-10-31 09:16:50 -07001094
1095 if (!pf) {
Christoph Hellwigde103c92012-11-06 12:24:09 -08001096 ret = TCM_INVALID_CDB_FIELD;
Roland Dreier3a3c5e42012-10-31 09:16:50 -07001097 goto out;
1098 }
1099
1100 page = buf[off] & 0x3f;
1101 subpage = buf[off] & 0x40 ? buf[off + 1] : 0;
1102
1103 for (i = 0; i < ARRAY_SIZE(modesense_handlers); ++i)
1104 if (modesense_handlers[i].page == page &&
1105 modesense_handlers[i].subpage == subpage) {
1106 memset(tbuf, 0, SE_MODE_PAGE_BUF);
1107 length = modesense_handlers[i].emulate(dev, 0, tbuf);
1108 goto check_contents;
1109 }
1110
Christoph Hellwigde103c92012-11-06 12:24:09 -08001111 ret = TCM_UNKNOWN_MODE_PAGE;
Roland Dreier3a3c5e42012-10-31 09:16:50 -07001112 goto out;
1113
1114check_contents:
Roland Dreier71f41fe2013-02-08 15:18:40 -08001115 if (cmd->data_length < off + length) {
1116 ret = TCM_PARAMETER_LIST_LENGTH_ERROR;
1117 goto out;
1118 }
1119
Christoph Hellwigde103c92012-11-06 12:24:09 -08001120 if (memcmp(buf + off, tbuf, length))
1121 ret = TCM_INVALID_PARAMETER_LIST;
Roland Dreier3a3c5e42012-10-31 09:16:50 -07001122
1123out:
1124 transport_kunmap_data_sg(cmd);
1125
1126 if (!ret)
1127 target_complete_cmd(cmd, GOOD);
1128 return ret;
1129}
1130
Christoph Hellwigde103c92012-11-06 12:24:09 -08001131static sense_reason_t spc_emulate_request_sense(struct se_cmd *cmd)
Christoph Hellwig1fd032e2012-05-20 11:59:15 -04001132{
1133 unsigned char *cdb = cmd->t_task_cdb;
Paolo Bonzini32a88112012-09-07 17:30:36 +02001134 unsigned char *rbuf;
Christoph Hellwig1fd032e2012-05-20 11:59:15 -04001135 u8 ua_asc = 0, ua_ascq = 0;
Paolo Bonzini32a88112012-09-07 17:30:36 +02001136 unsigned char buf[SE_SENSE_BUF];
1137
1138 memset(buf, 0, SE_SENSE_BUF);
Christoph Hellwig1fd032e2012-05-20 11:59:15 -04001139
1140 if (cdb[1] & 0x01) {
1141 pr_err("REQUEST_SENSE description emulation not"
1142 " supported\n");
Christoph Hellwigde103c92012-11-06 12:24:09 -08001143 return TCM_INVALID_CDB_FIELD;
Christoph Hellwig1fd032e2012-05-20 11:59:15 -04001144 }
1145
Paolo Bonzini32a88112012-09-07 17:30:36 +02001146 rbuf = transport_kmap_data_sg(cmd);
Christoph Hellwigde103c92012-11-06 12:24:09 -08001147 if (!rbuf)
1148 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1149
1150 if (!core_scsi3_ua_clear_for_request_sense(cmd, &ua_asc, &ua_ascq)) {
Christoph Hellwig1fd032e2012-05-20 11:59:15 -04001151 /*
1152 * CURRENT ERROR, UNIT ATTENTION
1153 */
1154 buf[0] = 0x70;
1155 buf[SPC_SENSE_KEY_OFFSET] = UNIT_ATTENTION;
1156
Christoph Hellwig1fd032e2012-05-20 11:59:15 -04001157 /*
1158 * The Additional Sense Code (ASC) from the UNIT ATTENTION
1159 */
1160 buf[SPC_ASC_KEY_OFFSET] = ua_asc;
1161 buf[SPC_ASCQ_KEY_OFFSET] = ua_ascq;
1162 buf[7] = 0x0A;
1163 } else {
1164 /*
1165 * CURRENT ERROR, NO SENSE
1166 */
1167 buf[0] = 0x70;
1168 buf[SPC_SENSE_KEY_OFFSET] = NO_SENSE;
1169
Christoph Hellwig1fd032e2012-05-20 11:59:15 -04001170 /*
1171 * NO ADDITIONAL SENSE INFORMATION
1172 */
1173 buf[SPC_ASC_KEY_OFFSET] = 0x00;
1174 buf[7] = 0x0A;
1175 }
1176
Christoph Hellwigde103c92012-11-06 12:24:09 -08001177 memcpy(rbuf, buf, min_t(u32, sizeof(buf), cmd->data_length));
1178 transport_kunmap_data_sg(cmd);
Paolo Bonzini32a88112012-09-07 17:30:36 +02001179
Christoph Hellwig1fd032e2012-05-20 11:59:15 -04001180 target_complete_cmd(cmd, GOOD);
1181 return 0;
1182}
1183
Christoph Hellwigde103c92012-11-06 12:24:09 -08001184sense_reason_t spc_emulate_report_luns(struct se_cmd *cmd)
Christoph Hellwigd1b1f802012-10-07 10:55:51 -04001185{
1186 struct se_dev_entry *deve;
1187 struct se_session *sess = cmd->se_sess;
1188 unsigned char *buf;
1189 u32 lun_count = 0, offset = 8, i;
1190
1191 if (cmd->data_length < 16) {
1192 pr_warn("REPORT LUNS allocation length %u too small\n",
1193 cmd->data_length);
Christoph Hellwigde103c92012-11-06 12:24:09 -08001194 return TCM_INVALID_CDB_FIELD;
Christoph Hellwigd1b1f802012-10-07 10:55:51 -04001195 }
1196
1197 buf = transport_kmap_data_sg(cmd);
1198 if (!buf)
Christoph Hellwigde103c92012-11-06 12:24:09 -08001199 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
Christoph Hellwigd1b1f802012-10-07 10:55:51 -04001200
1201 /*
1202 * If no struct se_session pointer is present, this struct se_cmd is
1203 * coming via a target_core_mod PASSTHROUGH op, and not through
1204 * a $FABRIC_MOD. In that case, report LUN=0 only.
1205 */
1206 if (!sess) {
1207 int_to_scsilun(0, (struct scsi_lun *)&buf[offset]);
1208 lun_count = 1;
1209 goto done;
1210 }
1211
1212 spin_lock_irq(&sess->se_node_acl->device_list_lock);
1213 for (i = 0; i < TRANSPORT_MAX_LUNS_PER_TPG; i++) {
1214 deve = sess->se_node_acl->device_list[i];
1215 if (!(deve->lun_flags & TRANSPORT_LUNFLAGS_INITIATOR_ACCESS))
1216 continue;
1217 /*
1218 * We determine the correct LUN LIST LENGTH even once we
1219 * have reached the initial allocation length.
1220 * See SPC2-R20 7.19.
1221 */
1222 lun_count++;
1223 if ((offset + 8) > cmd->data_length)
1224 continue;
1225
1226 int_to_scsilun(deve->mapped_lun, (struct scsi_lun *)&buf[offset]);
1227 offset += 8;
1228 }
1229 spin_unlock_irq(&sess->se_node_acl->device_list_lock);
1230
1231 /*
1232 * See SPC3 r07, page 159.
1233 */
1234done:
1235 lun_count *= 8;
1236 buf[0] = ((lun_count >> 24) & 0xff);
1237 buf[1] = ((lun_count >> 16) & 0xff);
1238 buf[2] = ((lun_count >> 8) & 0xff);
1239 buf[3] = (lun_count & 0xff);
1240 transport_kunmap_data_sg(cmd);
1241
1242 target_complete_cmd(cmd, GOOD);
1243 return 0;
1244}
Christoph Hellwig8de530a2012-10-07 10:55:52 -04001245EXPORT_SYMBOL(spc_emulate_report_luns);
Christoph Hellwigd1b1f802012-10-07 10:55:51 -04001246
Christoph Hellwigde103c92012-11-06 12:24:09 -08001247static sense_reason_t
1248spc_emulate_testunitready(struct se_cmd *cmd)
Christoph Hellwig1fd032e2012-05-20 11:59:15 -04001249{
1250 target_complete_cmd(cmd, GOOD);
1251 return 0;
1252}
1253
Christoph Hellwigde103c92012-11-06 12:24:09 -08001254sense_reason_t
1255spc_parse_cdb(struct se_cmd *cmd, unsigned int *size)
Christoph Hellwig88455ec2012-05-20 11:59:13 -04001256{
Nicholas Bellingereba2ca42012-05-30 14:09:10 -07001257 struct se_device *dev = cmd->se_dev;
Christoph Hellwig88455ec2012-05-20 11:59:13 -04001258 unsigned char *cdb = cmd->t_task_cdb;
1259
1260 switch (cdb[0]) {
1261 case MODE_SELECT:
1262 *size = cdb[4];
Roland Dreier3a3c5e42012-10-31 09:16:50 -07001263 cmd->execute_cmd = spc_emulate_modeselect;
Christoph Hellwig88455ec2012-05-20 11:59:13 -04001264 break;
1265 case MODE_SELECT_10:
1266 *size = (cdb[7] << 8) + cdb[8];
Roland Dreier3a3c5e42012-10-31 09:16:50 -07001267 cmd->execute_cmd = spc_emulate_modeselect;
Christoph Hellwig88455ec2012-05-20 11:59:13 -04001268 break;
1269 case MODE_SENSE:
1270 *size = cdb[4];
Christoph Hellwig1fd032e2012-05-20 11:59:15 -04001271 cmd->execute_cmd = spc_emulate_modesense;
Christoph Hellwig88455ec2012-05-20 11:59:13 -04001272 break;
1273 case MODE_SENSE_10:
1274 *size = (cdb[7] << 8) + cdb[8];
Christoph Hellwig1fd032e2012-05-20 11:59:15 -04001275 cmd->execute_cmd = spc_emulate_modesense;
Christoph Hellwig88455ec2012-05-20 11:59:13 -04001276 break;
1277 case LOG_SELECT:
1278 case LOG_SENSE:
1279 *size = (cdb[7] << 8) + cdb[8];
1280 break;
1281 case PERSISTENT_RESERVE_IN:
Christoph Hellwig88455ec2012-05-20 11:59:13 -04001282 *size = (cdb[7] << 8) + cdb[8];
Christoph Hellwigd977f432012-10-10 17:37:15 -04001283 cmd->execute_cmd = target_scsi3_emulate_pr_in;
Christoph Hellwig88455ec2012-05-20 11:59:13 -04001284 break;
1285 case PERSISTENT_RESERVE_OUT:
Christoph Hellwig88455ec2012-05-20 11:59:13 -04001286 *size = (cdb[7] << 8) + cdb[8];
Christoph Hellwigd977f432012-10-10 17:37:15 -04001287 cmd->execute_cmd = target_scsi3_emulate_pr_out;
Christoph Hellwig88455ec2012-05-20 11:59:13 -04001288 break;
1289 case RELEASE:
1290 case RELEASE_10:
1291 if (cdb[0] == RELEASE_10)
1292 *size = (cdb[7] << 8) | cdb[8];
1293 else
1294 *size = cmd->data_length;
1295
Christoph Hellwigd977f432012-10-10 17:37:15 -04001296 cmd->execute_cmd = target_scsi2_reservation_release;
Christoph Hellwig88455ec2012-05-20 11:59:13 -04001297 break;
1298 case RESERVE:
1299 case RESERVE_10:
1300 /*
1301 * The SPC-2 RESERVE does not contain a size in the SCSI CDB.
1302 * Assume the passthrough or $FABRIC_MOD will tell us about it.
1303 */
1304 if (cdb[0] == RESERVE_10)
1305 *size = (cdb[7] << 8) | cdb[8];
1306 else
1307 *size = cmd->data_length;
1308
Christoph Hellwigd977f432012-10-10 17:37:15 -04001309 cmd->execute_cmd = target_scsi2_reservation_reserve;
Christoph Hellwig88455ec2012-05-20 11:59:13 -04001310 break;
1311 case REQUEST_SENSE:
1312 *size = cdb[4];
Christoph Hellwig1fd032e2012-05-20 11:59:15 -04001313 cmd->execute_cmd = spc_emulate_request_sense;
Christoph Hellwig88455ec2012-05-20 11:59:13 -04001314 break;
1315 case INQUIRY:
1316 *size = (cdb[3] << 8) + cdb[4];
1317
1318 /*
Hannes Reinecke125d0112013-11-19 09:07:46 +01001319 * Do implicit HEAD_OF_QUEUE processing for INQUIRY.
Christoph Hellwig88455ec2012-05-20 11:59:13 -04001320 * See spc4r17 section 5.3
1321 */
Christoph Hellwig019c4ca2012-10-10 17:37:14 -04001322 cmd->sam_task_attr = MSG_HEAD_TAG;
Christoph Hellwig1fd032e2012-05-20 11:59:15 -04001323 cmd->execute_cmd = spc_emulate_inquiry;
Christoph Hellwig88455ec2012-05-20 11:59:13 -04001324 break;
1325 case SECURITY_PROTOCOL_IN:
1326 case SECURITY_PROTOCOL_OUT:
1327 *size = (cdb[6] << 24) | (cdb[7] << 16) | (cdb[8] << 8) | cdb[9];
1328 break;
1329 case EXTENDED_COPY:
Nicholas Bellinger04b1b792013-08-22 12:29:59 -07001330 *size = get_unaligned_be32(&cdb[10]);
1331 cmd->execute_cmd = target_do_xcopy;
1332 break;
Christoph Hellwig88455ec2012-05-20 11:59:13 -04001333 case RECEIVE_COPY_RESULTS:
Nicholas Bellinger04b1b792013-08-22 12:29:59 -07001334 *size = get_unaligned_be32(&cdb[10]);
1335 cmd->execute_cmd = target_do_receive_copy_results;
1336 break;
1337 case READ_ATTRIBUTE:
Christoph Hellwig88455ec2012-05-20 11:59:13 -04001338 case WRITE_ATTRIBUTE:
1339 *size = (cdb[10] << 24) | (cdb[11] << 16) |
1340 (cdb[12] << 8) | cdb[13];
1341 break;
1342 case RECEIVE_DIAGNOSTIC:
1343 case SEND_DIAGNOSTIC:
1344 *size = (cdb[3] << 8) | cdb[4];
1345 break;
1346 case WRITE_BUFFER:
1347 *size = (cdb[6] << 16) + (cdb[7] << 8) + cdb[8];
1348 break;
1349 case REPORT_LUNS:
Christoph Hellwigd1b1f802012-10-07 10:55:51 -04001350 cmd->execute_cmd = spc_emulate_report_luns;
Christoph Hellwig88455ec2012-05-20 11:59:13 -04001351 *size = (cdb[6] << 24) | (cdb[7] << 16) | (cdb[8] << 8) | cdb[9];
1352 /*
Hannes Reinecke125d0112013-11-19 09:07:46 +01001353 * Do implicit HEAD_OF_QUEUE processing for REPORT_LUNS
Christoph Hellwig88455ec2012-05-20 11:59:13 -04001354 * See spc4r17 section 5.3
1355 */
Christoph Hellwig019c4ca2012-10-10 17:37:14 -04001356 cmd->sam_task_attr = MSG_HEAD_TAG;
Christoph Hellwig88455ec2012-05-20 11:59:13 -04001357 break;
1358 case TEST_UNIT_READY:
Christoph Hellwig1fd032e2012-05-20 11:59:15 -04001359 cmd->execute_cmd = spc_emulate_testunitready;
Christoph Hellwigd6e01752012-05-20 11:59:14 -04001360 *size = 0;
Christoph Hellwig88455ec2012-05-20 11:59:13 -04001361 break;
Nicholas Bellingereba2ca42012-05-30 14:09:10 -07001362 case MAINTENANCE_IN:
1363 if (dev->transport->get_device_type(dev) != TYPE_ROM) {
1364 /*
1365 * MAINTENANCE_IN from SCC-2
1366 * Check for emulated MI_REPORT_TARGET_PGS
1367 */
Christoph Hellwigc87fbd52012-10-10 17:37:16 -04001368 if ((cdb[1] & 0x1f) == MI_REPORT_TARGET_PGS) {
Nicholas Bellingereba2ca42012-05-30 14:09:10 -07001369 cmd->execute_cmd =
1370 target_emulate_report_target_port_groups;
1371 }
1372 *size = get_unaligned_be32(&cdb[6]);
1373 } else {
1374 /*
1375 * GPCMD_SEND_KEY from multi media commands
1376 */
1377 *size = get_unaligned_be16(&cdb[8]);
1378 }
1379 break;
1380 case MAINTENANCE_OUT:
1381 if (dev->transport->get_device_type(dev) != TYPE_ROM) {
1382 /*
1383 * MAINTENANCE_OUT from SCC-2
1384 * Check for emulated MO_SET_TARGET_PGS.
1385 */
Christoph Hellwigc87fbd52012-10-10 17:37:16 -04001386 if (cdb[1] == MO_SET_TARGET_PGS) {
Nicholas Bellingereba2ca42012-05-30 14:09:10 -07001387 cmd->execute_cmd =
1388 target_emulate_set_target_port_groups;
1389 }
1390 *size = get_unaligned_be32(&cdb[6]);
1391 } else {
1392 /*
1393 * GPCMD_SEND_KEY from multi media commands
1394 */
1395 *size = get_unaligned_be16(&cdb[8]);
1396 }
1397 break;
Christoph Hellwig88455ec2012-05-20 11:59:13 -04001398 default:
1399 pr_warn("TARGET_CORE[%s]: Unsupported SCSI Opcode"
1400 " 0x%02x, sending CHECK_CONDITION.\n",
1401 cmd->se_tfo->get_fabric_name(), cdb[0]);
Christoph Hellwigde103c92012-11-06 12:24:09 -08001402 return TCM_UNSUPPORTED_SCSI_OPCODE;
Christoph Hellwig88455ec2012-05-20 11:59:13 -04001403 }
1404
1405 return 0;
1406}
1407EXPORT_SYMBOL(spc_parse_cdb);