drivers/target/target_core_spc.c

   1 /*
   2  * SCSI Primary Commands (SPC) parsing and emulation.
   3  *
   4  * (c) Copyright 2002-2013 Datera, Inc.
   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
  27 #include <scsi/scsi_proto.h>
  28 #include <scsi/scsi_common.h>
  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"
  36 #include "target_core_alua.h"
  37 #include "target_core_pr.h"
  38 #include "target_core_ua.h"
  39 #include "target_core_xcopy.h"
  40
  41 static void spc_fill_alua_data(struct se_lun *lun, unsigned char *buf)
  42 {
  43         struct t10_alua_tg_pt_gp *tg_pt_gp;
  44
  45         /*
  46          * Set SCCS for MAINTENANCE_IN + REPORT_TARGET_PORT_GROUPS.
  47          */
  48         buf[5]  = 0x80;
  49
  50         /*
  51          * Set TPGS field for explicit and/or implicit ALUA access type
  52          * and opteration.
  53          *
  54          * See spc4r17 section 6.4.2 Table 135
  55          */
  56         spin_lock(&lun->lun_tg_pt_gp_lock);
  57         tg_pt_gp = lun->lun_tg_pt_gp;
  58         if (tg_pt_gp)
  59                 buf[5] |= tg_pt_gp->tg_pt_gp_alua_access_type;
  60         spin_unlock(&lun->lun_tg_pt_gp_lock);
  61 }
  62
  63 sense_reason_t
  64 spc_emulate_inquiry_std(struct se_cmd *cmd, unsigned char *buf)
  65 {
  66         struct se_lun *lun = cmd->se_lun;
  67         struct se_device *dev = cmd->se_dev;
  68         struct se_session *sess = cmd->se_sess;
  69
  70         /* Set RMB (removable media) for tape devices */
  71         if (dev->transport->get_device_type(dev) == TYPE_TAPE)
  72                 buf[1] = 0x80;
  73
  74         buf[2] = 0x05; /* SPC-3 */
  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          */
  91         spc_fill_alua_data(lun, buf);
  92
  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;
  98         /*
  99          * Set Protection (PROTECT) bit when DIF has been enabled on the
 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.
 103          */
 104         if (sess->sup_prot_ops & (TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS)) {
 105                 if (dev->dev_attrib.pi_prot_type || cmd->se_sess->sess_prot_type)
 106                         buf[5] |= 0x1;
 107         }
 108
 109         buf[7] = 0x2; /* CmdQue=1 */
 110
 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);
 118         memcpy(&buf[16], dev->t10_wwn.model,
 119                strnlen(dev->t10_wwn.model, 16));
 120         memcpy(&buf[32], dev->t10_wwn.revision,
 121                strnlen(dev->t10_wwn.revision, 4));
 122         buf[4] = 31; /* Set additional length to 31 */
 123
 124         return 0;
 125 }
 126 EXPORT_SYMBOL(spc_emulate_inquiry_std);
 127
 128 /* unit serial number */
 129 static sense_reason_t
 130 spc_emulate_evpd_80(struct se_cmd *cmd, unsigned char *buf)
 131 {
 132         struct se_device *dev = cmd->se_dev;
 133         u16 len;
 134
 135         if (dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL) {
 136                 len = sprintf(&buf[4], "%s", dev->t10_wwn.unit_serial);
 137                 len++; /* Extra Byte for NULL Terminator */
 138                 buf[3] = len;
 139         }
 140         return 0;
 141 }
 142
 143 void spc_parse_naa_6h_vendor_specific(struct se_device *dev,
 144                                       unsigned char *buf)
 145 {
 146         unsigned char *p = &dev->t10_wwn.unit_serial[0];
 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  */
 178 sense_reason_t
 179 spc_emulate_evpd_83(struct se_cmd *cmd, unsigned char *buf)
 180 {
 181         struct se_device *dev = cmd->se_dev;
 182         struct se_lun *lun = cmd->se_lun;
 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;
 186         unsigned char *prod = &dev->t10_wwn.model[0];
 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          */
 201         if (!(dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL))
 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
 239 check_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
 249         if (dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL) {
 250                 unit_serial_len = strlen(&dev->t10_wwn.unit_serial[0]);
 251                 unit_serial_len++; /* For NULL Terminator */
 252
 253                 id_len += sprintf(&buf[off+12], "%s:%s", prod,
 254                                 &dev->t10_wwn.unit_serial[0]);
 255         }
 256         buf[off] = 0x2; /* ASCII */
 257         buf[off+1] = 0x1; /* T10 Vendor ID */
 258         buf[off+2] = 0x0;
 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);
 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);
 269
 270         if (1) {
 271                 struct t10_alua_lu_gp *lu_gp;
 272                 u32 padding, scsi_name_len, scsi_target_len;
 273                 u16 lu_gp_id = 0;
 274                 u16 tg_pt_gp_id = 0;
 275                 u16 tpgt;
 276
 277                 tpg = lun->lun_tpg;
 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                  */
 285                 buf[off] = tpg->proto_id << 4;
 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;
 297                 buf[off++] = ((lun->lun_rtpi >> 8) & 0xff);
 298                 buf[off++] = (lun->lun_rtpi & 0xff);
 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                  */
 307                 spin_lock(&lun->lun_tg_pt_gp_lock);
 308                 tg_pt_gp = lun->lun_tg_pt_gp;
 309                 if (!tg_pt_gp) {
 310                         spin_unlock(&lun->lun_tg_pt_gp_lock);
 311                         goto check_lu_gp;
 312                 }
 313                 tg_pt_gp_id = tg_pt_gp->tg_pt_gp_id;
 314                 spin_unlock(&lun->lun_tg_pt_gp_lock);
 315
 316                 buf[off] = tpg->proto_id << 4;
 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 */
 326                 buf[off++] = ((tg_pt_gp_id >> 8) & 0xff);
 327                 buf[off++] = (tg_pt_gp_id & 0xff);
 328                 len += 8; /* Header size + Designation descriptor */
 329                 /*
 330                  * Logical Unit Group identifier, see spc4r17
 331                  * section 7.7.3.8
 332                  */
 333 check_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 */
 353                 buf[off++] = ((lu_gp_id >> 8) & 0xff);
 354                 buf[off++] = (lu_gp_id & 0xff);
 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                  */
 363 check_scsi_name:
 364                 buf[off] = tpg->proto_id << 4;
 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                  */
 390                 padding = ((-scsi_name_len) & 3);
 391                 if (padding)
 392                         scsi_name_len += padding;
 393                 if (scsi_name_len > 256)
 394                         scsi_name_len = 256;
 395
 396                 buf[off-1] = scsi_name_len;
 397                 off += scsi_name_len;
 398                 /* Header size + Designation descriptor */
 399                 len += (scsi_name_len + 4);
 400
 401                 /*
 402                  * Target device designator
 403                  */
 404                 buf[off] = tpg->proto_id << 4;
 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;
 432                 if (scsi_target_len > 256)
 433                         scsi_target_len = 256;
 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);
 440         }
 441         buf[2] = ((len >> 8) & 0xff);
 442         buf[3] = (len & 0xff); /* Page Length for VPD 0x83 */
 443         return 0;
 444 }
 445 EXPORT_SYMBOL(spc_emulate_evpd_83);
 446
 447 /* Extended INQUIRY Data VPD Page */
 448 static sense_reason_t
 449 spc_emulate_evpd_86(struct se_cmd *cmd, unsigned char *buf)
 450 {
 451         struct se_device *dev = cmd->se_dev;
 452         struct se_session *sess = cmd->se_sess;
 453
 454         buf[3] = 0x3c;
 455         /*
 456          * Set GRD_CHK + REF_CHK for TYPE1 protection, or GRD_CHK
 457          * only for TYPE3 protection.
 458          */
 459         if (sess->sup_prot_ops & (TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS)) {
 460                 if (dev->dev_attrib.pi_prot_type == TARGET_DIF_TYPE1_PROT ||
 461                     cmd->se_sess->sess_prot_type == TARGET_DIF_TYPE1_PROT)
 462                         buf[4] = 0x5;
 463                 else if (dev->dev_attrib.pi_prot_type == TARGET_DIF_TYPE3_PROT ||
 464                          cmd->se_sess->sess_prot_type == TARGET_DIF_TYPE3_PROT)
 465                         buf[4] = 0x4;
 466         }
 467
 468         /* logical unit supports type 1 and type 3 protection */
 469         if ((dev->transport->get_device_type(dev) == TYPE_DISK) &&
 470             (sess->sup_prot_ops & (TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS)) &&
 471             (dev->dev_attrib.pi_prot_type || cmd->se_sess->sess_prot_type)) {
 472                 buf[4] |= (0x3 << 3);
 473         }
 474
 475         /* Set HEADSUP, ORDSUP, SIMPSUP */
 476         buf[5] = 0x07;
 477
 478         /* If WriteCache emulation is enabled, set V_SUP */
 479         if (target_check_wce(dev))
 480                 buf[6] = 0x01;
 481         /* If an LBA map is present set R_SUP */
 482         spin_lock(&cmd->se_dev->t10_alua.lba_map_lock);
 483         if (!list_empty(&dev->t10_alua.lba_map_list))
 484                 buf[8] = 0x10;
 485         spin_unlock(&cmd->se_dev->t10_alua.lba_map_lock);
 486         return 0;
 487 }
 488
 489 /* Block Limits VPD page */
 490 static sense_reason_t
 491 spc_emulate_evpd_b0(struct se_cmd *cmd, unsigned char *buf)
 492 {
 493         struct se_device *dev = cmd->se_dev;
 494         u32 mtl = 0;
 495         int have_tp = 0, opt, min;
 496
 497         /*
 498          * Following spc3r22 section 6.5.3 Block Limits VPD page, when
 499          * emulate_tpu=1 or emulate_tpws=1 we will be expect a
 500          * different page length for Thin Provisioning.
 501          */
 502         if (dev->dev_attrib.emulate_tpu || dev->dev_attrib.emulate_tpws)
 503                 have_tp = 1;
 504
 505         buf[0] = dev->transport->get_device_type(dev);
 506         buf[3] = have_tp ? 0x3c : 0x10;
 507
 508         /* Set WSNZ to 1 */
 509         buf[4] = 0x01;
 510         /*
 511          * Set MAXIMUM COMPARE AND WRITE LENGTH
 512          */
 513         if (dev->dev_attrib.emulate_caw)
 514                 buf[5] = 0x01;
 515
 516         /*
 517          * Set OPTIMAL TRANSFER LENGTH GRANULARITY
 518          */
 519         if (dev->transport->get_io_min && (min = dev->transport->get_io_min(dev)))
 520                 put_unaligned_be16(min / dev->dev_attrib.block_size, &buf[6]);
 521         else
 522                 put_unaligned_be16(1, &buf[6]);
 523
 524         /*
 525          * Set MAXIMUM TRANSFER LENGTH
 526          *
 527          * XXX: Currently assumes single PAGE_SIZE per scatterlist for fabrics
 528          * enforcing maximum HW scatter-gather-list entry limit
 529          */
 530         if (cmd->se_tfo->max_data_sg_nents) {
 531                 mtl = (cmd->se_tfo->max_data_sg_nents * PAGE_SIZE) /
 532                        dev->dev_attrib.block_size;
 533         }
 534         put_unaligned_be32(min_not_zero(mtl, dev->dev_attrib.hw_max_sectors), &buf[8]);
 535
 536         /*
 537          * Set OPTIMAL TRANSFER LENGTH
 538          */
 539         if (dev->transport->get_io_opt && (opt = dev->transport->get_io_opt(dev)))
 540                 put_unaligned_be32(opt / dev->dev_attrib.block_size, &buf[12]);
 541         else
 542                 put_unaligned_be32(dev->dev_attrib.optimal_sectors, &buf[12]);
 543
 544         /*
 545          * Exit now if we don't support TP.
 546          */
 547         if (!have_tp)
 548                 goto max_write_same;
 549
 550         /*
 551          * Set MAXIMUM UNMAP LBA COUNT
 552          */
 553         put_unaligned_be32(dev->dev_attrib.max_unmap_lba_count, &buf[20]);
 554
 555         /*
 556          * Set MAXIMUM UNMAP BLOCK DESCRIPTOR COUNT
 557          */
 558         put_unaligned_be32(dev->dev_attrib.max_unmap_block_desc_count,
 559                            &buf[24]);
 560
 561         /*
 562          * Set OPTIMAL UNMAP GRANULARITY
 563          */
 564         put_unaligned_be32(dev->dev_attrib.unmap_granularity, &buf[28]);
 565
 566         /*
 567          * UNMAP GRANULARITY ALIGNMENT
 568          */
 569         put_unaligned_be32(dev->dev_attrib.unmap_granularity_alignment,
 570                            &buf[32]);
 571         if (dev->dev_attrib.unmap_granularity_alignment != 0)
 572                 buf[32] |= 0x80; /* Set the UGAVALID bit */
 573
 574         /*
 575          * MAXIMUM WRITE SAME LENGTH
 576          */
 577 max_write_same:
 578         put_unaligned_be64(dev->dev_attrib.max_write_same_len, &buf[36]);
 579
 580         return 0;
 581 }
 582
 583 /* Block Device Characteristics VPD page */
 584 static sense_reason_t
 585 spc_emulate_evpd_b1(struct se_cmd *cmd, unsigned char *buf)
 586 {
 587         struct se_device *dev = cmd->se_dev;
 588
 589         buf[0] = dev->transport->get_device_type(dev);
 590         buf[3] = 0x3c;
 591         buf[5] = dev->dev_attrib.is_nonrot ? 1 : 0;
 592
 593         return 0;
 594 }
 595
 596 /* Thin Provisioning VPD */
 597 static sense_reason_t
 598 spc_emulate_evpd_b2(struct se_cmd *cmd, unsigned char *buf)
 599 {
 600         struct se_device *dev = cmd->se_dev;
 601
 602         /*
 603          * From spc3r22 section 6.5.4 Thin Provisioning VPD page:
 604          *
 605          * The PAGE LENGTH field is defined in SPC-4. If the DP bit is set to
 606          * zero, then the page length shall be set to 0004h.  If the DP bit
 607          * is set to one, then the page length shall be set to the value
 608          * defined in table 162.
 609          */
 610         buf[0] = dev->transport->get_device_type(dev);
 611
 612         /*
 613          * Set Hardcoded length mentioned above for DP=0
 614          */
 615         put_unaligned_be16(0x0004, &buf[2]);
 616
 617         /*
 618          * The THRESHOLD EXPONENT field indicates the threshold set size in
 619          * LBAs as a power of 2 (i.e., the threshold set size is equal to
 620          * 2(threshold exponent)).
 621          *
 622          * Note that this is currently set to 0x00 as mkp says it will be
 623          * changing again.  We can enable this once it has settled in T10
 624          * and is actually used by Linux/SCSI ML code.
 625          */
 626         buf[4] = 0x00;
 627
 628         /*
 629          * A TPU bit set to one indicates that the device server supports
 630          * the UNMAP command (see 5.25). A TPU bit set to zero indicates
 631          * that the device server does not support the UNMAP command.
 632          */
 633         if (dev->dev_attrib.emulate_tpu != 0)
 634                 buf[5] = 0x80;
 635
 636         /*
 637          * A TPWS bit set to one indicates that the device server supports
 638          * the use of the WRITE SAME (16) command (see 5.42) to unmap LBAs.
 639          * A TPWS bit set to zero indicates that the device server does not
 640          * support the use of the WRITE SAME (16) command to unmap LBAs.
 641          */
 642         if (dev->dev_attrib.emulate_tpws != 0)
 643                 buf[5] |= 0x40 | 0x20;
 644
 645         /*
 646          * The unmap_zeroes_data set means that the underlying device supports
 647          * REQ_DISCARD and has the discard_zeroes_data bit set. This satisfies
 648          * the SBC requirements for LBPRZ, meaning that a subsequent read
 649          * will return zeroes after an UNMAP or WRITE SAME (16) to an LBA
 650          * See sbc4r36 6.6.4.
 651          */
 652         if (((dev->dev_attrib.emulate_tpu != 0) ||
 653              (dev->dev_attrib.emulate_tpws != 0)) &&
 654              (dev->dev_attrib.unmap_zeroes_data != 0))
 655                 buf[5] |= 0x04;
 656
 657         return 0;
 658 }
 659
 660 /* Referrals VPD page */
 661 static sense_reason_t
 662 spc_emulate_evpd_b3(struct se_cmd *cmd, unsigned char *buf)
 663 {
 664         struct se_device *dev = cmd->se_dev;
 665
 666         buf[0] = dev->transport->get_device_type(dev);
 667         buf[3] = 0x0c;
 668         put_unaligned_be32(dev->t10_alua.lba_map_segment_size, &buf[8]);
 669         put_unaligned_be32(dev->t10_alua.lba_map_segment_multiplier, &buf[12]);
 670
 671         return 0;
 672 }
 673
 674 static sense_reason_t
 675 spc_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf);
 676
 677 static struct {
 678         uint8_t         page;
 679         sense_reason_t  (*emulate)(struct se_cmd *, unsigned char *);
 680 } evpd_handlers[] = {
 681         { .page = 0x00, .emulate = spc_emulate_evpd_00 },
 682         { .page = 0x80, .emulate = spc_emulate_evpd_80 },
 683         { .page = 0x83, .emulate = spc_emulate_evpd_83 },
 684         { .page = 0x86, .emulate = spc_emulate_evpd_86 },
 685         { .page = 0xb0, .emulate = spc_emulate_evpd_b0 },
 686         { .page = 0xb1, .emulate = spc_emulate_evpd_b1 },
 687         { .page = 0xb2, .emulate = spc_emulate_evpd_b2 },
 688         { .page = 0xb3, .emulate = spc_emulate_evpd_b3 },
 689 };
 690
 691 /* supported vital product data pages */
 692 static sense_reason_t
 693 spc_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf)
 694 {
 695         int p;
 696
 697         /*
 698          * Only report the INQUIRY EVPD=1 pages after a valid NAA
 699          * Registered Extended LUN WWN has been set via ConfigFS
 700          * during device creation/restart.
 701          */
 702         if (cmd->se_dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL) {
 703                 buf[3] = ARRAY_SIZE(evpd_handlers);
 704                 for (p = 0; p < ARRAY_SIZE(evpd_handlers); ++p)
 705                         buf[p + 4] = evpd_handlers[p].page;
 706         }
 707
 708         return 0;
 709 }
 710
 711 static sense_reason_t
 712 spc_emulate_inquiry(struct se_cmd *cmd)
 713 {
 714         struct se_device *dev = cmd->se_dev;
 715         struct se_portal_group *tpg = cmd->se_lun->lun_tpg;
 716         unsigned char *rbuf;
 717         unsigned char *cdb = cmd->t_task_cdb;
 718         unsigned char *buf;
 719         sense_reason_t ret;
 720         int p;
 721         int len = 0;
 722
 723         buf = kzalloc(SE_INQUIRY_BUF, GFP_KERNEL);
 724         if (!buf) {
 725                 pr_err("Unable to allocate response buffer for INQUIRY\n");
 726                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
 727         }
 728
 729         if (dev == rcu_access_pointer(tpg->tpg_virt_lun0->lun_se_dev))
 730                 buf[0] = 0x3f; /* Not connected */
 731         else
 732                 buf[0] = dev->transport->get_device_type(dev);
 733
 734         if (!(cdb[1] & 0x1)) {
 735                 if (cdb[2]) {
 736                         pr_err("INQUIRY with EVPD==0 but PAGE CODE=%02x\n",
 737                                cdb[2]);
 738                         ret = TCM_INVALID_CDB_FIELD;
 739                         goto out;
 740                 }
 741
 742                 ret = spc_emulate_inquiry_std(cmd, buf);
 743                 len = buf[4] + 5;
 744                 goto out;
 745         }
 746
 747         for (p = 0; p < ARRAY_SIZE(evpd_handlers); ++p) {
 748                 if (cdb[2] == evpd_handlers[p].page) {
 749                         buf[1] = cdb[2];
 750                         ret = evpd_handlers[p].emulate(cmd, buf);
 751                         len = get_unaligned_be16(&buf[2]) + 4;
 752                         goto out;
 753                 }
 754         }
 755
 756         pr_err("Unknown VPD Code: 0x%02x\n", cdb[2]);
 757         ret = TCM_INVALID_CDB_FIELD;
 758
 759 out:
 760         rbuf = transport_kmap_data_sg(cmd);
 761         if (rbuf) {
 762                 memcpy(rbuf, buf, min_t(u32, SE_INQUIRY_BUF, cmd->data_length));
 763                 transport_kunmap_data_sg(cmd);
 764         }
 765         kfree(buf);
 766
 767         if (!ret)
 768                 target_complete_cmd_with_length(cmd, GOOD, len);
 769         return ret;
 770 }
 771
 772 static int spc_modesense_rwrecovery(struct se_cmd *cmd, u8 pc, u8 *p)
 773 {
 774         p[0] = 0x01;
 775         p[1] = 0x0a;
 776
 777         /* No changeable values for now */
 778         if (pc == 1)
 779                 goto out;
 780
 781 out:
 782         return 12;
 783 }
 784
 785 static int spc_modesense_control(struct se_cmd *cmd, u8 pc, u8 *p)
 786 {
 787         struct se_device *dev = cmd->se_dev;
 788         struct se_session *sess = cmd->se_sess;
 789
 790         p[0] = 0x0a;
 791         p[1] = 0x0a;
 792
 793         /* No changeable values for now */
 794         if (pc == 1)
 795                 goto out;
 796
 797         /* GLTSD: No implicit save of log parameters */
 798         p[2] = (1 << 1);
 799         if (target_sense_desc_format(dev))
 800                 /* D_SENSE: Descriptor format sense data for 64bit sectors */
 801                 p[2] |= (1 << 2);
 802
 803         /*
 804          * From spc4r23, 7.4.7 Control mode page
 805          *
 806          * The QUEUE ALGORITHM MODIFIER field (see table 368) specifies
 807          * restrictions on the algorithm used for reordering commands
 808          * having the SIMPLE task attribute (see SAM-4).
 809          *
 810          *                    Table 368 -- QUEUE ALGORITHM MODIFIER field
 811          *                         Code      Description
 812          *                          0h       Restricted reordering
 813          *                          1h       Unrestricted reordering allowed
 814          *                          2h to 7h    Reserved
 815          *                          8h to Fh    Vendor specific
 816          *
 817          * A value of zero in the QUEUE ALGORITHM MODIFIER field specifies that
 818          * the device server shall order the processing sequence of commands
 819          * having the SIMPLE task attribute such that data integrity is maintained
 820          * for that I_T nexus (i.e., if the transmission of new SCSI transport protocol
 821          * requests is halted at any time, the final value of all data observable
 822          * on the medium shall be the same as if all the commands had been processed
 823          * with the ORDERED task attribute).
 824          *
 825          * A value of one in the QUEUE ALGORITHM MODIFIER field specifies that the
 826          * device server may reorder the processing sequence of commands having the
 827          * SIMPLE task attribute in any manner. Any data integrity exposures related to
 828          * command sequence order shall be explicitly handled by the application client
 829          * through the selection of appropriate ommands and task attributes.
 830          */
 831         p[3] = (dev->dev_attrib.emulate_rest_reord == 1) ? 0x00 : 0x10;
 832         /*
 833          * From spc4r17, section 7.4.6 Control mode Page
 834          *
 835          * Unit Attention interlocks control (UN_INTLCK_CTRL) to code 00b
 836          *
 837          * 00b: The logical unit shall clear any unit attention condition
 838          * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
 839          * status and shall not establish a unit attention condition when a com-
 840          * mand is completed with BUSY, TASK SET FULL, or RESERVATION CONFLICT
 841          * status.
 842          *
 843          * 10b: The logical unit shall not clear any unit attention condition
 844          * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
 845          * status and shall not establish a unit attention condition when
 846          * a command is completed with BUSY, TASK SET FULL, or RESERVATION
 847          * CONFLICT status.
 848          *
 849          * 11b a The logical unit shall not clear any unit attention condition
 850          * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
 851          * status and shall establish a unit attention condition for the
 852          * initiator port associated with the I_T nexus on which the BUSY,
 853          * TASK SET FULL, or RESERVATION CONFLICT status is being returned.
 854          * Depending on the status, the additional sense code shall be set to
 855          * PREVIOUS BUSY STATUS, PREVIOUS TASK SET FULL STATUS, or PREVIOUS
 856          * RESERVATION CONFLICT STATUS. Until it is cleared by a REQUEST SENSE
 857          * command, a unit attention condition shall be established only once
 858          * for a BUSY, TASK SET FULL, or RESERVATION CONFLICT status regardless
 859          * to the number of commands completed with one of those status codes.
 860          */
 861         p[4] = (dev->dev_attrib.emulate_ua_intlck_ctrl == 2) ? 0x30 :
 862                (dev->dev_attrib.emulate_ua_intlck_ctrl == 1) ? 0x20 : 0x00;
 863         /*
 864          * From spc4r17, section 7.4.6 Control mode Page
 865          *
 866          * Task Aborted Status (TAS) bit set to zero.
 867          *
 868          * A task aborted status (TAS) bit set to zero specifies that aborted
 869          * tasks shall be terminated by the device server without any response
 870          * to the application client. A TAS bit set to one specifies that tasks
 871          * aborted by the actions of an I_T nexus other than the I_T nexus on
 872          * which the command was received shall be completed with TASK ABORTED
 873          * status (see SAM-4).
 874          */
 875         p[5] = (dev->dev_attrib.emulate_tas) ? 0x40 : 0x00;
 876         /*
 877          * From spc4r30, section 7.5.7 Control mode page
 878          *
 879          * Application Tag Owner (ATO) bit set to one.
 880          *
 881          * If the ATO bit is set to one the device server shall not modify the
 882          * LOGICAL BLOCK APPLICATION TAG field and, depending on the protection
 883          * type, shall not modify the contents of the LOGICAL BLOCK REFERENCE
 884          * TAG field.
 885          */
 886         if (sess->sup_prot_ops & (TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS)) {
 887                 if (dev->dev_attrib.pi_prot_type || sess->sess_prot_type)
 888                         p[5] |= 0x80;
 889         }
 890
 891         p[8] = 0xff;
 892         p[9] = 0xff;
 893         p[11] = 30;
 894
 895 out:
 896         return 12;
 897 }
 898
 899 static int spc_modesense_caching(struct se_cmd *cmd, u8 pc, u8 *p)
 900 {
 901         struct se_device *dev = cmd->se_dev;
 902
 903         p[0] = 0x08;
 904         p[1] = 0x12;
 905
 906         /* No changeable values for now */
 907         if (pc == 1)
 908                 goto out;
 909
 910         if (target_check_wce(dev))
 911                 p[2] = 0x04; /* Write Cache Enable */
 912         p[12] = 0x20; /* Disabled Read Ahead */
 913
 914 out:
 915         return 20;
 916 }
 917
 918 static int spc_modesense_informational_exceptions(struct se_cmd *cmd, u8 pc, unsigned char *p)
 919 {
 920         p[0] = 0x1c;
 921         p[1] = 0x0a;
 922
 923         /* No changeable values for now */
 924         if (pc == 1)
 925                 goto out;
 926
 927 out:
 928         return 12;
 929 }
 930
 931 static struct {
 932         uint8_t         page;
 933         uint8_t         subpage;
 934         int             (*emulate)(struct se_cmd *, u8, unsigned char *);
 935 } modesense_handlers[] = {
 936         { .page = 0x01, .subpage = 0x00, .emulate = spc_modesense_rwrecovery },
 937         { .page = 0x08, .subpage = 0x00, .emulate = spc_modesense_caching },
 938         { .page = 0x0a, .subpage = 0x00, .emulate = spc_modesense_control },
 939         { .page = 0x1c, .subpage = 0x00, .emulate = spc_modesense_informational_exceptions },
 940 };
 941
 942 static void spc_modesense_write_protect(unsigned char *buf, int type)
 943 {
 944         /*
 945          * I believe that the WP bit (bit 7) in the mode header is the same for
 946          * all device types..
 947          */
 948         switch (type) {
 949         case TYPE_DISK:
 950         case TYPE_TAPE:
 951         default:
 952                 buf[0] |= 0x80; /* WP bit */
 953                 break;
 954         }
 955 }
 956
 957 static void spc_modesense_dpofua(unsigned char *buf, int type)
 958 {
 959         switch (type) {
 960         case TYPE_DISK:
 961                 buf[0] |= 0x10; /* DPOFUA bit */
 962                 break;
 963         default:
 964                 break;
 965         }
 966 }
 967
 968 static int spc_modesense_blockdesc(unsigned char *buf, u64 blocks, u32 block_size)
 969 {
 970         *buf++ = 8;
 971         put_unaligned_be32(min(blocks, 0xffffffffull), buf);
 972         buf += 4;
 973         put_unaligned_be32(block_size, buf);
 974         return 9;
 975 }
 976
 977 static int spc_modesense_long_blockdesc(unsigned char *buf, u64 blocks, u32 block_size)
 978 {
 979         if (blocks <= 0xffffffff)
 980                 return spc_modesense_blockdesc(buf + 3, blocks, block_size) + 3;
 981
 982         *buf++ = 1;             /* LONGLBA */
 983         buf += 2;
 984         *buf++ = 16;
 985         put_unaligned_be64(blocks, buf);
 986         buf += 12;
 987         put_unaligned_be32(block_size, buf);
 988
 989         return 17;
 990 }
 991
 992 static sense_reason_t spc_emulate_modesense(struct se_cmd *cmd)
 993 {
 994         struct se_device *dev = cmd->se_dev;
 995         char *cdb = cmd->t_task_cdb;
 996         unsigned char buf[SE_MODE_PAGE_BUF], *rbuf;
 997         int type = dev->transport->get_device_type(dev);
 998         int ten = (cmd->t_task_cdb[0] == MODE_SENSE_10);
 999         bool dbd = !!(cdb[1] & 0x08);
1000         bool llba = ten ? !!(cdb[1] & 0x10) : false;
1001         u8 pc = cdb[2] >> 6;
1002         u8 page = cdb[2] & 0x3f;
1003         u8 subpage = cdb[3];
1004         int length = 0;
1005         int ret;
1006         int i;
1007
1008         memset(buf, 0, SE_MODE_PAGE_BUF);
1009
1010         /*
1011          * Skip over MODE DATA LENGTH + MEDIUM TYPE fields to byte 3 for
1012          * MODE_SENSE_10 and byte 2 for MODE_SENSE (6).
1013          */
1014         length = ten ? 3 : 2;
1015
1016         /* DEVICE-SPECIFIC PARAMETER */
1017         if (cmd->se_lun->lun_access_ro || target_lun_is_rdonly(cmd))
1018                 spc_modesense_write_protect(&buf[length], type);
1019
1020         /*
1021          * SBC only allows us to enable FUA and DPO together.  Fortunately
1022          * DPO is explicitly specified as a hint, so a noop is a perfectly
1023          * valid implementation.
1024          */
1025         if (target_check_fua(dev))
1026                 spc_modesense_dpofua(&buf[length], type);
1027
1028         ++length;
1029
1030         /* BLOCK DESCRIPTOR */
1031
1032         /*
1033          * For now we only include a block descriptor for disk (SBC)
1034          * devices; other command sets use a slightly different format.
1035          */
1036         if (!dbd && type == TYPE_DISK) {
1037                 u64 blocks = dev->transport->get_blocks(dev);
1038                 u32 block_size = dev->dev_attrib.block_size;
1039
1040                 if (ten) {
1041                         if (llba) {
1042                                 length += spc_modesense_long_blockdesc(&buf[length],
1043                                                                        blocks, block_size);
1044                         } else {
1045                                 length += 3;
1046                                 length += spc_modesense_blockdesc(&buf[length],
1047                                                                   blocks, block_size);
1048                         }
1049                 } else {
1050                         length += spc_modesense_blockdesc(&buf[length], blocks,
1051                                                           block_size);
1052                 }
1053         } else {
1054                 if (ten)
1055                         length += 4;
1056                 else
1057                         length += 1;
1058         }
1059
1060         if (page == 0x3f) {
1061                 if (subpage != 0x00 && subpage != 0xff) {
1062                         pr_warn("MODE_SENSE: Invalid subpage code: 0x%02x\n", subpage);
1063                         return TCM_INVALID_CDB_FIELD;
1064                 }
1065
1066                 for (i = 0; i < ARRAY_SIZE(modesense_handlers); ++i) {
1067                         /*
1068                          * Tricky way to say all subpage 00h for
1069                          * subpage==0, all subpages for subpage==0xff
1070                          * (and we just checked above that those are
1071                          * the only two possibilities).
1072                          */
1073                         if ((modesense_handlers[i].subpage & ~subpage) == 0) {
1074                                 ret = modesense_handlers[i].emulate(cmd, pc, &buf[length]);
1075                                 if (!ten && length + ret >= 255)
1076                                         break;
1077                                 length += ret;
1078                         }
1079                 }
1080
1081                 goto set_length;
1082         }
1083
1084         for (i = 0; i < ARRAY_SIZE(modesense_handlers); ++i)
1085                 if (modesense_handlers[i].page == page &&
1086                     modesense_handlers[i].subpage == subpage) {
1087                         length += modesense_handlers[i].emulate(cmd, pc, &buf[length]);
1088                         goto set_length;
1089                 }
1090
1091         /*
1092          * We don't intend to implement:
1093          *  - obsolete page 03h "format parameters" (checked by Solaris)
1094          */
1095         if (page != 0x03)
1096                 pr_err("MODE SENSE: unimplemented page/subpage: 0x%02x/0x%02x\n",
1097                        page, subpage);
1098
1099         return TCM_UNKNOWN_MODE_PAGE;
1100
1101 set_length:
1102         if (ten)
1103                 put_unaligned_be16(length - 2, buf);
1104         else
1105                 buf[0] = length - 1;
1106
1107         rbuf = transport_kmap_data_sg(cmd);
1108         if (rbuf) {
1109                 memcpy(rbuf, buf, min_t(u32, SE_MODE_PAGE_BUF, cmd->data_length));
1110                 transport_kunmap_data_sg(cmd);
1111         }
1112
1113         target_complete_cmd_with_length(cmd, GOOD, length);
1114         return 0;
1115 }
1116
1117 static sense_reason_t spc_emulate_modeselect(struct se_cmd *cmd)
1118 {
1119         char *cdb = cmd->t_task_cdb;
1120         bool ten = cdb[0] == MODE_SELECT_10;
1121         int off = ten ? 8 : 4;
1122         bool pf = !!(cdb[1] & 0x10);
1123         u8 page, subpage;
1124         unsigned char *buf;
1125         unsigned char tbuf[SE_MODE_PAGE_BUF];
1126         int length;
1127         sense_reason_t ret = 0;
1128         int i;
1129
1130         if (!cmd->data_length) {
1131                 target_complete_cmd(cmd, GOOD);
1132                 return 0;
1133         }
1134
1135         if (cmd->data_length < off + 2)
1136                 return TCM_PARAMETER_LIST_LENGTH_ERROR;
1137
1138         buf = transport_kmap_data_sg(cmd);
1139         if (!buf)
1140                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1141
1142         if (!pf) {
1143                 ret = TCM_INVALID_CDB_FIELD;
1144                 goto out;
1145         }
1146
1147         page = buf[off] & 0x3f;
1148         subpage = buf[off] & 0x40 ? buf[off + 1] : 0;
1149
1150         for (i = 0; i < ARRAY_SIZE(modesense_handlers); ++i)
1151                 if (modesense_handlers[i].page == page &&
1152                     modesense_handlers[i].subpage == subpage) {
1153                         memset(tbuf, 0, SE_MODE_PAGE_BUF);
1154                         length = modesense_handlers[i].emulate(cmd, 0, tbuf);
1155                         goto check_contents;
1156                 }
1157
1158         ret = TCM_UNKNOWN_MODE_PAGE;
1159         goto out;
1160
1161 check_contents:
1162         if (cmd->data_length < off + length) {
1163                 ret = TCM_PARAMETER_LIST_LENGTH_ERROR;
1164                 goto out;
1165         }
1166
1167         if (memcmp(buf + off, tbuf, length))
1168                 ret = TCM_INVALID_PARAMETER_LIST;
1169
1170 out:
1171         transport_kunmap_data_sg(cmd);
1172
1173         if (!ret)
1174                 target_complete_cmd(cmd, GOOD);
1175         return ret;
1176 }
1177
1178 static sense_reason_t spc_emulate_request_sense(struct se_cmd *cmd)
1179 {
1180         unsigned char *cdb = cmd->t_task_cdb;
1181         unsigned char *rbuf;
1182         u8 ua_asc = 0, ua_ascq = 0;
1183         unsigned char buf[SE_SENSE_BUF];
1184         bool desc_format = target_sense_desc_format(cmd->se_dev);
1185
1186         memset(buf, 0, SE_SENSE_BUF);
1187
1188         if (cdb[1] & 0x01) {
1189                 pr_err("REQUEST_SENSE description emulation not"
1190                         " supported\n");
1191                 return TCM_INVALID_CDB_FIELD;
1192         }
1193
1194         rbuf = transport_kmap_data_sg(cmd);
1195         if (!rbuf)
1196                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1197
1198         if (!core_scsi3_ua_clear_for_request_sense(cmd, &ua_asc, &ua_ascq))
1199                 scsi_build_sense_buffer(desc_format, buf, UNIT_ATTENTION,
1200                                         ua_asc, ua_ascq);
1201         else
1202                 scsi_build_sense_buffer(desc_format, buf, NO_SENSE, 0x0, 0x0);
1203
1204         memcpy(rbuf, buf, min_t(u32, sizeof(buf), cmd->data_length));
1205         transport_kunmap_data_sg(cmd);
1206
1207         target_complete_cmd(cmd, GOOD);
1208         return 0;
1209 }
1210
1211 sense_reason_t spc_emulate_report_luns(struct se_cmd *cmd)
1212 {
1213         struct se_dev_entry *deve;
1214         struct se_session *sess = cmd->se_sess;
1215         struct se_node_acl *nacl;
1216         struct scsi_lun slun;
1217         unsigned char *buf;
1218         u32 lun_count = 0, offset = 8;
1219         __be32 len;
1220
1221         buf = transport_kmap_data_sg(cmd);
1222         if (cmd->data_length && !buf)
1223                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1224
1225         /*
1226          * If no struct se_session pointer is present, this struct se_cmd is
1227          * coming via a target_core_mod PASSTHROUGH op, and not through
1228          * a $FABRIC_MOD.  In that case, report LUN=0 only.
1229          */
1230         if (!sess)
1231                 goto done;
1232
1233         nacl = sess->se_node_acl;
1234
1235         rcu_read_lock();
1236         hlist_for_each_entry_rcu(deve, &nacl->lun_entry_hlist, link) {
1237                 /*
1238                  * We determine the correct LUN LIST LENGTH even once we
1239                  * have reached the initial allocation length.
1240                  * See SPC2-R20 7.19.
1241                  */
1242                 lun_count++;
1243                 if (offset >= cmd->data_length)
1244                         continue;
1245
1246                 int_to_scsilun(deve->mapped_lun, &slun);
1247                 memcpy(buf + offset, &slun,
1248                        min(8u, cmd->data_length - offset));
1249                 offset += 8;
1250         }
1251         rcu_read_unlock();
1252
1253         /*
1254          * See SPC3 r07, page 159.
1255          */
1256 done:
1257         /*
1258          * If no LUNs are accessible, report virtual LUN 0.
1259          */
1260         if (lun_count == 0) {
1261                 int_to_scsilun(0, &slun);
1262                 if (cmd->data_length > 8)
1263                         memcpy(buf + offset, &slun,
1264                                min(8u, cmd->data_length - offset));
1265                 lun_count = 1;
1266         }
1267
1268         if (buf) {
1269                 len = cpu_to_be32(lun_count * 8);
1270                 memcpy(buf, &len, min_t(int, sizeof len, cmd->data_length));
1271                 transport_kunmap_data_sg(cmd);
1272         }
1273
1274         target_complete_cmd_with_length(cmd, GOOD, 8 + lun_count * 8);
1275         return 0;
1276 }
1277 EXPORT_SYMBOL(spc_emulate_report_luns);
1278
1279 static sense_reason_t
1280 spc_emulate_testunitready(struct se_cmd *cmd)
1281 {
1282         target_complete_cmd(cmd, GOOD);
1283         return 0;
1284 }
1285
1286 sense_reason_t
1287 spc_parse_cdb(struct se_cmd *cmd, unsigned int *size)
1288 {
1289         struct se_device *dev = cmd->se_dev;
1290         unsigned char *cdb = cmd->t_task_cdb;
1291
1292         switch (cdb[0]) {
1293         case MODE_SELECT:
1294                 *size = cdb[4];
1295                 cmd->execute_cmd = spc_emulate_modeselect;
1296                 break;
1297         case MODE_SELECT_10:
1298                 *size = (cdb[7] << 8) + cdb[8];
1299                 cmd->execute_cmd = spc_emulate_modeselect;
1300                 break;
1301         case MODE_SENSE:
1302                 *size = cdb[4];
1303                 cmd->execute_cmd = spc_emulate_modesense;
1304                 break;
1305         case MODE_SENSE_10:
1306                 *size = (cdb[7] << 8) + cdb[8];
1307                 cmd->execute_cmd = spc_emulate_modesense;
1308                 break;
1309         case LOG_SELECT:
1310         case LOG_SENSE:
1311                 *size = (cdb[7] << 8) + cdb[8];
1312                 break;
1313         case PERSISTENT_RESERVE_IN:
1314                 *size = (cdb[7] << 8) + cdb[8];
1315                 cmd->execute_cmd = target_scsi3_emulate_pr_in;
1316                 break;
1317         case PERSISTENT_RESERVE_OUT:
1318                 *size = (cdb[7] << 8) + cdb[8];
1319                 cmd->execute_cmd = target_scsi3_emulate_pr_out;
1320                 break;
1321         case RELEASE:
1322         case RELEASE_10:
1323                 if (cdb[0] == RELEASE_10)
1324                         *size = (cdb[7] << 8) | cdb[8];
1325                 else
1326                         *size = cmd->data_length;
1327
1328                 cmd->execute_cmd = target_scsi2_reservation_release;
1329                 break;
1330         case RESERVE:
1331         case RESERVE_10:
1332                 /*
1333                  * The SPC-2 RESERVE does not contain a size in the SCSI CDB.
1334                  * Assume the passthrough or $FABRIC_MOD will tell us about it.
1335                  */
1336                 if (cdb[0] == RESERVE_10)
1337                         *size = (cdb[7] << 8) | cdb[8];
1338                 else
1339                         *size = cmd->data_length;
1340
1341                 cmd->execute_cmd = target_scsi2_reservation_reserve;
1342                 break;
1343         case REQUEST_SENSE:
1344                 *size = cdb[4];
1345                 cmd->execute_cmd = spc_emulate_request_sense;
1346                 break;
1347         case INQUIRY:
1348                 *size = (cdb[3] << 8) + cdb[4];
1349
1350                 /*
1351                  * Do implicit HEAD_OF_QUEUE processing for INQUIRY.
1352                  * See spc4r17 section 5.3
1353                  */
1354                 cmd->sam_task_attr = TCM_HEAD_TAG;
1355                 cmd->execute_cmd = spc_emulate_inquiry;
1356                 break;
1357         case SECURITY_PROTOCOL_IN:
1358         case SECURITY_PROTOCOL_OUT:
1359                 *size = (cdb[6] << 24) | (cdb[7] << 16) | (cdb[8] << 8) | cdb[9];
1360                 break;
1361         case EXTENDED_COPY:
1362                 *size = get_unaligned_be32(&cdb[10]);
1363                 cmd->execute_cmd = target_do_xcopy;
1364                 break;
1365         case RECEIVE_COPY_RESULTS:
1366                 *size = get_unaligned_be32(&cdb[10]);
1367                 cmd->execute_cmd = target_do_receive_copy_results;
1368                 break;
1369         case READ_ATTRIBUTE:
1370         case WRITE_ATTRIBUTE:
1371                 *size = (cdb[10] << 24) | (cdb[11] << 16) |
1372                        (cdb[12] << 8) | cdb[13];
1373                 break;
1374         case RECEIVE_DIAGNOSTIC:
1375         case SEND_DIAGNOSTIC:
1376                 *size = (cdb[3] << 8) | cdb[4];
1377                 break;
1378         case WRITE_BUFFER:
1379                 *size = (cdb[6] << 16) + (cdb[7] << 8) + cdb[8];
1380                 break;
1381         case REPORT_LUNS:
1382                 cmd->execute_cmd = spc_emulate_report_luns;
1383                 *size = (cdb[6] << 24) | (cdb[7] << 16) | (cdb[8] << 8) | cdb[9];
1384                 /*
1385                  * Do implicit HEAD_OF_QUEUE processing for REPORT_LUNS
1386                  * See spc4r17 section 5.3
1387                  */
1388                 cmd->sam_task_attr = TCM_HEAD_TAG;
1389                 break;
1390         case TEST_UNIT_READY:
1391                 cmd->execute_cmd = spc_emulate_testunitready;
1392                 *size = 0;
1393                 break;
1394         case MAINTENANCE_IN:
1395                 if (dev->transport->get_device_type(dev) != TYPE_ROM) {
1396                         /*
1397                          * MAINTENANCE_IN from SCC-2
1398                          * Check for emulated MI_REPORT_TARGET_PGS
1399                          */
1400                         if ((cdb[1] & 0x1f) == MI_REPORT_TARGET_PGS) {
1401                                 cmd->execute_cmd =
1402                                         target_emulate_report_target_port_groups;
1403                         }
1404                         *size = get_unaligned_be32(&cdb[6]);
1405                 } else {
1406                         /*
1407                          * GPCMD_SEND_KEY from multi media commands
1408                          */
1409                         *size = get_unaligned_be16(&cdb[8]);
1410                 }
1411                 break;
1412         case MAINTENANCE_OUT:
1413                 if (dev->transport->get_device_type(dev) != TYPE_ROM) {
1414                         /*
1415                          * MAINTENANCE_OUT from SCC-2
1416                          * Check for emulated MO_SET_TARGET_PGS.
1417                          */
1418                         if (cdb[1] == MO_SET_TARGET_PGS) {
1419                                 cmd->execute_cmd =
1420                                         target_emulate_set_target_port_groups;
1421                         }
1422                         *size = get_unaligned_be32(&cdb[6]);
1423                 } else {
1424                         /*
1425                          * GPCMD_SEND_KEY from multi media commands
1426                          */
1427                         *size = get_unaligned_be16(&cdb[8]);
1428                 }
1429                 break;
1430         default:
1431                 return TCM_UNSUPPORTED_SCSI_OPCODE;
1432         }
1433
1434         return 0;
1435 }
1436 EXPORT_SYMBOL(spc_parse_cdb);