]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - drivers/target/target_core_spc.c
scsi: lpfc: Correct topology type reporting on G7 adapters
[mirror_ubuntu-bionic-kernel.git] / drivers / target / target_core_spc.c
CommitLineData
88455ec4
CH
1/*
2 * SCSI Primary Commands (SPC) parsing and emulation.
3 *
4c76251e 4 * (c) Copyright 2002-2013 Datera, Inc.
88455ec4
CH
5 *
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
ba929992
BVA
27#include <scsi/scsi_proto.h>
28#include <scsi/scsi_common.h>
88455ec4
CH
29#include <scsi/scsi_tcq.h>
30
31#include <target/target_core_base.h>
32#include <target/target_core_backend.h>
33#include <target/target_core_fabric.h>
34
35#include "target_core_internal.h"
eba2ca45 36#include "target_core_alua.h"
88455ec4
CH
37#include "target_core_pr.h"
38#include "target_core_ua.h"
04b1b795 39#include "target_core_xcopy.h"
88455ec4 40
adf653f9 41static void spc_fill_alua_data(struct se_lun *lun, unsigned char *buf)
1fd032ee
CH
42{
43 struct t10_alua_tg_pt_gp *tg_pt_gp;
1fd032ee
CH
44
45 /*
46 * Set SCCS for MAINTENANCE_IN + REPORT_TARGET_PORT_GROUPS.
47 */
48 buf[5] = 0x80;
49
50 /*
125d0119 51 * Set TPGS field for explicit and/or implicit ALUA access type
1fd032ee
CH
52 * and opteration.
53 *
54 * See spc4r17 section 6.4.2 Table 135
55 */
adf653f9
CH
56 spin_lock(&lun->lun_tg_pt_gp_lock);
57 tg_pt_gp = lun->lun_tg_pt_gp;
1fd032ee
CH
58 if (tg_pt_gp)
59 buf[5] |= tg_pt_gp->tg_pt_gp_alua_access_type;
adf653f9 60 spin_unlock(&lun->lun_tg_pt_gp_lock);
1fd032ee
CH
61}
62
0dfa1c5d
HR
63sense_reason_t
64spc_emulate_inquiry_std(struct se_cmd *cmd, unsigned char *buf)
1fd032ee
CH
65{
66 struct se_lun *lun = cmd->se_lun;
67 struct se_device *dev = cmd->se_dev;
d2c5304c 68 struct se_session *sess = cmd->se_sess;
1fd032ee
CH
69
70 /* Set RMB (removable media) for tape devices */
71 if (dev->transport->get_device_type(dev) == TYPE_TAPE)
72 buf[1] = 0x80;
73
48c2567d 74 buf[2] = 0x05; /* SPC-3 */
1fd032ee
CH
75
76 /*
77 * NORMACA and HISUP = 0, RESPONSE DATA FORMAT = 2
78 *
79 * SPC4 says:
80 * A RESPONSE DATA FORMAT field set to 2h indicates that the
81 * standard INQUIRY data is in the format defined in this
82 * standard. Response data format values less than 2h are
83 * obsolete. Response data format values greater than 2h are
84 * reserved.
85 */
86 buf[3] = 2;
87
88 /*
89 * Enable SCCS and TPGS fields for Emulated ALUA
90 */
adf653f9 91 spc_fill_alua_data(lun, buf);
1fd032ee 92
d397a445
NB
93 /*
94 * Set Third-Party Copy (3PC) bit to indicate support for EXTENDED_COPY
95 */
96 if (dev->dev_attrib.emulate_3pc)
97 buf[5] |= 0x8;
bdbad2bd 98 /*
d2c5304c 99 * Set Protection (PROTECT) bit when DIF has been enabled on the
9ef5466e
NB
100 * device, and the fabric supports VERIFY + PASS. Also report
101 * PROTECT=1 if sess_prot_type has been configured to allow T10-PI
102 * to unprotected devices.
bdbad2bd 103 */
d2c5304c 104 if (sess->sup_prot_ops & (TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS)) {
9ef5466e 105 if (dev->dev_attrib.pi_prot_type || cmd->se_sess->sess_prot_type)
d2c5304c
NB
106 buf[5] |= 0x1;
107 }
d397a445 108
1fd032ee
CH
109 buf[7] = 0x2; /* CmdQue=1 */
110
231be068
DD
111 /*
112 * ASCII data fields described as being left-aligned shall have any
113 * unused bytes at the end of the field (i.e., highest offset) and the
114 * unused bytes shall be filled with ASCII space characters (20h).
115 */
116 memset(&buf[8], 0x20, 8 + 16 + 4);
117 memcpy(&buf[8], "LIO-ORG", sizeof("LIO-ORG") - 1);
ee60bddb 118 memcpy(&buf[16], dev->t10_wwn.model,
231be068 119 strnlen(dev->t10_wwn.model, 16));
ee60bddb 120 memcpy(&buf[32], dev->t10_wwn.revision,
231be068 121 strnlen(dev->t10_wwn.revision, 4));
1fd032ee
CH
122 buf[4] = 31; /* Set additional length to 31 */
123
124 return 0;
125}
0dfa1c5d 126EXPORT_SYMBOL(spc_emulate_inquiry_std);
1fd032ee
CH
127
128/* unit serial number */
de103c93
CH
129static sense_reason_t
130spc_emulate_evpd_80(struct se_cmd *cmd, unsigned char *buf)
1fd032ee
CH
131{
132 struct se_device *dev = cmd->se_dev;
9aff64e1 133 u16 len;
1fd032ee 134
0fd97ccf 135 if (dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL) {
9aff64e1 136 len = sprintf(&buf[4], "%s", dev->t10_wwn.unit_serial);
1fd032ee
CH
137 len++; /* Extra Byte for NULL Terminator */
138 buf[3] = len;
139 }
140 return 0;
141}
142
68366026
NB
143void spc_parse_naa_6h_vendor_specific(struct se_device *dev,
144 unsigned char *buf)
1fd032ee 145{
0fd97ccf 146 unsigned char *p = &dev->t10_wwn.unit_serial[0];
1fd032ee
CH
147 int cnt;
148 bool next = true;
149
150 /*
151 * Generate up to 36 bits of VENDOR SPECIFIC IDENTIFIER starting on
152 * byte 3 bit 3-0 for NAA IEEE Registered Extended DESIGNATOR field
153 * format, followed by 64 bits of VENDOR SPECIFIC IDENTIFIER EXTENSION
154 * to complete the payload. These are based from VPD=0x80 PRODUCT SERIAL
155 * NUMBER set via vpd_unit_serial in target_core_configfs.c to ensure
156 * per device uniqeness.
157 */
158 for (cnt = 0; *p && cnt < 13; p++) {
159 int val = hex_to_bin(*p);
160
161 if (val < 0)
162 continue;
163
164 if (next) {
165 next = false;
166 buf[cnt++] |= val;
167 } else {
168 next = true;
169 buf[cnt] = val << 4;
170 }
171 }
172}
173
174/*
175 * Device identification VPD, for a complete list of
176 * DESIGNATOR TYPEs see spc4r17 Table 459.
177 */
0dfa1c5d 178sense_reason_t
de103c93 179spc_emulate_evpd_83(struct se_cmd *cmd, unsigned char *buf)
1fd032ee
CH
180{
181 struct se_device *dev = cmd->se_dev;
182 struct se_lun *lun = cmd->se_lun;
1fd032ee
CH
183 struct se_portal_group *tpg = NULL;
184 struct t10_alua_lu_gp_member *lu_gp_mem;
185 struct t10_alua_tg_pt_gp *tg_pt_gp;
0fd97ccf 186 unsigned char *prod = &dev->t10_wwn.model[0];
1fd032ee
CH
187 u32 prod_len;
188 u32 unit_serial_len, off = 0;
189 u16 len = 0, id_len;
190
191 off = 4;
192
193 /*
194 * NAA IEEE Registered Extended Assigned designator format, see
195 * spc4r17 section 7.7.3.6.5
196 *
197 * We depend upon a target_core_mod/ConfigFS provided
198 * /sys/kernel/config/target/core/$HBA/$DEV/wwn/vpd_unit_serial
199 * value in order to return the NAA id.
200 */
0fd97ccf 201 if (!(dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL))
1fd032ee
CH
202 goto check_t10_vend_desc;
203
204 /* CODE SET == Binary */
205 buf[off++] = 0x1;
206
207 /* Set ASSOCIATION == addressed logical unit: 0)b */
208 buf[off] = 0x00;
209
210 /* Identifier/Designator type == NAA identifier */
211 buf[off++] |= 0x3;
212 off++;
213
214 /* Identifier/Designator length */
215 buf[off++] = 0x10;
216
217 /*
218 * Start NAA IEEE Registered Extended Identifier/Designator
219 */
220 buf[off++] = (0x6 << 4);
221
222 /*
223 * Use OpenFabrics IEEE Company ID: 00 14 05
224 */
225 buf[off++] = 0x01;
226 buf[off++] = 0x40;
227 buf[off] = (0x5 << 4);
228
229 /*
230 * Return ConfigFS Unit Serial Number information for
231 * VENDOR_SPECIFIC_IDENTIFIER and
232 * VENDOR_SPECIFIC_IDENTIFIER_EXTENTION
233 */
234 spc_parse_naa_6h_vendor_specific(dev, &buf[off]);
235
236 len = 20;
237 off = (len + 4);
238
239check_t10_vend_desc:
240 /*
241 * T10 Vendor Identifier Page, see spc4r17 section 7.7.3.4
242 */
243 id_len = 8; /* For Vendor field */
244 prod_len = 4; /* For VPD Header */
245 prod_len += 8; /* For Vendor field */
246 prod_len += strlen(prod);
247 prod_len++; /* For : */
248
0fd97ccf
CH
249 if (dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL) {
250 unit_serial_len = strlen(&dev->t10_wwn.unit_serial[0]);
1fd032ee
CH
251 unit_serial_len++; /* For NULL Terminator */
252
253 id_len += sprintf(&buf[off+12], "%s:%s", prod,
0fd97ccf 254 &dev->t10_wwn.unit_serial[0]);
1fd032ee
CH
255 }
256 buf[off] = 0x2; /* ASCII */
257 buf[off+1] = 0x1; /* T10 Vendor ID */
258 buf[off+2] = 0x0;
231be068
DD
259 /* left align Vendor ID and pad with spaces */
260 memset(&buf[off+4], 0x20, 8);
261 memcpy(&buf[off+4], "LIO-ORG", sizeof("LIO-ORG") - 1);
1fd032ee
CH
262 /* Extra Byte for NULL Terminator */
263 id_len++;
264 /* Identifier Length */
265 buf[off+3] = id_len;
266 /* Header size for Designation descriptor */
267 len += (id_len + 4);
268 off += (id_len + 4);
adf653f9
CH
269
270 if (1) {
1fd032ee 271 struct t10_alua_lu_gp *lu_gp;
fbfe858f 272 u32 padding, scsi_name_len, scsi_target_len;
1fd032ee
CH
273 u16 lu_gp_id = 0;
274 u16 tg_pt_gp_id = 0;
275 u16 tpgt;
276
adf653f9 277 tpg = lun->lun_tpg;
1fd032ee
CH
278 /*
279 * Relative target port identifer, see spc4r17
280 * section 7.7.3.7
281 *
282 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
283 * section 7.5.1 Table 362
284 */
2aeeafae 285 buf[off] = tpg->proto_id << 4;
1fd032ee
CH
286 buf[off++] |= 0x1; /* CODE SET == Binary */
287 buf[off] = 0x80; /* Set PIV=1 */
288 /* Set ASSOCIATION == target port: 01b */
289 buf[off] |= 0x10;
290 /* DESIGNATOR TYPE == Relative target port identifer */
291 buf[off++] |= 0x4;
292 off++; /* Skip over Reserved */
293 buf[off++] = 4; /* DESIGNATOR LENGTH */
294 /* Skip over Obsolete field in RTPI payload
295 * in Table 472 */
296 off += 2;
a85d667e
BVA
297 put_unaligned_be16(lun->lun_rtpi, &buf[off]);
298 off += 2;
1fd032ee
CH
299 len += 8; /* Header size + Designation descriptor */
300 /*
301 * Target port group identifier, see spc4r17
302 * section 7.7.3.8
303 *
304 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
305 * section 7.5.1 Table 362
306 */
adf653f9
CH
307 spin_lock(&lun->lun_tg_pt_gp_lock);
308 tg_pt_gp = lun->lun_tg_pt_gp;
1fd032ee 309 if (!tg_pt_gp) {
adf653f9 310 spin_unlock(&lun->lun_tg_pt_gp_lock);
1fd032ee
CH
311 goto check_lu_gp;
312 }
313 tg_pt_gp_id = tg_pt_gp->tg_pt_gp_id;
adf653f9 314 spin_unlock(&lun->lun_tg_pt_gp_lock);
1fd032ee 315
2aeeafae 316 buf[off] = tpg->proto_id << 4;
1fd032ee
CH
317 buf[off++] |= 0x1; /* CODE SET == Binary */
318 buf[off] = 0x80; /* Set PIV=1 */
319 /* Set ASSOCIATION == target port: 01b */
320 buf[off] |= 0x10;
321 /* DESIGNATOR TYPE == Target port group identifier */
322 buf[off++] |= 0x5;
323 off++; /* Skip over Reserved */
324 buf[off++] = 4; /* DESIGNATOR LENGTH */
325 off += 2; /* Skip over Reserved Field */
a85d667e
BVA
326 put_unaligned_be16(tg_pt_gp_id, &buf[off]);
327 off += 2;
1fd032ee
CH
328 len += 8; /* Header size + Designation descriptor */
329 /*
330 * Logical Unit Group identifier, see spc4r17
331 * section 7.7.3.8
332 */
333check_lu_gp:
334 lu_gp_mem = dev->dev_alua_lu_gp_mem;
335 if (!lu_gp_mem)
336 goto check_scsi_name;
337
338 spin_lock(&lu_gp_mem->lu_gp_mem_lock);
339 lu_gp = lu_gp_mem->lu_gp;
340 if (!lu_gp) {
341 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
342 goto check_scsi_name;
343 }
344 lu_gp_id = lu_gp->lu_gp_id;
345 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
346
347 buf[off++] |= 0x1; /* CODE SET == Binary */
348 /* DESIGNATOR TYPE == Logical Unit Group identifier */
349 buf[off++] |= 0x6;
350 off++; /* Skip over Reserved */
351 buf[off++] = 4; /* DESIGNATOR LENGTH */
352 off += 2; /* Skip over Reserved Field */
a85d667e
BVA
353 put_unaligned_be16(lu_gp_id, &buf[off]);
354 off += 2;
1fd032ee
CH
355 len += 8; /* Header size + Designation descriptor */
356 /*
357 * SCSI name string designator, see spc4r17
358 * section 7.7.3.11
359 *
360 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
361 * section 7.5.1 Table 362
362 */
363check_scsi_name:
2aeeafae 364 buf[off] = tpg->proto_id << 4;
1fd032ee
CH
365 buf[off++] |= 0x3; /* CODE SET == UTF-8 */
366 buf[off] = 0x80; /* Set PIV=1 */
367 /* Set ASSOCIATION == target port: 01b */
368 buf[off] |= 0x10;
369 /* DESIGNATOR TYPE == SCSI name string */
370 buf[off++] |= 0x8;
371 off += 2; /* Skip over Reserved and length */
372 /*
373 * SCSI name string identifer containing, $FABRIC_MOD
374 * dependent information. For LIO-Target and iSCSI
375 * Target Port, this means "<iSCSI name>,t,0x<TPGT> in
376 * UTF-8 encoding.
377 */
378 tpgt = tpg->se_tpg_tfo->tpg_get_tag(tpg);
379 scsi_name_len = sprintf(&buf[off], "%s,t,0x%04x",
380 tpg->se_tpg_tfo->tpg_get_wwn(tpg), tpgt);
381 scsi_name_len += 1 /* Include NULL terminator */;
382 /*
383 * The null-terminated, null-padded (see 4.4.2) SCSI
384 * NAME STRING field contains a UTF-8 format string.
385 * The number of bytes in the SCSI NAME STRING field
386 * (i.e., the value in the DESIGNATOR LENGTH field)
387 * shall be no larger than 256 and shall be a multiple
388 * of four.
389 */
03ba84ca 390 padding = ((-scsi_name_len) & 3);
1fd032ee
CH
391 if (padding)
392 scsi_name_len += padding;
03ba84ca
HR
393 if (scsi_name_len > 256)
394 scsi_name_len = 256;
1fd032ee
CH
395
396 buf[off-1] = scsi_name_len;
397 off += scsi_name_len;
398 /* Header size + Designation descriptor */
399 len += (scsi_name_len + 4);
fbfe858f
HR
400
401 /*
402 * Target device designator
403 */
2aeeafae 404 buf[off] = tpg->proto_id << 4;
fbfe858f
HR
405 buf[off++] |= 0x3; /* CODE SET == UTF-8 */
406 buf[off] = 0x80; /* Set PIV=1 */
407 /* Set ASSOCIATION == target device: 10b */
408 buf[off] |= 0x20;
409 /* DESIGNATOR TYPE == SCSI name string */
410 buf[off++] |= 0x8;
411 off += 2; /* Skip over Reserved and length */
412 /*
413 * SCSI name string identifer containing, $FABRIC_MOD
414 * dependent information. For LIO-Target and iSCSI
415 * Target Port, this means "<iSCSI name>" in
416 * UTF-8 encoding.
417 */
418 scsi_target_len = sprintf(&buf[off], "%s",
419 tpg->se_tpg_tfo->tpg_get_wwn(tpg));
420 scsi_target_len += 1 /* Include NULL terminator */;
421 /*
422 * The null-terminated, null-padded (see 4.4.2) SCSI
423 * NAME STRING field contains a UTF-8 format string.
424 * The number of bytes in the SCSI NAME STRING field
425 * (i.e., the value in the DESIGNATOR LENGTH field)
426 * shall be no larger than 256 and shall be a multiple
427 * of four.
428 */
429 padding = ((-scsi_target_len) & 3);
430 if (padding)
431 scsi_target_len += padding;
6a16d7be
RD
432 if (scsi_target_len > 256)
433 scsi_target_len = 256;
fbfe858f
HR
434
435 buf[off-1] = scsi_target_len;
436 off += scsi_target_len;
437
438 /* Header size + Designation descriptor */
439 len += (scsi_target_len + 4);
1fd032ee 440 }
a85d667e 441 put_unaligned_be16(len, &buf[2]); /* Page Length for VPD 0x83 */
1fd032ee
CH
442 return 0;
443}
0dfa1c5d 444EXPORT_SYMBOL(spc_emulate_evpd_83);
1fd032ee
CH
445
446/* Extended INQUIRY Data VPD Page */
de103c93
CH
447static sense_reason_t
448spc_emulate_evpd_86(struct se_cmd *cmd, unsigned char *buf)
1fd032ee 449{
d0c8b259 450 struct se_device *dev = cmd->se_dev;
d2c5304c 451 struct se_session *sess = cmd->se_sess;
d0c8b259 452
1fd032ee 453 buf[3] = 0x3c;
43bb95c7
NB
454 /*
455 * Set GRD_CHK + REF_CHK for TYPE1 protection, or GRD_CHK
456 * only for TYPE3 protection.
457 */
d2c5304c 458 if (sess->sup_prot_ops & (TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS)) {
9ef5466e
NB
459 if (dev->dev_attrib.pi_prot_type == TARGET_DIF_TYPE1_PROT ||
460 cmd->se_sess->sess_prot_type == TARGET_DIF_TYPE1_PROT)
d2c5304c 461 buf[4] = 0x5;
9ef5466e 462 else if (dev->dev_attrib.pi_prot_type == TARGET_DIF_TYPE3_PROT ||
3aa3c67b 463 cmd->se_sess->sess_prot_type == TARGET_DIF_TYPE3_PROT)
d2c5304c
NB
464 buf[4] = 0x4;
465 }
43bb95c7 466
27e6772b 467 /* logical unit supports type 1 and type 3 protection */
3aa3c67b
NB
468 if ((dev->transport->get_device_type(dev) == TYPE_DISK) &&
469 (sess->sup_prot_ops & (TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS)) &&
470 (dev->dev_attrib.pi_prot_type || cmd->se_sess->sess_prot_type)) {
471 buf[4] |= (0x3 << 3);
472 }
27e6772b 473
1fd032ee
CH
474 /* Set HEADSUP, ORDSUP, SIMPSUP */
475 buf[5] = 0x07;
476
477 /* If WriteCache emulation is enabled, set V_SUP */
814e5b45 478 if (target_check_wce(dev))
1fd032ee 479 buf[6] = 0x01;
c66094bf
HR
480 /* If an LBA map is present set R_SUP */
481 spin_lock(&cmd->se_dev->t10_alua.lba_map_lock);
482 if (!list_empty(&dev->t10_alua.lba_map_list))
483 buf[8] = 0x10;
484 spin_unlock(&cmd->se_dev->t10_alua.lba_map_lock);
1fd032ee
CH
485 return 0;
486}
487
488/* Block Limits VPD page */
de103c93
CH
489static sense_reason_t
490spc_emulate_evpd_b0(struct se_cmd *cmd, unsigned char *buf)
1fd032ee
CH
491{
492 struct se_device *dev = cmd->se_dev;
8f9b5654
NB
493 u32 mtl = 0;
494 int have_tp = 0, opt, min;
1fd032ee
CH
495
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 */
0fd97ccf 501 if (dev->dev_attrib.emulate_tpu || dev->dev_attrib.emulate_tpws)
1fd032ee
CH
502 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;
0123a9ec
NB
509 /*
510 * Set MAXIMUM COMPARE AND WRITE LENGTH
511 */
512 if (dev->dev_attrib.emulate_caw)
513 buf[5] = 0x01;
1fd032ee
CH
514
515 /*
516 * Set OPTIMAL TRANSFER LENGTH GRANULARITY
517 */
7f7caf6a
AG
518 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]);
1fd032ee
CH
522
523 /*
524 * Set MAXIMUM TRANSFER LENGTH
8f9b5654
NB
525 *
526 * XXX: Currently assumes single PAGE_SIZE per scatterlist for fabrics
527 * enforcing maximum HW scatter-gather-list entry limit
1fd032ee 528 */
8f9b5654
NB
529 if (cmd->se_tfo->max_data_sg_nents) {
530 mtl = (cmd->se_tfo->max_data_sg_nents * PAGE_SIZE) /
531 dev->dev_attrib.block_size;
532 }
533 put_unaligned_be32(min_not_zero(mtl, dev->dev_attrib.hw_max_sectors), &buf[8]);
1fd032ee
CH
534
535 /*
536 * Set OPTIMAL TRANSFER LENGTH
537 */
7f7caf6a
AG
538 if (dev->transport->get_io_opt && (opt = dev->transport->get_io_opt(dev)))
539 put_unaligned_be32(opt / dev->dev_attrib.block_size, &buf[12]);
540 else
541 put_unaligned_be32(dev->dev_attrib.optimal_sectors, &buf[12]);
1fd032ee
CH
542
543 /*
544 * Exit now if we don't support TP.
545 */
546 if (!have_tp)
773cbaf7 547 goto max_write_same;
1fd032ee
CH
548
549 /*
550 * Set MAXIMUM UNMAP LBA COUNT
551 */
0fd97ccf 552 put_unaligned_be32(dev->dev_attrib.max_unmap_lba_count, &buf[20]);
1fd032ee
CH
553
554 /*
555 * Set MAXIMUM UNMAP BLOCK DESCRIPTOR COUNT
556 */
0fd97ccf 557 put_unaligned_be32(dev->dev_attrib.max_unmap_block_desc_count,
1fd032ee
CH
558 &buf[24]);
559
560 /*
561 * Set OPTIMAL UNMAP GRANULARITY
562 */
0fd97ccf 563 put_unaligned_be32(dev->dev_attrib.unmap_granularity, &buf[28]);
1fd032ee
CH
564
565 /*
566 * UNMAP GRANULARITY ALIGNMENT
567 */
0fd97ccf 568 put_unaligned_be32(dev->dev_attrib.unmap_granularity_alignment,
1fd032ee 569 &buf[32]);
0fd97ccf 570 if (dev->dev_attrib.unmap_granularity_alignment != 0)
1fd032ee
CH
571 buf[32] |= 0x80; /* Set the UGAVALID bit */
572
773cbaf7
NB
573 /*
574 * MAXIMUM WRITE SAME LENGTH
575 */
576max_write_same:
577 put_unaligned_be64(dev->dev_attrib.max_write_same_len, &buf[36]);
578
1fd032ee
CH
579 return 0;
580}
581
582/* Block Device Characteristics VPD page */
de103c93
CH
583static sense_reason_t
584spc_emulate_evpd_b1(struct se_cmd *cmd, unsigned char *buf)
1fd032ee
CH
585{
586 struct se_device *dev = cmd->se_dev;
587
588 buf[0] = dev->transport->get_device_type(dev);
589 buf[3] = 0x3c;
0fd97ccf 590 buf[5] = dev->dev_attrib.is_nonrot ? 1 : 0;
1fd032ee
CH
591
592 return 0;
593}
594
595/* Thin Provisioning VPD */
de103c93
CH
596static sense_reason_t
597spc_emulate_evpd_b2(struct se_cmd *cmd, unsigned char *buf)
1fd032ee
CH
598{
599 struct se_device *dev = cmd->se_dev;
600
601 /*
602 * From spc3r22 section 6.5.4 Thin Provisioning VPD page:
603 *
604 * The PAGE LENGTH field is defined in SPC-4. If the DP bit is set to
605 * zero, then the page length shall be set to 0004h. If the DP bit
606 * is set to one, then the page length shall be set to the value
607 * defined in table 162.
608 */
609 buf[0] = dev->transport->get_device_type(dev);
610
611 /*
612 * Set Hardcoded length mentioned above for DP=0
613 */
614 put_unaligned_be16(0x0004, &buf[2]);
615
616 /*
617 * The THRESHOLD EXPONENT field indicates the threshold set size in
618 * LBAs as a power of 2 (i.e., the threshold set size is equal to
619 * 2(threshold exponent)).
620 *
621 * Note that this is currently set to 0x00 as mkp says it will be
622 * changing again. We can enable this once it has settled in T10
623 * and is actually used by Linux/SCSI ML code.
624 */
625 buf[4] = 0x00;
626
627 /*
628 * A TPU bit set to one indicates that the device server supports
629 * the UNMAP command (see 5.25). A TPU bit set to zero indicates
630 * that the device server does not support the UNMAP command.
631 */
0fd97ccf 632 if (dev->dev_attrib.emulate_tpu != 0)
1fd032ee
CH
633 buf[5] = 0x80;
634
635 /*
636 * A TPWS bit set to one indicates that the device server supports
637 * the use of the WRITE SAME (16) command (see 5.42) to unmap LBAs.
638 * A TPWS bit set to zero indicates that the device server does not
639 * support the use of the WRITE SAME (16) command to unmap LBAs.
640 */
0fd97ccf 641 if (dev->dev_attrib.emulate_tpws != 0)
aa04dae4 642 buf[5] |= 0x40 | 0x20;
1fd032ee 643
e6f41633
JP
644 /*
645 * The unmap_zeroes_data set means that the underlying device supports
646 * REQ_DISCARD and has the discard_zeroes_data bit set. This satisfies
647 * the SBC requirements for LBPRZ, meaning that a subsequent read
648 * will return zeroes after an UNMAP or WRITE SAME (16) to an LBA
649 * See sbc4r36 6.6.4.
650 */
651 if (((dev->dev_attrib.emulate_tpu != 0) ||
652 (dev->dev_attrib.emulate_tpws != 0)) &&
653 (dev->dev_attrib.unmap_zeroes_data != 0))
654 buf[5] |= 0x04;
655
1fd032ee
CH
656 return 0;
657}
658
c66094bf
HR
659/* Referrals VPD page */
660static sense_reason_t
661spc_emulate_evpd_b3(struct se_cmd *cmd, unsigned char *buf)
662{
663 struct se_device *dev = cmd->se_dev;
664
665 buf[0] = dev->transport->get_device_type(dev);
666 buf[3] = 0x0c;
667 put_unaligned_be32(dev->t10_alua.lba_map_segment_size, &buf[8]);
096b4995 668 put_unaligned_be32(dev->t10_alua.lba_map_segment_multiplier, &buf[12]);
c66094bf
HR
669
670 return 0;
671}
672
de103c93
CH
673static sense_reason_t
674spc_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf);
1fd032ee
CH
675
676static struct {
677 uint8_t page;
de103c93 678 sense_reason_t (*emulate)(struct se_cmd *, unsigned char *);
1fd032ee
CH
679} evpd_handlers[] = {
680 { .page = 0x00, .emulate = spc_emulate_evpd_00 },
681 { .page = 0x80, .emulate = spc_emulate_evpd_80 },
682 { .page = 0x83, .emulate = spc_emulate_evpd_83 },
683 { .page = 0x86, .emulate = spc_emulate_evpd_86 },
684 { .page = 0xb0, .emulate = spc_emulate_evpd_b0 },
685 { .page = 0xb1, .emulate = spc_emulate_evpd_b1 },
686 { .page = 0xb2, .emulate = spc_emulate_evpd_b2 },
c66094bf 687 { .page = 0xb3, .emulate = spc_emulate_evpd_b3 },
1fd032ee
CH
688};
689
690/* supported vital product data pages */
de103c93
CH
691static sense_reason_t
692spc_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf)
1fd032ee
CH
693{
694 int p;
695
696 /*
697 * Only report the INQUIRY EVPD=1 pages after a valid NAA
698 * Registered Extended LUN WWN has been set via ConfigFS
699 * during device creation/restart.
700 */
0fd97ccf 701 if (cmd->se_dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL) {
1fd032ee
CH
702 buf[3] = ARRAY_SIZE(evpd_handlers);
703 for (p = 0; p < ARRAY_SIZE(evpd_handlers); ++p)
704 buf[p + 4] = evpd_handlers[p].page;
705 }
706
707 return 0;
708}
709
de103c93
CH
710static sense_reason_t
711spc_emulate_inquiry(struct se_cmd *cmd)
1fd032ee
CH
712{
713 struct se_device *dev = cmd->se_dev;
adf653f9 714 struct se_portal_group *tpg = cmd->se_lun->lun_tpg;
ffe7b0e9 715 unsigned char *rbuf;
1fd032ee 716 unsigned char *cdb = cmd->t_task_cdb;
f82f320e 717 unsigned char *buf;
de103c93
CH
718 sense_reason_t ret;
719 int p;
2426bd45 720 int len = 0;
1fd032ee 721
f82f320e
NB
722 buf = kzalloc(SE_INQUIRY_BUF, GFP_KERNEL);
723 if (!buf) {
724 pr_err("Unable to allocate response buffer for INQUIRY\n");
725 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
726 }
dea5f099 727
4cc987ea 728 if (dev == rcu_access_pointer(tpg->tpg_virt_lun0->lun_se_dev))
1fd032ee
CH
729 buf[0] = 0x3f; /* Not connected */
730 else
731 buf[0] = dev->transport->get_device_type(dev);
732
733 if (!(cdb[1] & 0x1)) {
734 if (cdb[2]) {
735 pr_err("INQUIRY with EVPD==0 but PAGE CODE=%02x\n",
736 cdb[2]);
de103c93 737 ret = TCM_INVALID_CDB_FIELD;
1fd032ee
CH
738 goto out;
739 }
740
741 ret = spc_emulate_inquiry_std(cmd, buf);
2426bd45 742 len = buf[4] + 5;
1fd032ee
CH
743 goto out;
744 }
745
746 for (p = 0; p < ARRAY_SIZE(evpd_handlers); ++p) {
747 if (cdb[2] == evpd_handlers[p].page) {
748 buf[1] = cdb[2];
749 ret = evpd_handlers[p].emulate(cmd, buf);
2426bd45 750 len = get_unaligned_be16(&buf[2]) + 4;
1fd032ee
CH
751 goto out;
752 }
753 }
754
755 pr_err("Unknown VPD Code: 0x%02x\n", cdb[2]);
de103c93 756 ret = TCM_INVALID_CDB_FIELD;
1fd032ee
CH
757
758out:
ffe7b0e9 759 rbuf = transport_kmap_data_sg(cmd);
49df9fc9 760 if (rbuf) {
f82f320e 761 memcpy(rbuf, buf, min_t(u32, SE_INQUIRY_BUF, cmd->data_length));
49df9fc9
NB
762 transport_kunmap_data_sg(cmd);
763 }
f82f320e 764 kfree(buf);
1fd032ee
CH
765
766 if (!ret)
2426bd45 767 target_complete_cmd_with_length(cmd, GOOD, len);
1fd032ee
CH
768 return ret;
769}
770
d45aca42 771static int spc_modesense_rwrecovery(struct se_cmd *cmd, u8 pc, u8 *p)
1fd032ee
CH
772{
773 p[0] = 0x01;
774 p[1] = 0x0a;
775
d4b2b867
RD
776 /* No changeable values for now */
777 if (pc == 1)
778 goto out;
779
780out:
1fd032ee
CH
781 return 12;
782}
783
d45aca42 784static int spc_modesense_control(struct se_cmd *cmd, u8 pc, u8 *p)
1fd032ee 785{
d45aca42
NB
786 struct se_device *dev = cmd->se_dev;
787 struct se_session *sess = cmd->se_sess;
788
1fd032ee
CH
789 p[0] = 0x0a;
790 p[1] = 0x0a;
d4b2b867
RD
791
792 /* No changeable values for now */
793 if (pc == 1)
794 goto out;
795
4e4937e8
SG
796 /* GLTSD: No implicit save of log parameters */
797 p[2] = (1 << 1);
798 if (target_sense_desc_format(dev))
799 /* D_SENSE: Descriptor format sense data for 64bit sectors */
800 p[2] |= (1 << 2);
801
1fd032ee
CH
802 /*
803 * From spc4r23, 7.4.7 Control mode page
804 *
805 * The QUEUE ALGORITHM MODIFIER field (see table 368) specifies
806 * restrictions on the algorithm used for reordering commands
807 * having the SIMPLE task attribute (see SAM-4).
808 *
809 * Table 368 -- QUEUE ALGORITHM MODIFIER field
810 * Code Description
811 * 0h Restricted reordering
812 * 1h Unrestricted reordering allowed
813 * 2h to 7h Reserved
814 * 8h to Fh Vendor specific
815 *
816 * A value of zero in the QUEUE ALGORITHM MODIFIER field specifies that
817 * the device server shall order the processing sequence of commands
818 * having the SIMPLE task attribute such that data integrity is maintained
819 * for that I_T nexus (i.e., if the transmission of new SCSI transport protocol
820 * requests is halted at any time, the final value of all data observable
821 * on the medium shall be the same as if all the commands had been processed
822 * with the ORDERED task attribute).
823 *
824 * A value of one in the QUEUE ALGORITHM MODIFIER field specifies that the
825 * device server may reorder the processing sequence of commands having the
826 * SIMPLE task attribute in any manner. Any data integrity exposures related to
827 * command sequence order shall be explicitly handled by the application client
828 * through the selection of appropriate ommands and task attributes.
829 */
0fd97ccf 830 p[3] = (dev->dev_attrib.emulate_rest_reord == 1) ? 0x00 : 0x10;
1fd032ee
CH
831 /*
832 * From spc4r17, section 7.4.6 Control mode Page
833 *
834 * Unit Attention interlocks control (UN_INTLCK_CTRL) to code 00b
835 *
836 * 00b: The logical unit shall clear any unit attention condition
837 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
838 * status and shall not establish a unit attention condition when a com-
839 * mand is completed with BUSY, TASK SET FULL, or RESERVATION CONFLICT
840 * status.
841 *
842 * 10b: The logical unit shall not clear any unit attention condition
843 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
844 * status and shall not establish a unit attention condition when
845 * a command is completed with BUSY, TASK SET FULL, or RESERVATION
846 * CONFLICT status.
847 *
848 * 11b a The logical unit shall not clear any unit attention condition
849 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
850 * status and shall establish a unit attention condition for the
851 * initiator port associated with the I_T nexus on which the BUSY,
852 * TASK SET FULL, or RESERVATION CONFLICT status is being returned.
853 * Depending on the status, the additional sense code shall be set to
854 * PREVIOUS BUSY STATUS, PREVIOUS TASK SET FULL STATUS, or PREVIOUS
855 * RESERVATION CONFLICT STATUS. Until it is cleared by a REQUEST SENSE
856 * command, a unit attention condition shall be established only once
857 * for a BUSY, TASK SET FULL, or RESERVATION CONFLICT status regardless
858 * to the number of commands completed with one of those status codes.
859 */
0fd97ccf
CH
860 p[4] = (dev->dev_attrib.emulate_ua_intlck_ctrl == 2) ? 0x30 :
861 (dev->dev_attrib.emulate_ua_intlck_ctrl == 1) ? 0x20 : 0x00;
1fd032ee
CH
862 /*
863 * From spc4r17, section 7.4.6 Control mode Page
864 *
865 * Task Aborted Status (TAS) bit set to zero.
866 *
867 * A task aborted status (TAS) bit set to zero specifies that aborted
868 * tasks shall be terminated by the device server without any response
869 * to the application client. A TAS bit set to one specifies that tasks
870 * aborted by the actions of an I_T nexus other than the I_T nexus on
871 * which the command was received shall be completed with TASK ABORTED
872 * status (see SAM-4).
873 */
0fd97ccf 874 p[5] = (dev->dev_attrib.emulate_tas) ? 0x40 : 0x00;
0c30f421
NB
875 /*
876 * From spc4r30, section 7.5.7 Control mode page
877 *
878 * Application Tag Owner (ATO) bit set to one.
879 *
880 * If the ATO bit is set to one the device server shall not modify the
881 * LOGICAL BLOCK APPLICATION TAG field and, depending on the protection
882 * type, shall not modify the contents of the LOGICAL BLOCK REFERENCE
883 * TAG field.
884 */
d45aca42 885 if (sess->sup_prot_ops & (TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS)) {
9ef5466e 886 if (dev->dev_attrib.pi_prot_type || sess->sess_prot_type)
d45aca42
NB
887 p[5] |= 0x80;
888 }
0c30f421 889
1fd032ee
CH
890 p[8] = 0xff;
891 p[9] = 0xff;
892 p[11] = 30;
893
d4b2b867 894out:
1fd032ee
CH
895 return 12;
896}
897
d45aca42 898static int spc_modesense_caching(struct se_cmd *cmd, u8 pc, u8 *p)
1fd032ee 899{
d45aca42
NB
900 struct se_device *dev = cmd->se_dev;
901
1fd032ee
CH
902 p[0] = 0x08;
903 p[1] = 0x12;
d4b2b867
RD
904
905 /* No changeable values for now */
906 if (pc == 1)
907 goto out;
908
814e5b45 909 if (target_check_wce(dev))
1fd032ee
CH
910 p[2] = 0x04; /* Write Cache Enable */
911 p[12] = 0x20; /* Disabled Read Ahead */
912
d4b2b867 913out:
1fd032ee
CH
914 return 20;
915}
916
d45aca42 917static int spc_modesense_informational_exceptions(struct se_cmd *cmd, u8 pc, unsigned char *p)
0f6d64ce
RD
918{
919 p[0] = 0x1c;
920 p[1] = 0x0a;
921
922 /* No changeable values for now */
923 if (pc == 1)
924 goto out;
925
926out:
927 return 12;
928}
929
d4b2b867
RD
930static struct {
931 uint8_t page;
932 uint8_t subpage;
d45aca42 933 int (*emulate)(struct se_cmd *, u8, unsigned char *);
d4b2b867
RD
934} modesense_handlers[] = {
935 { .page = 0x01, .subpage = 0x00, .emulate = spc_modesense_rwrecovery },
936 { .page = 0x08, .subpage = 0x00, .emulate = spc_modesense_caching },
937 { .page = 0x0a, .subpage = 0x00, .emulate = spc_modesense_control },
0f6d64ce 938 { .page = 0x1c, .subpage = 0x00, .emulate = spc_modesense_informational_exceptions },
d4b2b867
RD
939};
940
1fd032ee
CH
941static void spc_modesense_write_protect(unsigned char *buf, int type)
942{
943 /*
944 * I believe that the WP bit (bit 7) in the mode header is the same for
945 * all device types..
946 */
947 switch (type) {
948 case TYPE_DISK:
949 case TYPE_TAPE:
950 default:
951 buf[0] |= 0x80; /* WP bit */
952 break;
953 }
954}
955
956static void spc_modesense_dpofua(unsigned char *buf, int type)
957{
958 switch (type) {
959 case TYPE_DISK:
960 buf[0] |= 0x10; /* DPOFUA bit */
961 break;
962 default:
963 break;
964 }
965}
966
d4b2b867
RD
967static int spc_modesense_blockdesc(unsigned char *buf, u64 blocks, u32 block_size)
968{
969 *buf++ = 8;
970 put_unaligned_be32(min(blocks, 0xffffffffull), buf);
971 buf += 4;
972 put_unaligned_be32(block_size, buf);
973 return 9;
974}
975
976static int spc_modesense_long_blockdesc(unsigned char *buf, u64 blocks, u32 block_size)
977{
978 if (blocks <= 0xffffffff)
979 return spc_modesense_blockdesc(buf + 3, blocks, block_size) + 3;
980
981 *buf++ = 1; /* LONGLBA */
982 buf += 2;
983 *buf++ = 16;
984 put_unaligned_be64(blocks, buf);
985 buf += 12;
986 put_unaligned_be32(block_size, buf);
987
988 return 17;
989}
990
de103c93 991static sense_reason_t spc_emulate_modesense(struct se_cmd *cmd)
1fd032ee
CH
992{
993 struct se_device *dev = cmd->se_dev;
994 char *cdb = cmd->t_task_cdb;
cab9609b 995 unsigned char buf[SE_MODE_PAGE_BUF], *rbuf;
1fd032ee
CH
996 int type = dev->transport->get_device_type(dev);
997 int ten = (cmd->t_task_cdb[0] == MODE_SENSE_10);
d4b2b867
RD
998 bool dbd = !!(cdb[1] & 0x08);
999 bool llba = ten ? !!(cdb[1] & 0x10) : false;
1000 u8 pc = cdb[2] >> 6;
1001 u8 page = cdb[2] & 0x3f;
1002 u8 subpage = cdb[3];
1fd032ee 1003 int length = 0;
d4b2b867
RD
1004 int ret;
1005 int i;
1fd032ee 1006
cab9609b
NB
1007 memset(buf, 0, SE_MODE_PAGE_BUF);
1008
fecae40a
NB
1009 /*
1010 * Skip over MODE DATA LENGTH + MEDIUM TYPE fields to byte 3 for
1011 * MODE_SENSE_10 and byte 2 for MODE_SENSE (6).
1012 */
1013 length = ten ? 3 : 2;
d4b2b867
RD
1014
1015 /* DEVICE-SPECIFIC PARAMETER */
03a68b44 1016 if (cmd->se_lun->lun_access_ro || target_lun_is_rdonly(cmd))
d4b2b867
RD
1017 spc_modesense_write_protect(&buf[length], type);
1018
814e5b45
CH
1019 /*
1020 * SBC only allows us to enable FUA and DPO together. Fortunately
1021 * DPO is explicitly specified as a hint, so a noop is a perfectly
1022 * valid implementation.
1023 */
1024 if (target_check_fua(dev))
d4b2b867
RD
1025 spc_modesense_dpofua(&buf[length], type);
1026
1027 ++length;
1028
1029 /* BLOCK DESCRIPTOR */
1030
1031 /*
1032 * For now we only include a block descriptor for disk (SBC)
1033 * devices; other command sets use a slightly different format.
1034 */
1035 if (!dbd && type == TYPE_DISK) {
1036 u64 blocks = dev->transport->get_blocks(dev);
1037 u32 block_size = dev->dev_attrib.block_size;
1038
1039 if (ten) {
1040 if (llba) {
1041 length += spc_modesense_long_blockdesc(&buf[length],
1042 blocks, block_size);
1043 } else {
1044 length += 3;
1045 length += spc_modesense_blockdesc(&buf[length],
1046 blocks, block_size);
1047 }
1048 } else {
1049 length += spc_modesense_blockdesc(&buf[length], blocks,
1050 block_size);
1051 }
1fd032ee 1052 } else {
d4b2b867
RD
1053 if (ten)
1054 length += 4;
1055 else
1056 length += 1;
1fd032ee
CH
1057 }
1058
d4b2b867
RD
1059 if (page == 0x3f) {
1060 if (subpage != 0x00 && subpage != 0xff) {
de103c93 1061 pr_warn("MODE_SENSE: Invalid subpage code: 0x%02x\n", subpage);
de103c93 1062 return TCM_INVALID_CDB_FIELD;
d4b2b867
RD
1063 }
1064
1065 for (i = 0; i < ARRAY_SIZE(modesense_handlers); ++i) {
1066 /*
1067 * Tricky way to say all subpage 00h for
1068 * subpage==0, all subpages for subpage==0xff
1069 * (and we just checked above that those are
1070 * the only two possibilities).
1071 */
1072 if ((modesense_handlers[i].subpage & ~subpage) == 0) {
d45aca42 1073 ret = modesense_handlers[i].emulate(cmd, pc, &buf[length]);
d4b2b867
RD
1074 if (!ten && length + ret >= 255)
1075 break;
1076 length += ret;
1077 }
1078 }
1079
1080 goto set_length;
1081 }
1082
1083 for (i = 0; i < ARRAY_SIZE(modesense_handlers); ++i)
1084 if (modesense_handlers[i].page == page &&
1085 modesense_handlers[i].subpage == subpage) {
d45aca42 1086 length += modesense_handlers[i].emulate(cmd, pc, &buf[length]);
d4b2b867
RD
1087 goto set_length;
1088 }
1089
1090 /*
1091 * We don't intend to implement:
1092 * - obsolete page 03h "format parameters" (checked by Solaris)
1093 */
1094 if (page != 0x03)
1095 pr_err("MODE SENSE: unimplemented page/subpage: 0x%02x/0x%02x\n",
1096 page, subpage);
1097
de103c93 1098 return TCM_UNKNOWN_MODE_PAGE;
d4b2b867
RD
1099
1100set_length:
1101 if (ten)
1102 put_unaligned_be16(length - 2, buf);
1103 else
1104 buf[0] = length - 1;
1105
cab9609b
NB
1106 rbuf = transport_kmap_data_sg(cmd);
1107 if (rbuf) {
1108 memcpy(rbuf, buf, min_t(u32, SE_MODE_PAGE_BUF, cmd->data_length));
1109 transport_kunmap_data_sg(cmd);
7a3f369c 1110 }
1fd032ee 1111
2426bd45 1112 target_complete_cmd_with_length(cmd, GOOD, length);
1fd032ee
CH
1113 return 0;
1114}
1115
de103c93 1116static sense_reason_t spc_emulate_modeselect(struct se_cmd *cmd)
3a3c5e4a 1117{
3a3c5e4a
RD
1118 char *cdb = cmd->t_task_cdb;
1119 bool ten = cdb[0] == MODE_SELECT_10;
1120 int off = ten ? 8 : 4;
1121 bool pf = !!(cdb[1] & 0x10);
1122 u8 page, subpage;
1123 unsigned char *buf;
1124 unsigned char tbuf[SE_MODE_PAGE_BUF];
1125 int length;
3abff1e5 1126 sense_reason_t ret = 0;
3a3c5e4a
RD
1127 int i;
1128
71f41fe1
RD
1129 if (!cmd->data_length) {
1130 target_complete_cmd(cmd, GOOD);
1131 return 0;
1132 }
1133
1134 if (cmd->data_length < off + 2)
1135 return TCM_PARAMETER_LIST_LENGTH_ERROR;
1136
3a3c5e4a 1137 buf = transport_kmap_data_sg(cmd);
de103c93
CH
1138 if (!buf)
1139 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3a3c5e4a
RD
1140
1141 if (!pf) {
de103c93 1142 ret = TCM_INVALID_CDB_FIELD;
3a3c5e4a
RD
1143 goto out;
1144 }
1145
1146 page = buf[off] & 0x3f;
1147 subpage = buf[off] & 0x40 ? buf[off + 1] : 0;
1148
1149 for (i = 0; i < ARRAY_SIZE(modesense_handlers); ++i)
1150 if (modesense_handlers[i].page == page &&
1151 modesense_handlers[i].subpage == subpage) {
1152 memset(tbuf, 0, SE_MODE_PAGE_BUF);
d45aca42 1153 length = modesense_handlers[i].emulate(cmd, 0, tbuf);
3a3c5e4a
RD
1154 goto check_contents;
1155 }
1156
de103c93 1157 ret = TCM_UNKNOWN_MODE_PAGE;
3a3c5e4a
RD
1158 goto out;
1159
1160check_contents:
71f41fe1
RD
1161 if (cmd->data_length < off + length) {
1162 ret = TCM_PARAMETER_LIST_LENGTH_ERROR;
1163 goto out;
1164 }
1165
de103c93
CH
1166 if (memcmp(buf + off, tbuf, length))
1167 ret = TCM_INVALID_PARAMETER_LIST;
3a3c5e4a
RD
1168
1169out:
1170 transport_kunmap_data_sg(cmd);
1171
1172 if (!ret)
1173 target_complete_cmd(cmd, GOOD);
1174 return ret;
1175}
1176
de103c93 1177static sense_reason_t spc_emulate_request_sense(struct se_cmd *cmd)
1fd032ee
CH
1178{
1179 unsigned char *cdb = cmd->t_task_cdb;
32a8811f 1180 unsigned char *rbuf;
1fd032ee 1181 u8 ua_asc = 0, ua_ascq = 0;
32a8811f 1182 unsigned char buf[SE_SENSE_BUF];
4e4937e8 1183 bool desc_format = target_sense_desc_format(cmd->se_dev);
32a8811f
PB
1184
1185 memset(buf, 0, SE_SENSE_BUF);
1fd032ee
CH
1186
1187 if (cdb[1] & 0x01) {
1188 pr_err("REQUEST_SENSE description emulation not"
1189 " supported\n");
de103c93 1190 return TCM_INVALID_CDB_FIELD;
1fd032ee
CH
1191 }
1192
32a8811f 1193 rbuf = transport_kmap_data_sg(cmd);
de103c93
CH
1194 if (!rbuf)
1195 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1196
9ec1e1ce 1197 if (!core_scsi3_ua_clear_for_request_sense(cmd, &ua_asc, &ua_ascq))
4e4937e8 1198 scsi_build_sense_buffer(desc_format, buf, UNIT_ATTENTION,
9ec1e1ce
SG
1199 ua_asc, ua_ascq);
1200 else
4e4937e8 1201 scsi_build_sense_buffer(desc_format, buf, NO_SENSE, 0x0, 0x0);
1fd032ee 1202
de103c93
CH
1203 memcpy(rbuf, buf, min_t(u32, sizeof(buf), cmd->data_length));
1204 transport_kunmap_data_sg(cmd);
32a8811f 1205
1fd032ee
CH
1206 target_complete_cmd(cmd, GOOD);
1207 return 0;
1208}
1209
de103c93 1210sense_reason_t spc_emulate_report_luns(struct se_cmd *cmd)
d1b1f805
CH
1211{
1212 struct se_dev_entry *deve;
1213 struct se_session *sess = cmd->se_sess;
29a05dee 1214 struct se_node_acl *nacl;
0f69a387 1215 struct scsi_lun slun;
d1b1f805 1216 unsigned char *buf;
29a05dee 1217 u32 lun_count = 0, offset = 8;
0f69a387 1218 __be32 len;
d1b1f805
CH
1219
1220 buf = transport_kmap_data_sg(cmd);
0f69a387 1221 if (cmd->data_length && !buf)
de103c93 1222 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
d1b1f805
CH
1223
1224 /*
1225 * If no struct se_session pointer is present, this struct se_cmd is
1226 * coming via a target_core_mod PASSTHROUGH op, and not through
1227 * a $FABRIC_MOD. In that case, report LUN=0 only.
1228 */
9c395170 1229 if (!sess)
d1b1f805 1230 goto done;
9c395170 1231
29a05dee 1232 nacl = sess->se_node_acl;
d1b1f805 1233
29a05dee
NB
1234 rcu_read_lock();
1235 hlist_for_each_entry_rcu(deve, &nacl->lun_entry_hlist, link) {
d1b1f805
CH
1236 /*
1237 * We determine the correct LUN LIST LENGTH even once we
1238 * have reached the initial allocation length.
1239 * See SPC2-R20 7.19.
1240 */
1241 lun_count++;
0f69a387 1242 if (offset >= cmd->data_length)
d1b1f805
CH
1243 continue;
1244
0f69a387
RD
1245 int_to_scsilun(deve->mapped_lun, &slun);
1246 memcpy(buf + offset, &slun,
1247 min(8u, cmd->data_length - offset));
d1b1f805
CH
1248 offset += 8;
1249 }
29a05dee 1250 rcu_read_unlock();
d1b1f805
CH
1251
1252 /*
1253 * See SPC3 r07, page 159.
1254 */
1255done:
9c395170
RD
1256 /*
1257 * If no LUNs are accessible, report virtual LUN 0.
1258 */
1259 if (lun_count == 0) {
0f69a387
RD
1260 int_to_scsilun(0, &slun);
1261 if (cmd->data_length > 8)
1262 memcpy(buf + offset, &slun,
1263 min(8u, cmd->data_length - offset));
9c395170
RD
1264 lun_count = 1;
1265 }
1266
0f69a387
RD
1267 if (buf) {
1268 len = cpu_to_be32(lun_count * 8);
1269 memcpy(buf, &len, min_t(int, sizeof len, cmd->data_length));
1270 transport_kunmap_data_sg(cmd);
1271 }
d1b1f805 1272
2426bd45 1273 target_complete_cmd_with_length(cmd, GOOD, 8 + lun_count * 8);
d1b1f805
CH
1274 return 0;
1275}
8de530a5 1276EXPORT_SYMBOL(spc_emulate_report_luns);
d1b1f805 1277
de103c93
CH
1278static sense_reason_t
1279spc_emulate_testunitready(struct se_cmd *cmd)
1fd032ee
CH
1280{
1281 target_complete_cmd(cmd, GOOD);
1282 return 0;
1283}
1284
de103c93
CH
1285sense_reason_t
1286spc_parse_cdb(struct se_cmd *cmd, unsigned int *size)
88455ec4 1287{
eba2ca45 1288 struct se_device *dev = cmd->se_dev;
88455ec4
CH
1289 unsigned char *cdb = cmd->t_task_cdb;
1290
1291 switch (cdb[0]) {
1292 case MODE_SELECT:
1293 *size = cdb[4];
3a3c5e4a 1294 cmd->execute_cmd = spc_emulate_modeselect;
88455ec4
CH
1295 break;
1296 case MODE_SELECT_10:
a85d667e 1297 *size = get_unaligned_be16(&cdb[7]);
3a3c5e4a 1298 cmd->execute_cmd = spc_emulate_modeselect;
88455ec4
CH
1299 break;
1300 case MODE_SENSE:
1301 *size = cdb[4];
1fd032ee 1302 cmd->execute_cmd = spc_emulate_modesense;
88455ec4
CH
1303 break;
1304 case MODE_SENSE_10:
a85d667e 1305 *size = get_unaligned_be16(&cdb[7]);
1fd032ee 1306 cmd->execute_cmd = spc_emulate_modesense;
88455ec4
CH
1307 break;
1308 case LOG_SELECT:
1309 case LOG_SENSE:
a85d667e 1310 *size = get_unaligned_be16(&cdb[7]);
88455ec4
CH
1311 break;
1312 case PERSISTENT_RESERVE_IN:
a85d667e 1313 *size = get_unaligned_be16(&cdb[7]);
d977f437 1314 cmd->execute_cmd = target_scsi3_emulate_pr_in;
88455ec4
CH
1315 break;
1316 case PERSISTENT_RESERVE_OUT:
388fe699 1317 *size = get_unaligned_be32(&cdb[5]);
d977f437 1318 cmd->execute_cmd = target_scsi3_emulate_pr_out;
88455ec4
CH
1319 break;
1320 case RELEASE:
1321 case RELEASE_10:
1322 if (cdb[0] == RELEASE_10)
a85d667e 1323 *size = get_unaligned_be16(&cdb[7]);
88455ec4
CH
1324 else
1325 *size = cmd->data_length;
1326
d977f437 1327 cmd->execute_cmd = target_scsi2_reservation_release;
88455ec4
CH
1328 break;
1329 case RESERVE:
1330 case RESERVE_10:
1331 /*
1332 * The SPC-2 RESERVE does not contain a size in the SCSI CDB.
1333 * Assume the passthrough or $FABRIC_MOD will tell us about it.
1334 */
1335 if (cdb[0] == RESERVE_10)
a85d667e 1336 *size = get_unaligned_be16(&cdb[7]);
88455ec4
CH
1337 else
1338 *size = cmd->data_length;
1339
d977f437 1340 cmd->execute_cmd = target_scsi2_reservation_reserve;
88455ec4
CH
1341 break;
1342 case REQUEST_SENSE:
1343 *size = cdb[4];
1fd032ee 1344 cmd->execute_cmd = spc_emulate_request_sense;
88455ec4
CH
1345 break;
1346 case INQUIRY:
a85d667e 1347 *size = get_unaligned_be16(&cdb[3]);
88455ec4
CH
1348
1349 /*
125d0119 1350 * Do implicit HEAD_OF_QUEUE processing for INQUIRY.
88455ec4
CH
1351 * See spc4r17 section 5.3
1352 */
68d81f40 1353 cmd->sam_task_attr = TCM_HEAD_TAG;
1fd032ee 1354 cmd->execute_cmd = spc_emulate_inquiry;
88455ec4
CH
1355 break;
1356 case SECURITY_PROTOCOL_IN:
1357 case SECURITY_PROTOCOL_OUT:
a85d667e 1358 *size = get_unaligned_be32(&cdb[6]);
88455ec4
CH
1359 break;
1360 case EXTENDED_COPY:
04b1b795
NB
1361 *size = get_unaligned_be32(&cdb[10]);
1362 cmd->execute_cmd = target_do_xcopy;
1363 break;
88455ec4 1364 case RECEIVE_COPY_RESULTS:
04b1b795
NB
1365 *size = get_unaligned_be32(&cdb[10]);
1366 cmd->execute_cmd = target_do_receive_copy_results;
1367 break;
1368 case READ_ATTRIBUTE:
88455ec4 1369 case WRITE_ATTRIBUTE:
a85d667e 1370 *size = get_unaligned_be32(&cdb[10]);
88455ec4
CH
1371 break;
1372 case RECEIVE_DIAGNOSTIC:
1373 case SEND_DIAGNOSTIC:
a85d667e 1374 *size = get_unaligned_be16(&cdb[3]);
88455ec4
CH
1375 break;
1376 case WRITE_BUFFER:
a85d667e 1377 *size = get_unaligned_be24(&cdb[6]);
88455ec4
CH
1378 break;
1379 case REPORT_LUNS:
d1b1f805 1380 cmd->execute_cmd = spc_emulate_report_luns;
a85d667e 1381 *size = get_unaligned_be32(&cdb[6]);
88455ec4 1382 /*
125d0119 1383 * Do implicit HEAD_OF_QUEUE processing for REPORT_LUNS
88455ec4
CH
1384 * See spc4r17 section 5.3
1385 */
68d81f40 1386 cmd->sam_task_attr = TCM_HEAD_TAG;
88455ec4
CH
1387 break;
1388 case TEST_UNIT_READY:
1fd032ee 1389 cmd->execute_cmd = spc_emulate_testunitready;
d6e0175c 1390 *size = 0;
88455ec4 1391 break;
eba2ca45
NB
1392 case MAINTENANCE_IN:
1393 if (dev->transport->get_device_type(dev) != TYPE_ROM) {
1394 /*
1395 * MAINTENANCE_IN from SCC-2
1396 * Check for emulated MI_REPORT_TARGET_PGS
1397 */
c87fbd56 1398 if ((cdb[1] & 0x1f) == MI_REPORT_TARGET_PGS) {
eba2ca45
NB
1399 cmd->execute_cmd =
1400 target_emulate_report_target_port_groups;
1401 }
1402 *size = get_unaligned_be32(&cdb[6]);
1403 } else {
1404 /*
1405 * GPCMD_SEND_KEY from multi media commands
1406 */
1407 *size = get_unaligned_be16(&cdb[8]);
1408 }
1409 break;
1410 case MAINTENANCE_OUT:
1411 if (dev->transport->get_device_type(dev) != TYPE_ROM) {
1412 /*
1413 * MAINTENANCE_OUT from SCC-2
1414 * Check for emulated MO_SET_TARGET_PGS.
1415 */
c87fbd56 1416 if (cdb[1] == MO_SET_TARGET_PGS) {
eba2ca45
NB
1417 cmd->execute_cmd =
1418 target_emulate_set_target_port_groups;
1419 }
1420 *size = get_unaligned_be32(&cdb[6]);
1421 } else {
1422 /*
1423 * GPCMD_SEND_KEY from multi media commands
1424 */
1425 *size = get_unaligned_be16(&cdb[8]);
1426 }
1427 break;
88455ec4 1428 default:
de103c93 1429 return TCM_UNSUPPORTED_SCSI_OPCODE;
88455ec4
CH
1430 }
1431
1432 return 0;
1433}
1434EXPORT_SYMBOL(spc_parse_cdb);