Pileus Git - ~andy/linux/blob - drivers/target/target_core_cdb.c

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