drivers/block/nvme-scsi.c

   1 /*
   2  * NVM Express device driver
   3  * Copyright (c) 2011, Intel Corporation.
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms and conditions of the GNU General Public License,
   7  * version 2, as published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  12  * more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along with
  15  * this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
  17  */
  18
  19 /*
  20  * Refer to the SCSI-NVMe Translation spec for details on how
  21  * each command is translated.
  22  */
  23
  24 #include <linux/nvme.h>
  25 #include <linux/bio.h>
  26 #include <linux/bitops.h>
  27 #include <linux/blkdev.h>
  28 #include <linux/delay.h>
  29 #include <linux/errno.h>
  30 #include <linux/fs.h>
  31 #include <linux/genhd.h>
  32 #include <linux/idr.h>
  33 #include <linux/init.h>
  34 #include <linux/interrupt.h>
  35 #include <linux/io.h>
  36 #include <linux/kdev_t.h>
  37 #include <linux/kthread.h>
  38 #include <linux/kernel.h>
  39 #include <linux/mm.h>
  40 #include <linux/module.h>
  41 #include <linux/moduleparam.h>
  42 #include <linux/pci.h>
  43 #include <linux/poison.h>
  44 #include <linux/sched.h>
  45 #include <linux/slab.h>
  46 #include <linux/types.h>
  47 #include <linux/version.h>
  48 #include <scsi/sg.h>
  49 #include <scsi/scsi.h>
  50
  51
  52 static int sg_version_num = 30534;      /* 2 digits for each component */
  53
  54 #define SNTI_TRANSLATION_SUCCESS                        0
  55 #define SNTI_INTERNAL_ERROR                             1
  56
  57 /* VPD Page Codes */
  58 #define VPD_SUPPORTED_PAGES                             0x00
  59 #define VPD_SERIAL_NUMBER                               0x80
  60 #define VPD_DEVICE_IDENTIFIERS                          0x83
  61 #define VPD_EXTENDED_INQUIRY                            0x86
  62 #define VPD_BLOCK_DEV_CHARACTERISTICS                   0xB1
  63
  64 /* CDB offsets */
  65 #define REPORT_LUNS_CDB_ALLOC_LENGTH_OFFSET             6
  66 #define REPORT_LUNS_SR_OFFSET                           2
  67 #define READ_CAP_16_CDB_ALLOC_LENGTH_OFFSET             10
  68 #define REQUEST_SENSE_CDB_ALLOC_LENGTH_OFFSET           4
  69 #define REQUEST_SENSE_DESC_OFFSET                       1
  70 #define REQUEST_SENSE_DESC_MASK                         0x01
  71 #define DESCRIPTOR_FORMAT_SENSE_DATA_TYPE               1
  72 #define INQUIRY_EVPD_BYTE_OFFSET                        1
  73 #define INQUIRY_PAGE_CODE_BYTE_OFFSET                   2
  74 #define INQUIRY_EVPD_BIT_MASK                           1
  75 #define INQUIRY_CDB_ALLOCATION_LENGTH_OFFSET            3
  76 #define START_STOP_UNIT_CDB_IMMED_OFFSET                1
  77 #define START_STOP_UNIT_CDB_IMMED_MASK                  0x1
  78 #define START_STOP_UNIT_CDB_POWER_COND_MOD_OFFSET       3
  79 #define START_STOP_UNIT_CDB_POWER_COND_MOD_MASK         0xF
  80 #define START_STOP_UNIT_CDB_POWER_COND_OFFSET           4
  81 #define START_STOP_UNIT_CDB_POWER_COND_MASK             0xF0
  82 #define START_STOP_UNIT_CDB_NO_FLUSH_OFFSET             4
  83 #define START_STOP_UNIT_CDB_NO_FLUSH_MASK               0x4
  84 #define START_STOP_UNIT_CDB_START_OFFSET                4
  85 #define START_STOP_UNIT_CDB_START_MASK                  0x1
  86 #define WRITE_BUFFER_CDB_MODE_OFFSET                    1
  87 #define WRITE_BUFFER_CDB_MODE_MASK                      0x1F
  88 #define WRITE_BUFFER_CDB_BUFFER_ID_OFFSET               2
  89 #define WRITE_BUFFER_CDB_BUFFER_OFFSET_OFFSET           3
  90 #define WRITE_BUFFER_CDB_PARM_LIST_LENGTH_OFFSET        6
  91 #define FORMAT_UNIT_CDB_FORMAT_PROT_INFO_OFFSET         1
  92 #define FORMAT_UNIT_CDB_FORMAT_PROT_INFO_MASK           0xC0
  93 #define FORMAT_UNIT_CDB_FORMAT_PROT_INFO_SHIFT          6
  94 #define FORMAT_UNIT_CDB_LONG_LIST_OFFSET                1
  95 #define FORMAT_UNIT_CDB_LONG_LIST_MASK                  0x20
  96 #define FORMAT_UNIT_CDB_FORMAT_DATA_OFFSET              1
  97 #define FORMAT_UNIT_CDB_FORMAT_DATA_MASK                0x10
  98 #define FORMAT_UNIT_SHORT_PARM_LIST_LEN                 4
  99 #define FORMAT_UNIT_LONG_PARM_LIST_LEN                  8
 100 #define FORMAT_UNIT_PROT_INT_OFFSET                     3
 101 #define FORMAT_UNIT_PROT_FIELD_USAGE_OFFSET             0
 102 #define FORMAT_UNIT_PROT_FIELD_USAGE_MASK               0x07
 103 #define UNMAP_CDB_PARAM_LIST_LENGTH_OFFSET              7
 104
 105 /* Misc. defines */
 106 #define NIBBLE_SHIFT                                    4
 107 #define FIXED_SENSE_DATA                                0x70
 108 #define DESC_FORMAT_SENSE_DATA                          0x72
 109 #define FIXED_SENSE_DATA_ADD_LENGTH                     10
 110 #define LUN_ENTRY_SIZE                                  8
 111 #define LUN_DATA_HEADER_SIZE                            8
 112 #define ALL_LUNS_RETURNED                               0x02
 113 #define ALL_WELL_KNOWN_LUNS_RETURNED                    0x01
 114 #define RESTRICTED_LUNS_RETURNED                        0x00
 115 #define NVME_POWER_STATE_START_VALID                    0x00
 116 #define NVME_POWER_STATE_ACTIVE                         0x01
 117 #define NVME_POWER_STATE_IDLE                           0x02
 118 #define NVME_POWER_STATE_STANDBY                        0x03
 119 #define NVME_POWER_STATE_LU_CONTROL                     0x07
 120 #define POWER_STATE_0                                   0
 121 #define POWER_STATE_1                                   1
 122 #define POWER_STATE_2                                   2
 123 #define POWER_STATE_3                                   3
 124 #define DOWNLOAD_SAVE_ACTIVATE                          0x05
 125 #define DOWNLOAD_SAVE_DEFER_ACTIVATE                    0x0E
 126 #define ACTIVATE_DEFERRED_MICROCODE                     0x0F
 127 #define FORMAT_UNIT_IMMED_MASK                          0x2
 128 #define FORMAT_UNIT_IMMED_OFFSET                        1
 129 #define KELVIN_TEMP_FACTOR                              273
 130 #define FIXED_FMT_SENSE_DATA_SIZE                       18
 131 #define DESC_FMT_SENSE_DATA_SIZE                        8
 132
 133 /* SCSI/NVMe defines and bit masks */
 134 #define INQ_STANDARD_INQUIRY_PAGE                       0x00
 135 #define INQ_SUPPORTED_VPD_PAGES_PAGE                    0x00
 136 #define INQ_UNIT_SERIAL_NUMBER_PAGE                     0x80
 137 #define INQ_DEVICE_IDENTIFICATION_PAGE                  0x83
 138 #define INQ_EXTENDED_INQUIRY_DATA_PAGE                  0x86
 139 #define INQ_BDEV_CHARACTERISTICS_PAGE                   0xB1
 140 #define INQ_SERIAL_NUMBER_LENGTH                        0x14
 141 #define INQ_NUM_SUPPORTED_VPD_PAGES                     5
 142 #define VERSION_SPC_4                                   0x06
 143 #define ACA_UNSUPPORTED                                 0
 144 #define STANDARD_INQUIRY_LENGTH                         36
 145 #define ADDITIONAL_STD_INQ_LENGTH                       31
 146 #define EXTENDED_INQUIRY_DATA_PAGE_LENGTH               0x3C
 147 #define RESERVED_FIELD                                  0
 148
 149 /* SCSI READ/WRITE Defines */
 150 #define IO_CDB_WP_MASK                                  0xE0
 151 #define IO_CDB_WP_SHIFT                                 5
 152 #define IO_CDB_FUA_MASK                                 0x8
 153 #define IO_6_CDB_LBA_OFFSET                             0
 154 #define IO_6_CDB_LBA_MASK                               0x001FFFFF
 155 #define IO_6_CDB_TX_LEN_OFFSET                          4
 156 #define IO_6_DEFAULT_TX_LEN                             256
 157 #define IO_10_CDB_LBA_OFFSET                            2
 158 #define IO_10_CDB_TX_LEN_OFFSET                         7
 159 #define IO_10_CDB_WP_OFFSET                             1
 160 #define IO_10_CDB_FUA_OFFSET                            1
 161 #define IO_12_CDB_LBA_OFFSET                            2
 162 #define IO_12_CDB_TX_LEN_OFFSET                         6
 163 #define IO_12_CDB_WP_OFFSET                             1
 164 #define IO_12_CDB_FUA_OFFSET                            1
 165 #define IO_16_CDB_FUA_OFFSET                            1
 166 #define IO_16_CDB_WP_OFFSET                             1
 167 #define IO_16_CDB_LBA_OFFSET                            2
 168 #define IO_16_CDB_TX_LEN_OFFSET                         10
 169
 170 /* Mode Sense/Select defines */
 171 #define MODE_PAGE_INFO_EXCEP                            0x1C
 172 #define MODE_PAGE_CACHING                               0x08
 173 #define MODE_PAGE_CONTROL                               0x0A
 174 #define MODE_PAGE_POWER_CONDITION                       0x1A
 175 #define MODE_PAGE_RETURN_ALL                            0x3F
 176 #define MODE_PAGE_BLK_DES_LEN                           0x08
 177 #define MODE_PAGE_LLBAA_BLK_DES_LEN                     0x10
 178 #define MODE_PAGE_CACHING_LEN                           0x14
 179 #define MODE_PAGE_CONTROL_LEN                           0x0C
 180 #define MODE_PAGE_POW_CND_LEN                           0x28
 181 #define MODE_PAGE_INF_EXC_LEN                           0x0C
 182 #define MODE_PAGE_ALL_LEN                               0x54
 183 #define MODE_SENSE6_MPH_SIZE                            4
 184 #define MODE_SENSE6_ALLOC_LEN_OFFSET                    4
 185 #define MODE_SENSE_PAGE_CONTROL_OFFSET                  2
 186 #define MODE_SENSE_PAGE_CONTROL_MASK                    0xC0
 187 #define MODE_SENSE_PAGE_CODE_OFFSET                     2
 188 #define MODE_SENSE_PAGE_CODE_MASK                       0x3F
 189 #define MODE_SENSE_LLBAA_OFFSET                         1
 190 #define MODE_SENSE_LLBAA_MASK                           0x10
 191 #define MODE_SENSE_LLBAA_SHIFT                          4
 192 #define MODE_SENSE_DBD_OFFSET                           1
 193 #define MODE_SENSE_DBD_MASK                             8
 194 #define MODE_SENSE_DBD_SHIFT                            3
 195 #define MODE_SENSE10_MPH_SIZE                           8
 196 #define MODE_SENSE10_ALLOC_LEN_OFFSET                   7
 197 #define MODE_SELECT_CDB_PAGE_FORMAT_OFFSET              1
 198 #define MODE_SELECT_CDB_SAVE_PAGES_OFFSET               1
 199 #define MODE_SELECT_6_CDB_PARAM_LIST_LENGTH_OFFSET      4
 200 #define MODE_SELECT_10_CDB_PARAM_LIST_LENGTH_OFFSET     7
 201 #define MODE_SELECT_CDB_PAGE_FORMAT_MASK                0x10
 202 #define MODE_SELECT_CDB_SAVE_PAGES_MASK                 0x1
 203 #define MODE_SELECT_6_BD_OFFSET                         3
 204 #define MODE_SELECT_10_BD_OFFSET                        6
 205 #define MODE_SELECT_10_LLBAA_OFFSET                     4
 206 #define MODE_SELECT_10_LLBAA_MASK                       1
 207 #define MODE_SELECT_6_MPH_SIZE                          4
 208 #define MODE_SELECT_10_MPH_SIZE                         8
 209 #define CACHING_MODE_PAGE_WCE_MASK                      0x04
 210 #define MODE_SENSE_BLK_DESC_ENABLED                     0
 211 #define MODE_SENSE_BLK_DESC_COUNT                       1
 212 #define MODE_SELECT_PAGE_CODE_MASK                      0x3F
 213 #define SHORT_DESC_BLOCK                                8
 214 #define LONG_DESC_BLOCK                                 16
 215 #define MODE_PAGE_POW_CND_LEN_FIELD                     0x26
 216 #define MODE_PAGE_INF_EXC_LEN_FIELD                     0x0A
 217 #define MODE_PAGE_CACHING_LEN_FIELD                     0x12
 218 #define MODE_PAGE_CONTROL_LEN_FIELD                     0x0A
 219 #define MODE_SENSE_PC_CURRENT_VALUES                    0
 220
 221 /* Log Sense defines */
 222 #define LOG_PAGE_SUPPORTED_LOG_PAGES_PAGE               0x00
 223 #define LOG_PAGE_SUPPORTED_LOG_PAGES_LENGTH             0x07
 224 #define LOG_PAGE_INFORMATIONAL_EXCEPTIONS_PAGE          0x2F
 225 #define LOG_PAGE_TEMPERATURE_PAGE                       0x0D
 226 #define LOG_SENSE_CDB_SP_OFFSET                         1
 227 #define LOG_SENSE_CDB_SP_NOT_ENABLED                    0
 228 #define LOG_SENSE_CDB_PC_OFFSET                         2
 229 #define LOG_SENSE_CDB_PC_MASK                           0xC0
 230 #define LOG_SENSE_CDB_PC_SHIFT                          6
 231 #define LOG_SENSE_CDB_PC_CUMULATIVE_VALUES              1
 232 #define LOG_SENSE_CDB_PAGE_CODE_MASK                    0x3F
 233 #define LOG_SENSE_CDB_ALLOC_LENGTH_OFFSET               7
 234 #define REMAINING_INFO_EXCP_PAGE_LENGTH                 0x8
 235 #define LOG_INFO_EXCP_PAGE_LENGTH                       0xC
 236 #define REMAINING_TEMP_PAGE_LENGTH                      0xC
 237 #define LOG_TEMP_PAGE_LENGTH                            0x10
 238 #define LOG_TEMP_UNKNOWN                                0xFF
 239 #define SUPPORTED_LOG_PAGES_PAGE_LENGTH                 0x3
 240
 241 /* Read Capacity defines */
 242 #define READ_CAP_10_RESP_SIZE                           8
 243 #define READ_CAP_16_RESP_SIZE                           32
 244
 245 /* NVMe Namespace and Command Defines */
 246 #define NVME_GET_SMART_LOG_PAGE                         0x02
 247 #define NVME_GET_FEAT_TEMP_THRESH                       0x04
 248 #define BYTES_TO_DWORDS                                 4
 249 #define NVME_MAX_FIRMWARE_SLOT                          7
 250
 251 /* Report LUNs defines */
 252 #define REPORT_LUNS_FIRST_LUN_OFFSET                    8
 253
 254 /* SCSI ADDITIONAL SENSE Codes */
 255
 256 #define SCSI_ASC_NO_SENSE                               0x00
 257 #define SCSI_ASC_PERIPHERAL_DEV_WRITE_FAULT             0x03
 258 #define SCSI_ASC_LUN_NOT_READY                          0x04
 259 #define SCSI_ASC_WARNING                                0x0B
 260 #define SCSI_ASC_LOG_BLOCK_GUARD_CHECK_FAILED           0x10
 261 #define SCSI_ASC_LOG_BLOCK_APPTAG_CHECK_FAILED          0x10
 262 #define SCSI_ASC_LOG_BLOCK_REFTAG_CHECK_FAILED          0x10
 263 #define SCSI_ASC_UNRECOVERED_READ_ERROR                 0x11
 264 #define SCSI_ASC_MISCOMPARE_DURING_VERIFY               0x1D
 265 #define SCSI_ASC_ACCESS_DENIED_INVALID_LUN_ID           0x20
 266 #define SCSI_ASC_ILLEGAL_COMMAND                        0x20
 267 #define SCSI_ASC_ILLEGAL_BLOCK                          0x21
 268 #define SCSI_ASC_INVALID_CDB                            0x24
 269 #define SCSI_ASC_INVALID_LUN                            0x25
 270 #define SCSI_ASC_INVALID_PARAMETER                      0x26
 271 #define SCSI_ASC_FORMAT_COMMAND_FAILED                  0x31
 272 #define SCSI_ASC_INTERNAL_TARGET_FAILURE                0x44
 273
 274 /* SCSI ADDITIONAL SENSE Code Qualifiers */
 275
 276 #define SCSI_ASCQ_CAUSE_NOT_REPORTABLE                  0x00
 277 #define SCSI_ASCQ_FORMAT_COMMAND_FAILED                 0x01
 278 #define SCSI_ASCQ_LOG_BLOCK_GUARD_CHECK_FAILED          0x01
 279 #define SCSI_ASCQ_LOG_BLOCK_APPTAG_CHECK_FAILED         0x02
 280 #define SCSI_ASCQ_LOG_BLOCK_REFTAG_CHECK_FAILED         0x03
 281 #define SCSI_ASCQ_FORMAT_IN_PROGRESS                    0x04
 282 #define SCSI_ASCQ_POWER_LOSS_EXPECTED                   0x08
 283 #define SCSI_ASCQ_INVALID_LUN_ID                        0x09
 284
 285 /**
 286  * DEVICE_SPECIFIC_PARAMETER in mode parameter header (see sbc2r16) to
 287  * enable DPOFUA support type 0x10 value.
 288  */
 289 #define DEVICE_SPECIFIC_PARAMETER                       0
 290 #define VPD_ID_DESCRIPTOR_LENGTH sizeof(VPD_IDENTIFICATION_DESCRIPTOR)
 291
 292 /* MACROs to extract information from CDBs */
 293
 294 #define GET_OPCODE(cdb)         cdb[0]
 295
 296 #define GET_U8_FROM_CDB(cdb, index) (cdb[index] << 0)
 297
 298 #define GET_U16_FROM_CDB(cdb, index) ((cdb[index] << 8) | (cdb[index + 1] << 0))
 299
 300 #define GET_U24_FROM_CDB(cdb, index) ((cdb[index] << 16) | \
 301 (cdb[index + 1] <<  8) | \
 302 (cdb[index + 2] <<  0))
 303
 304 #define GET_U32_FROM_CDB(cdb, index) ((cdb[index] << 24) | \
 305 (cdb[index + 1] << 16) | \
 306 (cdb[index + 2] <<  8) | \
 307 (cdb[index + 3] <<  0))
 308
 309 #define GET_U64_FROM_CDB(cdb, index) ((((u64)cdb[index]) << 56) | \
 310 (((u64)cdb[index + 1]) << 48) | \
 311 (((u64)cdb[index + 2]) << 40) | \
 312 (((u64)cdb[index + 3]) << 32) | \
 313 (((u64)cdb[index + 4]) << 24) | \
 314 (((u64)cdb[index + 5]) << 16) | \
 315 (((u64)cdb[index + 6]) <<  8) | \
 316 (((u64)cdb[index + 7]) <<  0))
 317
 318 /* Inquiry Helper Macros */
 319 #define GET_INQ_EVPD_BIT(cdb) \
 320 ((GET_U8_FROM_CDB(cdb, INQUIRY_EVPD_BYTE_OFFSET) &              \
 321 INQUIRY_EVPD_BIT_MASK) ? 1 : 0)
 322
 323 #define GET_INQ_PAGE_CODE(cdb)                                  \
 324 (GET_U8_FROM_CDB(cdb, INQUIRY_PAGE_CODE_BYTE_OFFSET))
 325
 326 #define GET_INQ_ALLOC_LENGTH(cdb)                               \
 327 (GET_U16_FROM_CDB(cdb, INQUIRY_CDB_ALLOCATION_LENGTH_OFFSET))
 328
 329 /* Report LUNs Helper Macros */
 330 #define GET_REPORT_LUNS_ALLOC_LENGTH(cdb)                       \
 331 (GET_U32_FROM_CDB(cdb, REPORT_LUNS_CDB_ALLOC_LENGTH_OFFSET))
 332
 333 /* Read Capacity Helper Macros */
 334 #define GET_READ_CAP_16_ALLOC_LENGTH(cdb)                       \
 335 (GET_U32_FROM_CDB(cdb, READ_CAP_16_CDB_ALLOC_LENGTH_OFFSET))
 336
 337 #define IS_READ_CAP_16(cdb)                                     \
 338 ((cdb[0] == SERVICE_ACTION_IN && cdb[1] == SAI_READ_CAPACITY_16) ? 1 : 0)
 339
 340 /* Request Sense Helper Macros */
 341 #define GET_REQUEST_SENSE_ALLOC_LENGTH(cdb)                     \
 342 (GET_U8_FROM_CDB(cdb, REQUEST_SENSE_CDB_ALLOC_LENGTH_OFFSET))
 343
 344 /* Mode Sense Helper Macros */
 345 #define GET_MODE_SENSE_DBD(cdb)                                 \
 346 ((GET_U8_FROM_CDB(cdb, MODE_SENSE_DBD_OFFSET) & MODE_SENSE_DBD_MASK) >> \
 347 MODE_SENSE_DBD_SHIFT)
 348
 349 #define GET_MODE_SENSE_LLBAA(cdb)                               \
 350 ((GET_U8_FROM_CDB(cdb, MODE_SENSE_LLBAA_OFFSET) &               \
 351 MODE_SENSE_LLBAA_MASK) >> MODE_SENSE_LLBAA_SHIFT)
 352
 353 #define GET_MODE_SENSE_MPH_SIZE(cdb10)                          \
 354 (cdb10 ? MODE_SENSE10_MPH_SIZE : MODE_SENSE6_MPH_SIZE)
 355
 356
 357 /* Struct to gather data that needs to be extracted from a SCSI CDB.
 358    Not conforming to any particular CDB variant, but compatible with all. */
 359
 360 struct nvme_trans_io_cdb {
 361         u8 fua;
 362         u8 prot_info;
 363         u64 lba;
 364         u32 xfer_len;
 365 };
 366
 367
 368 /* Internal Helper Functions */
 369
 370
 371 /* Copy data to userspace memory */
 372
 373 static int nvme_trans_copy_to_user(struct sg_io_hdr *hdr, void *from,
 374                                                                 unsigned long n)
 375 {
 376         int res = SNTI_TRANSLATION_SUCCESS;
 377         unsigned long not_copied;
 378         int i;
 379         void *index = from;
 380         size_t remaining = n;
 381         size_t xfer_len;
 382
 383         if (hdr->iovec_count > 0) {
 384                 struct sg_iovec sgl;
 385
 386                 for (i = 0; i < hdr->iovec_count; i++) {
 387                         not_copied = copy_from_user(&sgl, hdr->dxferp +
 388                                                 i * sizeof(struct sg_iovec),
 389                                                 sizeof(struct sg_iovec));
 390                         if (not_copied)
 391                                 return -EFAULT;
 392                         xfer_len = min(remaining, sgl.iov_len);
 393                         not_copied = copy_to_user(sgl.iov_base, index,
 394                                                                 xfer_len);
 395                         if (not_copied) {
 396                                 res = -EFAULT;
 397                                 break;
 398                         }
 399                         index += xfer_len;
 400                         remaining -= xfer_len;
 401                         if (remaining == 0)
 402                                 break;
 403                 }
 404                 return res;
 405         }
 406         not_copied = copy_to_user(hdr->dxferp, from, n);
 407         if (not_copied)
 408                 res = -EFAULT;
 409         return res;
 410 }
 411
 412 /* Copy data from userspace memory */
 413
 414 static int nvme_trans_copy_from_user(struct sg_io_hdr *hdr, void *to,
 415                                                                 unsigned long n)
 416 {
 417         int res = SNTI_TRANSLATION_SUCCESS;
 418         unsigned long not_copied;
 419         int i;
 420         void *index = to;
 421         size_t remaining = n;
 422         size_t xfer_len;
 423
 424         if (hdr->iovec_count > 0) {
 425                 struct sg_iovec sgl;
 426
 427                 for (i = 0; i < hdr->iovec_count; i++) {
 428                         not_copied = copy_from_user(&sgl, hdr->dxferp +
 429                                                 i * sizeof(struct sg_iovec),
 430                                                 sizeof(struct sg_iovec));
 431                         if (not_copied)
 432                                 return -EFAULT;
 433                         xfer_len = min(remaining, sgl.iov_len);
 434                         not_copied = copy_from_user(index, sgl.iov_base,
 435                                                                 xfer_len);
 436                         if (not_copied) {
 437                                 res = -EFAULT;
 438                                 break;
 439                         }
 440                         index += xfer_len;
 441                         remaining -= xfer_len;
 442                         if (remaining == 0)
 443                                 break;
 444                 }
 445                 return res;
 446         }
 447
 448         not_copied = copy_from_user(to, hdr->dxferp, n);
 449         if (not_copied)
 450                 res = -EFAULT;
 451         return res;
 452 }
 453
 454 /* Status/Sense Buffer Writeback */
 455
 456 static int nvme_trans_completion(struct sg_io_hdr *hdr, u8 status, u8 sense_key,
 457                                  u8 asc, u8 ascq)
 458 {
 459         int res = SNTI_TRANSLATION_SUCCESS;
 460         u8 xfer_len;
 461         u8 resp[DESC_FMT_SENSE_DATA_SIZE];
 462
 463         if (scsi_status_is_good(status)) {
 464                 hdr->status = SAM_STAT_GOOD;
 465                 hdr->masked_status = GOOD;
 466                 hdr->host_status = DID_OK;
 467                 hdr->driver_status = DRIVER_OK;
 468                 hdr->sb_len_wr = 0;
 469         } else {
 470                 hdr->status = status;
 471                 hdr->masked_status = status >> 1;
 472                 hdr->host_status = DID_OK;
 473                 hdr->driver_status = DRIVER_OK;
 474
 475                 memset(resp, 0, DESC_FMT_SENSE_DATA_SIZE);
 476                 resp[0] = DESC_FORMAT_SENSE_DATA;
 477                 resp[1] = sense_key;
 478                 resp[2] = asc;
 479                 resp[3] = ascq;
 480
 481                 xfer_len = min_t(u8, hdr->mx_sb_len, DESC_FMT_SENSE_DATA_SIZE);
 482                 hdr->sb_len_wr = xfer_len;
 483                 if (copy_to_user(hdr->sbp, resp, xfer_len) > 0)
 484                         res = -EFAULT;
 485         }
 486
 487         return res;
 488 }
 489
 490 static int nvme_trans_status_code(struct sg_io_hdr *hdr, int nvme_sc)
 491 {
 492         u8 status, sense_key, asc, ascq;
 493         int res = SNTI_TRANSLATION_SUCCESS;
 494
 495         /* For non-nvme (Linux) errors, simply return the error code */
 496         if (nvme_sc < 0)
 497                 return nvme_sc;
 498
 499         /* Mask DNR, More, and reserved fields */
 500         nvme_sc &= 0x7FF;
 501
 502         switch (nvme_sc) {
 503         /* Generic Command Status */
 504         case NVME_SC_SUCCESS:
 505                 status = SAM_STAT_GOOD;
 506                 sense_key = NO_SENSE;
 507                 asc = SCSI_ASC_NO_SENSE;
 508                 ascq = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
 509                 break;
 510         case NVME_SC_INVALID_OPCODE:
 511                 status = SAM_STAT_CHECK_CONDITION;
 512                 sense_key = ILLEGAL_REQUEST;
 513                 asc = SCSI_ASC_ILLEGAL_COMMAND;
 514                 ascq = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
 515                 break;
 516         case NVME_SC_INVALID_FIELD:
 517                 status = SAM_STAT_CHECK_CONDITION;
 518                 sense_key = ILLEGAL_REQUEST;
 519                 asc = SCSI_ASC_INVALID_CDB;
 520                 ascq = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
 521                 break;
 522         case NVME_SC_DATA_XFER_ERROR:
 523                 status = SAM_STAT_CHECK_CONDITION;
 524                 sense_key = MEDIUM_ERROR;
 525                 asc = SCSI_ASC_NO_SENSE;
 526                 ascq = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
 527                 break;
 528         case NVME_SC_POWER_LOSS:
 529                 status = SAM_STAT_TASK_ABORTED;
 530                 sense_key = ABORTED_COMMAND;
 531                 asc = SCSI_ASC_WARNING;
 532                 ascq = SCSI_ASCQ_POWER_LOSS_EXPECTED;
 533                 break;
 534         case NVME_SC_INTERNAL:
 535                 status = SAM_STAT_CHECK_CONDITION;
 536                 sense_key = HARDWARE_ERROR;
 537                 asc = SCSI_ASC_INTERNAL_TARGET_FAILURE;
 538                 ascq = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
 539                 break;
 540         case NVME_SC_ABORT_REQ:
 541                 status = SAM_STAT_TASK_ABORTED;
 542                 sense_key = ABORTED_COMMAND;
 543                 asc = SCSI_ASC_NO_SENSE;
 544                 ascq = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
 545                 break;
 546         case NVME_SC_ABORT_QUEUE:
 547                 status = SAM_STAT_TASK_ABORTED;
 548                 sense_key = ABORTED_COMMAND;
 549                 asc = SCSI_ASC_NO_SENSE;
 550                 ascq = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
 551                 break;
 552         case NVME_SC_FUSED_FAIL:
 553                 status = SAM_STAT_TASK_ABORTED;
 554                 sense_key = ABORTED_COMMAND;
 555                 asc = SCSI_ASC_NO_SENSE;
 556                 ascq = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
 557                 break;
 558         case NVME_SC_FUSED_MISSING:
 559                 status = SAM_STAT_TASK_ABORTED;
 560                 sense_key = ABORTED_COMMAND;
 561                 asc = SCSI_ASC_NO_SENSE;
 562                 ascq = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
 563                 break;
 564         case NVME_SC_INVALID_NS:
 565                 status = SAM_STAT_CHECK_CONDITION;
 566                 sense_key = ILLEGAL_REQUEST;
 567                 asc = SCSI_ASC_ACCESS_DENIED_INVALID_LUN_ID;
 568                 ascq = SCSI_ASCQ_INVALID_LUN_ID;
 569                 break;
 570         case NVME_SC_LBA_RANGE:
 571                 status = SAM_STAT_CHECK_CONDITION;
 572                 sense_key = ILLEGAL_REQUEST;
 573                 asc = SCSI_ASC_ILLEGAL_BLOCK;
 574                 ascq = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
 575                 break;
 576         case NVME_SC_CAP_EXCEEDED:
 577                 status = SAM_STAT_CHECK_CONDITION;
 578                 sense_key = MEDIUM_ERROR;
 579                 asc = SCSI_ASC_NO_SENSE;
 580                 ascq = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
 581                 break;
 582         case NVME_SC_NS_NOT_READY:
 583                 status = SAM_STAT_CHECK_CONDITION;
 584                 sense_key = NOT_READY;
 585                 asc = SCSI_ASC_LUN_NOT_READY;
 586                 ascq = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
 587                 break;
 588
 589         /* Command Specific Status */
 590         case NVME_SC_INVALID_FORMAT:
 591                 status = SAM_STAT_CHECK_CONDITION;
 592                 sense_key = ILLEGAL_REQUEST;
 593                 asc = SCSI_ASC_FORMAT_COMMAND_FAILED;
 594                 ascq = SCSI_ASCQ_FORMAT_COMMAND_FAILED;
 595                 break;
 596         case NVME_SC_BAD_ATTRIBUTES:
 597                 status = SAM_STAT_CHECK_CONDITION;
 598                 sense_key = ILLEGAL_REQUEST;
 599                 asc = SCSI_ASC_INVALID_CDB;
 600                 ascq = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
 601                 break;
 602
 603         /* Media Errors */
 604         case NVME_SC_WRITE_FAULT:
 605                 status = SAM_STAT_CHECK_CONDITION;
 606                 sense_key = MEDIUM_ERROR;
 607                 asc = SCSI_ASC_PERIPHERAL_DEV_WRITE_FAULT;
 608                 ascq = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
 609                 break;
 610         case NVME_SC_READ_ERROR:
 611                 status = SAM_STAT_CHECK_CONDITION;
 612                 sense_key = MEDIUM_ERROR;
 613                 asc = SCSI_ASC_UNRECOVERED_READ_ERROR;
 614                 ascq = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
 615                 break;
 616         case NVME_SC_GUARD_CHECK:
 617                 status = SAM_STAT_CHECK_CONDITION;
 618                 sense_key = MEDIUM_ERROR;
 619                 asc = SCSI_ASC_LOG_BLOCK_GUARD_CHECK_FAILED;
 620                 ascq = SCSI_ASCQ_LOG_BLOCK_GUARD_CHECK_FAILED;
 621                 break;
 622         case NVME_SC_APPTAG_CHECK:
 623                 status = SAM_STAT_CHECK_CONDITION;
 624                 sense_key = MEDIUM_ERROR;
 625                 asc = SCSI_ASC_LOG_BLOCK_APPTAG_CHECK_FAILED;
 626                 ascq = SCSI_ASCQ_LOG_BLOCK_APPTAG_CHECK_FAILED;
 627                 break;
 628         case NVME_SC_REFTAG_CHECK:
 629                 status = SAM_STAT_CHECK_CONDITION;
 630                 sense_key = MEDIUM_ERROR;
 631                 asc = SCSI_ASC_LOG_BLOCK_REFTAG_CHECK_FAILED;
 632                 ascq = SCSI_ASCQ_LOG_BLOCK_REFTAG_CHECK_FAILED;
 633                 break;
 634         case NVME_SC_COMPARE_FAILED:
 635                 status = SAM_STAT_CHECK_CONDITION;
 636                 sense_key = MISCOMPARE;
 637                 asc = SCSI_ASC_MISCOMPARE_DURING_VERIFY;
 638                 ascq = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
 639                 break;
 640         case NVME_SC_ACCESS_DENIED:
 641                 status = SAM_STAT_CHECK_CONDITION;
 642                 sense_key = ILLEGAL_REQUEST;
 643                 asc = SCSI_ASC_ACCESS_DENIED_INVALID_LUN_ID;
 644                 ascq = SCSI_ASCQ_INVALID_LUN_ID;
 645                 break;
 646
 647         /* Unspecified/Default */
 648         case NVME_SC_CMDID_CONFLICT:
 649         case NVME_SC_CMD_SEQ_ERROR:
 650         case NVME_SC_CQ_INVALID:
 651         case NVME_SC_QID_INVALID:
 652         case NVME_SC_QUEUE_SIZE:
 653         case NVME_SC_ABORT_LIMIT:
 654         case NVME_SC_ABORT_MISSING:
 655         case NVME_SC_ASYNC_LIMIT:
 656         case NVME_SC_FIRMWARE_SLOT:
 657         case NVME_SC_FIRMWARE_IMAGE:
 658         case NVME_SC_INVALID_VECTOR:
 659         case NVME_SC_INVALID_LOG_PAGE:
 660         default:
 661                 status = SAM_STAT_CHECK_CONDITION;
 662                 sense_key = ILLEGAL_REQUEST;
 663                 asc = SCSI_ASC_NO_SENSE;
 664                 ascq = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
 665                 break;
 666         }
 667
 668         res = nvme_trans_completion(hdr, status, sense_key, asc, ascq);
 669
 670         return res;
 671 }
 672
 673 /* INQUIRY Helper Functions */
 674
 675 static int nvme_trans_standard_inquiry_page(struct nvme_ns *ns,
 676                                         struct sg_io_hdr *hdr, u8 *inq_response,
 677                                         int alloc_len)
 678 {
 679         struct nvme_dev *dev = ns->dev;
 680         dma_addr_t dma_addr;
 681         void *mem;
 682         struct nvme_id_ns *id_ns;
 683         int res = SNTI_TRANSLATION_SUCCESS;
 684         int nvme_sc;
 685         int xfer_len;
 686         u8 resp_data_format = 0x02;
 687         u8 protect;
 688         u8 cmdque = 0x01 << 1;
 689
 690         mem = dma_alloc_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ns),
 691                                 &dma_addr, GFP_KERNEL);
 692         if (mem == NULL) {
 693                 res = -ENOMEM;
 694                 goto out_dma;
 695         }
 696
 697         /* nvme ns identify - use DPS value for PROTECT field */
 698         nvme_sc = nvme_identify(dev, ns->ns_id, 0, dma_addr);
 699         res = nvme_trans_status_code(hdr, nvme_sc);
 700         /*
 701          * If nvme_sc was -ve, res will be -ve here.
 702          * If nvme_sc was +ve, the status would bace been translated, and res
 703          *  can only be 0 or -ve.
 704          *    - If 0 && nvme_sc > 0, then go into next if where res gets nvme_sc
 705          *    - If -ve, return because its a Linux error.
 706          */
 707         if (res)
 708                 goto out_free;
 709         if (nvme_sc) {
 710                 res = nvme_sc;
 711                 goto out_free;
 712         }
 713         id_ns = mem;
 714         (id_ns->dps) ? (protect = 0x01) : (protect = 0);
 715
 716         memset(inq_response, 0, STANDARD_INQUIRY_LENGTH);
 717         inq_response[2] = VERSION_SPC_4;
 718         inq_response[3] = resp_data_format;     /*normaca=0 | hisup=0 */
 719         inq_response[4] = ADDITIONAL_STD_INQ_LENGTH;
 720         inq_response[5] = protect;      /* sccs=0 | acc=0 | tpgs=0 | pc3=0 */
 721         inq_response[7] = cmdque;       /* wbus16=0 | sync=0 | vs=0 */
 722         strncpy(&inq_response[8], "NVMe    ", 8);
 723         strncpy(&inq_response[16], dev->model, 16);
 724         strncpy(&inq_response[32], dev->firmware_rev, 4);
 725
 726         xfer_len = min(alloc_len, STANDARD_INQUIRY_LENGTH);
 727         res = nvme_trans_copy_to_user(hdr, inq_response, xfer_len);
 728
 729  out_free:
 730         dma_free_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ns), mem,
 731                           dma_addr);
 732  out_dma:
 733         return res;
 734 }
 735
 736 static int nvme_trans_supported_vpd_pages(struct nvme_ns *ns,
 737                                         struct sg_io_hdr *hdr, u8 *inq_response,
 738                                         int alloc_len)
 739 {
 740         int res = SNTI_TRANSLATION_SUCCESS;
 741         int xfer_len;
 742
 743         memset(inq_response, 0, STANDARD_INQUIRY_LENGTH);
 744         inq_response[1] = INQ_SUPPORTED_VPD_PAGES_PAGE;   /* Page Code */
 745         inq_response[3] = INQ_NUM_SUPPORTED_VPD_PAGES;    /* Page Length */
 746         inq_response[4] = INQ_SUPPORTED_VPD_PAGES_PAGE;
 747         inq_response[5] = INQ_UNIT_SERIAL_NUMBER_PAGE;
 748         inq_response[6] = INQ_DEVICE_IDENTIFICATION_PAGE;
 749         inq_response[7] = INQ_EXTENDED_INQUIRY_DATA_PAGE;
 750         inq_response[8] = INQ_BDEV_CHARACTERISTICS_PAGE;
 751
 752         xfer_len = min(alloc_len, STANDARD_INQUIRY_LENGTH);
 753         res = nvme_trans_copy_to_user(hdr, inq_response, xfer_len);
 754
 755         return res;
 756 }
 757
 758 static int nvme_trans_unit_serial_page(struct nvme_ns *ns,
 759                                         struct sg_io_hdr *hdr, u8 *inq_response,
 760                                         int alloc_len)
 761 {
 762         struct nvme_dev *dev = ns->dev;
 763         int res = SNTI_TRANSLATION_SUCCESS;
 764         int xfer_len;
 765
 766         memset(inq_response, 0, STANDARD_INQUIRY_LENGTH);
 767         inq_response[1] = INQ_UNIT_SERIAL_NUMBER_PAGE; /* Page Code */
 768         inq_response[3] = INQ_SERIAL_NUMBER_LENGTH;    /* Page Length */
 769         strncpy(&inq_response[4], dev->serial, INQ_SERIAL_NUMBER_LENGTH);
 770
 771         xfer_len = min(alloc_len, STANDARD_INQUIRY_LENGTH);
 772         res = nvme_trans_copy_to_user(hdr, inq_response, xfer_len);
 773
 774         return res;
 775 }
 776
 777 static int nvme_trans_device_id_page(struct nvme_ns *ns, struct sg_io_hdr *hdr,
 778                                         u8 *inq_response, int alloc_len)
 779 {
 780         struct nvme_dev *dev = ns->dev;
 781         dma_addr_t dma_addr;
 782         void *mem;
 783         struct nvme_id_ctrl *id_ctrl;
 784         int res = SNTI_TRANSLATION_SUCCESS;
 785         int nvme_sc;
 786         u8 ieee[4];
 787         int xfer_len;
 788         __be32 tmp_id = cpu_to_be32(ns->ns_id);
 789
 790         mem = dma_alloc_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ns),
 791                                         &dma_addr, GFP_KERNEL);
 792         if (mem == NULL) {
 793                 res = -ENOMEM;
 794                 goto out_dma;
 795         }
 796
 797         /* nvme controller identify */
 798         nvme_sc = nvme_identify(dev, 0, 1, dma_addr);
 799         res = nvme_trans_status_code(hdr, nvme_sc);
 800         if (res)
 801                 goto out_free;
 802         if (nvme_sc) {
 803                 res = nvme_sc;
 804                 goto out_free;
 805         }
 806         id_ctrl = mem;
 807
 808         /* Since SCSI tried to save 4 bits... [SPC-4(r34) Table 591] */
 809         ieee[0] = id_ctrl->ieee[0] << 4;
 810         ieee[1] = id_ctrl->ieee[0] >> 4 | id_ctrl->ieee[1] << 4;
 811         ieee[2] = id_ctrl->ieee[1] >> 4 | id_ctrl->ieee[2] << 4;
 812         ieee[3] = id_ctrl->ieee[2] >> 4;
 813
 814         memset(inq_response, 0, STANDARD_INQUIRY_LENGTH);
 815         inq_response[1] = INQ_DEVICE_IDENTIFICATION_PAGE;    /* Page Code */
 816         inq_response[3] = 20;      /* Page Length */
 817         /* Designation Descriptor start */
 818         inq_response[4] = 0x01;    /* Proto ID=0h | Code set=1h */
 819         inq_response[5] = 0x03;    /* PIV=0b | Asso=00b | Designator Type=3h */
 820         inq_response[6] = 0x00;    /* Rsvd */
 821         inq_response[7] = 16;      /* Designator Length */
 822         /* Designator start */
 823         inq_response[8] = 0x60 | ieee[3]; /* NAA=6h | IEEE ID MSB, High nibble*/
 824         inq_response[9] = ieee[2];        /* IEEE ID */
 825         inq_response[10] = ieee[1];       /* IEEE ID */
 826         inq_response[11] = ieee[0];       /* IEEE ID| Vendor Specific ID... */
 827         inq_response[12] = (dev->pci_dev->vendor & 0xFF00) >> 8;
 828         inq_response[13] = (dev->pci_dev->vendor & 0x00FF);
 829         inq_response[14] = dev->serial[0];
 830         inq_response[15] = dev->serial[1];
 831         inq_response[16] = dev->model[0];
 832         inq_response[17] = dev->model[1];
 833         memcpy(&inq_response[18], &tmp_id, sizeof(u32));
 834         /* Last 2 bytes are zero */
 835
 836         xfer_len = min(alloc_len, STANDARD_INQUIRY_LENGTH);
 837         res = nvme_trans_copy_to_user(hdr, inq_response, xfer_len);
 838
 839  out_free:
 840         dma_free_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ns), mem,
 841                           dma_addr);
 842  out_dma:
 843         return res;
 844 }
 845
 846 static int nvme_trans_ext_inq_page(struct nvme_ns *ns, struct sg_io_hdr *hdr,
 847                                         int alloc_len)
 848 {
 849         u8 *inq_response;
 850         int res = SNTI_TRANSLATION_SUCCESS;
 851         int nvme_sc;
 852         struct nvme_dev *dev = ns->dev;
 853         dma_addr_t dma_addr;
 854         void *mem;
 855         struct nvme_id_ctrl *id_ctrl;
 856         struct nvme_id_ns *id_ns;
 857         int xfer_len;
 858         u8 microcode = 0x80;
 859         u8 spt;
 860         u8 spt_lut[8] = {0, 0, 2, 1, 4, 6, 5, 7};
 861         u8 grd_chk, app_chk, ref_chk, protect;
 862         u8 uask_sup = 0x20;
 863         u8 v_sup;
 864         u8 luiclr = 0x01;
 865
 866         inq_response = kmalloc(EXTENDED_INQUIRY_DATA_PAGE_LENGTH, GFP_KERNEL);
 867         if (inq_response == NULL) {
 868                 res = -ENOMEM;
 869                 goto out_mem;
 870         }
 871
 872         mem = dma_alloc_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ns),
 873                                                         &dma_addr, GFP_KERNEL);
 874         if (mem == NULL) {
 875                 res = -ENOMEM;
 876                 goto out_dma;
 877         }
 878
 879         /* nvme ns identify */
 880         nvme_sc = nvme_identify(dev, ns->ns_id, 0, dma_addr);
 881         res = nvme_trans_status_code(hdr, nvme_sc);
 882         if (res)
 883                 goto out_free;
 884         if (nvme_sc) {
 885                 res = nvme_sc;
 886                 goto out_free;
 887         }
 888         id_ns = mem;
 889         spt = spt_lut[(id_ns->dpc) & 0x07] << 3;
 890         (id_ns->dps) ? (protect = 0x01) : (protect = 0);
 891         grd_chk = protect << 2;
 892         app_chk = protect << 1;
 893         ref_chk = protect;
 894
 895         /* nvme controller identify */
 896         nvme_sc = nvme_identify(dev, 0, 1, dma_addr);
 897         res = nvme_trans_status_code(hdr, nvme_sc);
 898         if (res)
 899                 goto out_free;
 900         if (nvme_sc) {
 901                 res = nvme_sc;
 902                 goto out_free;
 903         }
 904         id_ctrl = mem;
 905         v_sup = id_ctrl->vwc;
 906
 907         memset(inq_response, 0, EXTENDED_INQUIRY_DATA_PAGE_LENGTH);
 908         inq_response[1] = INQ_EXTENDED_INQUIRY_DATA_PAGE;    /* Page Code */
 909         inq_response[2] = 0x00;    /* Page Length MSB */
 910         inq_response[3] = 0x3C;    /* Page Length LSB */
 911         inq_response[4] = microcode | spt | grd_chk | app_chk | ref_chk;
 912         inq_response[5] = uask_sup;
 913         inq_response[6] = v_sup;
 914         inq_response[7] = luiclr;
 915         inq_response[8] = 0;
 916         inq_response[9] = 0;
 917
 918         xfer_len = min(alloc_len, EXTENDED_INQUIRY_DATA_PAGE_LENGTH);
 919         res = nvme_trans_copy_to_user(hdr, inq_response, xfer_len);
 920
 921  out_free:
 922         dma_free_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ns), mem,
 923                           dma_addr);
 924  out_dma:
 925         kfree(inq_response);
 926  out_mem:
 927         return res;
 928 }
 929
 930 static int nvme_trans_bdev_char_page(struct nvme_ns *ns, struct sg_io_hdr *hdr,
 931                                         int alloc_len)
 932 {
 933         u8 *inq_response;
 934         int res = SNTI_TRANSLATION_SUCCESS;
 935         int xfer_len;
 936
 937         inq_response = kmalloc(EXTENDED_INQUIRY_DATA_PAGE_LENGTH, GFP_KERNEL);
 938         if (inq_response == NULL) {
 939                 res = -ENOMEM;
 940                 goto out_mem;
 941         }
 942
 943         memset(inq_response, 0, EXTENDED_INQUIRY_DATA_PAGE_LENGTH);
 944         inq_response[1] = INQ_BDEV_CHARACTERISTICS_PAGE;    /* Page Code */
 945         inq_response[2] = 0x00;    /* Page Length MSB */
 946         inq_response[3] = 0x3C;    /* Page Length LSB */
 947         inq_response[4] = 0x00;    /* Medium Rotation Rate MSB */
 948         inq_response[5] = 0x01;    /* Medium Rotation Rate LSB */
 949         inq_response[6] = 0x00;    /* Form Factor */
 950
 951         xfer_len = min(alloc_len, EXTENDED_INQUIRY_DATA_PAGE_LENGTH);
 952         res = nvme_trans_copy_to_user(hdr, inq_response, xfer_len);
 953
 954         kfree(inq_response);
 955  out_mem:
 956         return res;
 957 }
 958
 959 /* LOG SENSE Helper Functions */
 960
 961 static int nvme_trans_log_supp_pages(struct nvme_ns *ns, struct sg_io_hdr *hdr,
 962                                         int alloc_len)
 963 {
 964         int res = SNTI_TRANSLATION_SUCCESS;
 965         int xfer_len;
 966         u8 *log_response;
 967
 968         log_response = kmalloc(LOG_PAGE_SUPPORTED_LOG_PAGES_LENGTH, GFP_KERNEL);
 969         if (log_response == NULL) {
 970                 res = -ENOMEM;
 971                 goto out_mem;
 972         }
 973         memset(log_response, 0, LOG_PAGE_SUPPORTED_LOG_PAGES_LENGTH);
 974
 975         log_response[0] = LOG_PAGE_SUPPORTED_LOG_PAGES_PAGE;
 976         /* Subpage=0x00, Page Length MSB=0 */
 977         log_response[3] = SUPPORTED_LOG_PAGES_PAGE_LENGTH;
 978         log_response[4] = LOG_PAGE_SUPPORTED_LOG_PAGES_PAGE;
 979         log_response[5] = LOG_PAGE_INFORMATIONAL_EXCEPTIONS_PAGE;
 980         log_response[6] = LOG_PAGE_TEMPERATURE_PAGE;
 981
 982         xfer_len = min(alloc_len, LOG_PAGE_SUPPORTED_LOG_PAGES_LENGTH);
 983         res = nvme_trans_copy_to_user(hdr, log_response, xfer_len);
 984
 985         kfree(log_response);
 986  out_mem:
 987         return res;
 988 }
 989
 990 static int nvme_trans_log_info_exceptions(struct nvme_ns *ns,
 991                                         struct sg_io_hdr *hdr, int alloc_len)
 992 {
 993         int res = SNTI_TRANSLATION_SUCCESS;
 994         int xfer_len;
 995         u8 *log_response;
 996         struct nvme_command c;
 997         struct nvme_dev *dev = ns->dev;
 998         struct nvme_smart_log *smart_log;
 999         dma_addr_t dma_addr;
1000         void *mem;
1001         u8 temp_c;
1002         u16 temp_k;
1003
1004         log_response = kmalloc(LOG_INFO_EXCP_PAGE_LENGTH, GFP_KERNEL);
1005         if (log_response == NULL) {
1006                 res = -ENOMEM;
1007                 goto out_mem;
1008         }
1009         memset(log_response, 0, LOG_INFO_EXCP_PAGE_LENGTH);
1010
1011         mem = dma_alloc_coherent(&dev->pci_dev->dev,
1012                                         sizeof(struct nvme_smart_log),
1013                                         &dma_addr, GFP_KERNEL);
1014         if (mem == NULL) {
1015                 res = -ENOMEM;
1016                 goto out_dma;
1017         }
1018
1019         /* Get SMART Log Page */
1020         memset(&c, 0, sizeof(c));
1021         c.common.opcode = nvme_admin_get_log_page;
1022         c.common.nsid = cpu_to_le32(0xFFFFFFFF);
1023         c.common.prp1 = cpu_to_le64(dma_addr);
1024         c.common.cdw10[0] = cpu_to_le32(((sizeof(struct nvme_smart_log) /
1025                         BYTES_TO_DWORDS) << 16) | NVME_GET_SMART_LOG_PAGE);
1026         res = nvme_submit_admin_cmd(dev, &c, NULL);
1027         if (res != NVME_SC_SUCCESS) {
1028                 temp_c = LOG_TEMP_UNKNOWN;
1029         } else {
1030                 smart_log = mem;
1031                 temp_k = (smart_log->temperature[1] << 8) +
1032                                 (smart_log->temperature[0]);
1033                 temp_c = temp_k - KELVIN_TEMP_FACTOR;
1034         }
1035
1036         log_response[0] = LOG_PAGE_INFORMATIONAL_EXCEPTIONS_PAGE;
1037         /* Subpage=0x00, Page Length MSB=0 */
1038         log_response[3] = REMAINING_INFO_EXCP_PAGE_LENGTH;
1039         /* Informational Exceptions Log Parameter 1 Start */
1040         /* Parameter Code=0x0000 bytes 4,5 */
1041         log_response[6] = 0x23; /* DU=0, TSD=1, ETC=0, TMC=0, FMT_AND_LNK=11b */
1042         log_response[7] = 0x04; /* PARAMETER LENGTH */
1043         /* Add sense Code and qualifier = 0x00 each */
1044         /* Use Temperature from NVMe Get Log Page, convert to C from K */
1045         log_response[10] = temp_c;
1046
1047         xfer_len = min(alloc_len, LOG_INFO_EXCP_PAGE_LENGTH);
1048         res = nvme_trans_copy_to_user(hdr, log_response, xfer_len);
1049
1050         dma_free_coherent(&dev->pci_dev->dev, sizeof(struct nvme_smart_log),
1051                           mem, dma_addr);
1052  out_dma:
1053         kfree(log_response);
1054  out_mem:
1055         return res;
1056 }
1057
1058 static int nvme_trans_log_temperature(struct nvme_ns *ns, struct sg_io_hdr *hdr,
1059                                         int alloc_len)
1060 {
1061         int res = SNTI_TRANSLATION_SUCCESS;
1062         int xfer_len;
1063         u8 *log_response;
1064         struct nvme_command c;
1065         struct nvme_dev *dev = ns->dev;
1066         struct nvme_smart_log *smart_log;
1067         dma_addr_t dma_addr;
1068         void *mem;
1069         u32 feature_resp;
1070         u8 temp_c_cur, temp_c_thresh;
1071         u16 temp_k;
1072
1073         log_response = kmalloc(LOG_TEMP_PAGE_LENGTH, GFP_KERNEL);
1074         if (log_response == NULL) {
1075                 res = -ENOMEM;
1076                 goto out_mem;
1077         }
1078         memset(log_response, 0, LOG_TEMP_PAGE_LENGTH);
1079
1080         mem = dma_alloc_coherent(&dev->pci_dev->dev,
1081                                         sizeof(struct nvme_smart_log),
1082                                         &dma_addr, GFP_KERNEL);
1083         if (mem == NULL) {
1084                 res = -ENOMEM;
1085                 goto out_dma;
1086         }
1087
1088         /* Get SMART Log Page */
1089         memset(&c, 0, sizeof(c));
1090         c.common.opcode = nvme_admin_get_log_page;
1091         c.common.nsid = cpu_to_le32(0xFFFFFFFF);
1092         c.common.prp1 = cpu_to_le64(dma_addr);
1093         c.common.cdw10[0] = cpu_to_le32(((sizeof(struct nvme_smart_log) /
1094                         BYTES_TO_DWORDS) << 16) | NVME_GET_SMART_LOG_PAGE);
1095         res = nvme_submit_admin_cmd(dev, &c, NULL);
1096         if (res != NVME_SC_SUCCESS) {
1097                 temp_c_cur = LOG_TEMP_UNKNOWN;
1098         } else {
1099                 smart_log = mem;
1100                 temp_k = (smart_log->temperature[1] << 8) +
1101                                 (smart_log->temperature[0]);
1102                 temp_c_cur = temp_k - KELVIN_TEMP_FACTOR;
1103         }
1104
1105         /* Get Features for Temp Threshold */
1106         res = nvme_get_features(dev, NVME_FEAT_TEMP_THRESH, 0, 0,
1107                                                                 &feature_resp);
1108         if (res != NVME_SC_SUCCESS)
1109                 temp_c_thresh = LOG_TEMP_UNKNOWN;
1110         else
1111                 temp_c_thresh = (feature_resp & 0xFFFF) - KELVIN_TEMP_FACTOR;
1112
1113         log_response[0] = LOG_PAGE_TEMPERATURE_PAGE;
1114         /* Subpage=0x00, Page Length MSB=0 */
1115         log_response[3] = REMAINING_TEMP_PAGE_LENGTH;
1116         /* Temperature Log Parameter 1 (Temperature) Start */
1117         /* Parameter Code = 0x0000 */
1118         log_response[6] = 0x01;         /* Format and Linking = 01b */
1119         log_response[7] = 0x02;         /* Parameter Length */
1120         /* Use Temperature from NVMe Get Log Page, convert to C from K */
1121         log_response[9] = temp_c_cur;
1122         /* Temperature Log Parameter 2 (Reference Temperature) Start */
1123         log_response[11] = 0x01;        /* Parameter Code = 0x0001 */
1124         log_response[12] = 0x01;        /* Format and Linking = 01b */
1125         log_response[13] = 0x02;        /* Parameter Length */
1126         /* Use Temperature Thresh from NVMe Get Log Page, convert to C from K */
1127         log_response[15] = temp_c_thresh;
1128
1129         xfer_len = min(alloc_len, LOG_TEMP_PAGE_LENGTH);
1130         res = nvme_trans_copy_to_user(hdr, log_response, xfer_len);
1131
1132         dma_free_coherent(&dev->pci_dev->dev, sizeof(struct nvme_smart_log),
1133                           mem, dma_addr);
1134  out_dma:
1135         kfree(log_response);
1136  out_mem:
1137         return res;
1138 }
1139
1140 /* MODE SENSE Helper Functions */
1141
1142 static int nvme_trans_fill_mode_parm_hdr(u8 *resp, int len, u8 cdb10, u8 llbaa,
1143                                         u16 mode_data_length, u16 blk_desc_len)
1144 {
1145         /* Quick check to make sure I don't stomp on my own memory... */
1146         if ((cdb10 && len < 8) || (!cdb10 && len < 4))
1147                 return SNTI_INTERNAL_ERROR;
1148
1149         if (cdb10) {
1150                 resp[0] = (mode_data_length & 0xFF00) >> 8;
1151                 resp[1] = (mode_data_length & 0x00FF);
1152                 /* resp[2] and [3] are zero */
1153                 resp[4] = llbaa;
1154                 resp[5] = RESERVED_FIELD;
1155                 resp[6] = (blk_desc_len & 0xFF00) >> 8;
1156                 resp[7] = (blk_desc_len & 0x00FF);
1157         } else {
1158                 resp[0] = (mode_data_length & 0x00FF);
1159                 /* resp[1] and [2] are zero */
1160                 resp[3] = (blk_desc_len & 0x00FF);
1161         }
1162
1163         return SNTI_TRANSLATION_SUCCESS;
1164 }
1165
1166 static int nvme_trans_fill_blk_desc(struct nvme_ns *ns, struct sg_io_hdr *hdr,
1167                                     u8 *resp, int len, u8 llbaa)
1168 {
1169         int res = SNTI_TRANSLATION_SUCCESS;
1170         int nvme_sc;
1171         struct nvme_dev *dev = ns->dev;
1172         dma_addr_t dma_addr;
1173         void *mem;
1174         struct nvme_id_ns *id_ns;
1175         u8 flbas;
1176         u32 lba_length;
1177
1178         if (llbaa == 0 && len < MODE_PAGE_BLK_DES_LEN)
1179                 return SNTI_INTERNAL_ERROR;
1180         else if (llbaa > 0 && len < MODE_PAGE_LLBAA_BLK_DES_LEN)
1181                 return SNTI_INTERNAL_ERROR;
1182
1183         mem = dma_alloc_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ns),
1184                                                         &dma_addr, GFP_KERNEL);
1185         if (mem == NULL) {
1186                 res = -ENOMEM;
1187                 goto out;
1188         }
1189
1190         /* nvme ns identify */
1191         nvme_sc = nvme_identify(dev, ns->ns_id, 0, dma_addr);
1192         res = nvme_trans_status_code(hdr, nvme_sc);
1193         if (res)
1194                 goto out_dma;
1195         if (nvme_sc) {
1196                 res = nvme_sc;
1197                 goto out_dma;
1198         }
1199         id_ns = mem;
1200         flbas = (id_ns->flbas) & 0x0F;
1201         lba_length = (1 << (id_ns->lbaf[flbas].ds));
1202
1203         if (llbaa == 0) {
1204                 __be32 tmp_cap = cpu_to_be32(le64_to_cpu(id_ns->ncap));
1205                 /* Byte 4 is reserved */
1206                 __be32 tmp_len = cpu_to_be32(lba_length & 0x00FFFFFF);
1207
1208                 memcpy(resp, &tmp_cap, sizeof(u32));
1209                 memcpy(&resp[4], &tmp_len, sizeof(u32));
1210         } else {
1211                 __be64 tmp_cap = cpu_to_be64(le64_to_cpu(id_ns->ncap));
1212                 __be32 tmp_len = cpu_to_be32(lba_length);
1213
1214                 memcpy(resp, &tmp_cap, sizeof(u64));
1215                 /* Bytes 8, 9, 10, 11 are reserved */
1216                 memcpy(&resp[12], &tmp_len, sizeof(u32));
1217         }
1218
1219  out_dma:
1220         dma_free_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ns), mem,
1221                           dma_addr);
1222  out:
1223         return res;
1224 }
1225
1226 static int nvme_trans_fill_control_page(struct nvme_ns *ns,
1227                                         struct sg_io_hdr *hdr, u8 *resp,
1228                                         int len)
1229 {
1230         if (len < MODE_PAGE_CONTROL_LEN)
1231                 return SNTI_INTERNAL_ERROR;
1232
1233         resp[0] = MODE_PAGE_CONTROL;
1234         resp[1] = MODE_PAGE_CONTROL_LEN_FIELD;
1235         resp[2] = 0x0E;         /* TST=000b, TMF_ONLY=0, DPICZ=1,
1236                                  * D_SENSE=1, GLTSD=1, RLEC=0 */
1237         resp[3] = 0x12;         /* Q_ALGO_MODIFIER=1h, NUAR=0, QERR=01b */
1238         /* Byte 4:  VS=0, RAC=0, UA_INT=0, SWP=0 */
1239         resp[5] = 0x40;         /* ATO=0, TAS=1, ATMPE=0, RWWP=0, AUTOLOAD=0 */
1240         /* resp[6] and [7] are obsolete, thus zero */
1241         resp[8] = 0xFF;         /* Busy timeout period = 0xffff */
1242         resp[9] = 0xFF;
1243         /* Bytes 10,11: Extended selftest completion time = 0x0000 */
1244
1245         return SNTI_TRANSLATION_SUCCESS;
1246 }
1247
1248 static int nvme_trans_fill_caching_page(struct nvme_ns *ns,
1249                                         struct sg_io_hdr *hdr,
1250                                         u8 *resp, int len)
1251 {
1252         int res = SNTI_TRANSLATION_SUCCESS;
1253         int nvme_sc;
1254         struct nvme_dev *dev = ns->dev;
1255         u32 feature_resp;
1256         u8 vwc;
1257
1258         if (len < MODE_PAGE_CACHING_LEN)
1259                 return SNTI_INTERNAL_ERROR;
1260
1261         nvme_sc = nvme_get_features(dev, NVME_FEAT_VOLATILE_WC, 0, 0,
1262                                                                 &feature_resp);
1263         res = nvme_trans_status_code(hdr, nvme_sc);
1264         if (res)
1265                 goto out;
1266         if (nvme_sc) {
1267                 res = nvme_sc;
1268                 goto out;
1269         }
1270         vwc = feature_resp & 0x00000001;
1271
1272         resp[0] = MODE_PAGE_CACHING;
1273         resp[1] = MODE_PAGE_CACHING_LEN_FIELD;
1274         resp[2] = vwc << 2;
1275
1276  out:
1277         return res;
1278 }
1279
1280 static int nvme_trans_fill_pow_cnd_page(struct nvme_ns *ns,
1281                                         struct sg_io_hdr *hdr, u8 *resp,
1282                                         int len)
1283 {
1284         int res = SNTI_TRANSLATION_SUCCESS;
1285
1286         if (len < MODE_PAGE_POW_CND_LEN)
1287                 return SNTI_INTERNAL_ERROR;
1288
1289         resp[0] = MODE_PAGE_POWER_CONDITION;
1290         resp[1] = MODE_PAGE_POW_CND_LEN_FIELD;
1291         /* All other bytes are zero */
1292
1293         return res;
1294 }
1295
1296 static int nvme_trans_fill_inf_exc_page(struct nvme_ns *ns,
1297                                         struct sg_io_hdr *hdr, u8 *resp,
1298                                         int len)
1299 {
1300         int res = SNTI_TRANSLATION_SUCCESS;
1301
1302         if (len < MODE_PAGE_INF_EXC_LEN)
1303                 return SNTI_INTERNAL_ERROR;
1304
1305         resp[0] = MODE_PAGE_INFO_EXCEP;
1306         resp[1] = MODE_PAGE_INF_EXC_LEN_FIELD;
1307         resp[2] = 0x88;
1308         /* All other bytes are zero */
1309
1310         return res;
1311 }
1312
1313 static int nvme_trans_fill_all_pages(struct nvme_ns *ns, struct sg_io_hdr *hdr,
1314                                      u8 *resp, int len)
1315 {
1316         int res = SNTI_TRANSLATION_SUCCESS;
1317         u16 mode_pages_offset_1 = 0;
1318         u16 mode_pages_offset_2, mode_pages_offset_3, mode_pages_offset_4;
1319
1320         mode_pages_offset_2 = mode_pages_offset_1 + MODE_PAGE_CACHING_LEN;
1321         mode_pages_offset_3 = mode_pages_offset_2 + MODE_PAGE_CONTROL_LEN;
1322         mode_pages_offset_4 = mode_pages_offset_3 + MODE_PAGE_POW_CND_LEN;
1323
1324         res = nvme_trans_fill_caching_page(ns, hdr, &resp[mode_pages_offset_1],
1325                                         MODE_PAGE_CACHING_LEN);
1326         if (res != SNTI_TRANSLATION_SUCCESS)
1327                 goto out;
1328         res = nvme_trans_fill_control_page(ns, hdr, &resp[mode_pages_offset_2],
1329                                         MODE_PAGE_CONTROL_LEN);
1330         if (res != SNTI_TRANSLATION_SUCCESS)
1331                 goto out;
1332         res = nvme_trans_fill_pow_cnd_page(ns, hdr, &resp[mode_pages_offset_3],
1333                                         MODE_PAGE_POW_CND_LEN);
1334         if (res != SNTI_TRANSLATION_SUCCESS)
1335                 goto out;
1336         res = nvme_trans_fill_inf_exc_page(ns, hdr, &resp[mode_pages_offset_4],
1337                                         MODE_PAGE_INF_EXC_LEN);
1338         if (res != SNTI_TRANSLATION_SUCCESS)
1339                 goto out;
1340
1341  out:
1342         return res;
1343 }
1344
1345 static inline int nvme_trans_get_blk_desc_len(u8 dbd, u8 llbaa)
1346 {
1347         if (dbd == MODE_SENSE_BLK_DESC_ENABLED) {
1348                 /* SPC-4: len = 8 x Num_of_descriptors if llbaa = 0, 16x if 1 */
1349                 return 8 * (llbaa + 1) * MODE_SENSE_BLK_DESC_COUNT;
1350         } else {
1351                 return 0;
1352         }
1353 }
1354
1355 static int nvme_trans_mode_page_create(struct nvme_ns *ns,
1356                                         struct sg_io_hdr *hdr, u8 *cmd,
1357                                         u16 alloc_len, u8 cdb10,
1358                                         int (*mode_page_fill_func)
1359                                         (struct nvme_ns *,
1360                                         struct sg_io_hdr *hdr, u8 *, int),
1361                                         u16 mode_pages_tot_len)
1362 {
1363         int res = SNTI_TRANSLATION_SUCCESS;
1364         int xfer_len;
1365         u8 *response;
1366         u8 dbd, llbaa;
1367         u16 resp_size;
1368         int mph_size;
1369         u16 mode_pages_offset_1;
1370         u16 blk_desc_len, blk_desc_offset, mode_data_length;
1371
1372         dbd = GET_MODE_SENSE_DBD(cmd);
1373         llbaa = GET_MODE_SENSE_LLBAA(cmd);
1374         mph_size = GET_MODE_SENSE_MPH_SIZE(cdb10);
1375         blk_desc_len = nvme_trans_get_blk_desc_len(dbd, llbaa);
1376
1377         resp_size = mph_size + blk_desc_len + mode_pages_tot_len;
1378         /* Refer spc4r34 Table 440 for calculation of Mode data Length field */
1379         mode_data_length = 3 + (3 * cdb10) + blk_desc_len + mode_pages_tot_len;
1380
1381         blk_desc_offset = mph_size;
1382         mode_pages_offset_1 = blk_desc_offset + blk_desc_len;
1383
1384         response = kmalloc(resp_size, GFP_KERNEL);
1385         if (response == NULL) {
1386                 res = -ENOMEM;
1387                 goto out_mem;
1388         }
1389         memset(response, 0, resp_size);
1390
1391         res = nvme_trans_fill_mode_parm_hdr(&response[0], mph_size, cdb10,
1392                                         llbaa, mode_data_length, blk_desc_len);
1393         if (res != SNTI_TRANSLATION_SUCCESS)
1394                 goto out_free;
1395         if (blk_desc_len > 0) {
1396                 res = nvme_trans_fill_blk_desc(ns, hdr,
1397                                                &response[blk_desc_offset],
1398                                                blk_desc_len, llbaa);
1399                 if (res != SNTI_TRANSLATION_SUCCESS)
1400                         goto out_free;
1401         }
1402         res = mode_page_fill_func(ns, hdr, &response[mode_pages_offset_1],
1403                                         mode_pages_tot_len);
1404         if (res != SNTI_TRANSLATION_SUCCESS)
1405                 goto out_free;
1406
1407         xfer_len = min(alloc_len, resp_size);
1408         res = nvme_trans_copy_to_user(hdr, response, xfer_len);
1409
1410  out_free:
1411         kfree(response);
1412  out_mem:
1413         return res;
1414 }
1415
1416 /* Read Capacity Helper Functions */
1417
1418 static void nvme_trans_fill_read_cap(u8 *response, struct nvme_id_ns *id_ns,
1419                                                                 u8 cdb16)
1420 {
1421         u8 flbas;
1422         u32 lba_length;
1423         u64 rlba;
1424         u8 prot_en;
1425         u8 p_type_lut[4] = {0, 0, 1, 2};
1426         __be64 tmp_rlba;
1427         __be32 tmp_rlba_32;
1428         __be32 tmp_len;
1429
1430         flbas = (id_ns->flbas) & 0x0F;
1431         lba_length = (1 << (id_ns->lbaf[flbas].ds));
1432         rlba = le64_to_cpup(&id_ns->nsze) - 1;
1433         (id_ns->dps) ? (prot_en = 0x01) : (prot_en = 0);
1434
1435         if (!cdb16) {
1436                 if (rlba > 0xFFFFFFFF)
1437                         rlba = 0xFFFFFFFF;
1438                 tmp_rlba_32 = cpu_to_be32(rlba);
1439                 tmp_len = cpu_to_be32(lba_length);
1440                 memcpy(response, &tmp_rlba_32, sizeof(u32));
1441                 memcpy(&response[4], &tmp_len, sizeof(u32));
1442         } else {
1443                 tmp_rlba = cpu_to_be64(rlba);
1444                 tmp_len = cpu_to_be32(lba_length);
1445                 memcpy(response, &tmp_rlba, sizeof(u64));
1446                 memcpy(&response[8], &tmp_len, sizeof(u32));
1447                 response[12] = (p_type_lut[id_ns->dps & 0x3] << 1) | prot_en;
1448                 /* P_I_Exponent = 0x0 | LBPPBE = 0x0 */
1449                 /* LBPME = 0 | LBPRZ = 0 | LALBA = 0x00 */
1450                 /* Bytes 16-31 - Reserved */
1451         }
1452 }
1453
1454 /* Start Stop Unit Helper Functions */
1455
1456 static int nvme_trans_power_state(struct nvme_ns *ns, struct sg_io_hdr *hdr,
1457                                                 u8 pc, u8 pcmod, u8 start)
1458 {
1459         int res = SNTI_TRANSLATION_SUCCESS;
1460         int nvme_sc;
1461         struct nvme_dev *dev = ns->dev;
1462         dma_addr_t dma_addr;
1463         void *mem;
1464         struct nvme_id_ctrl *id_ctrl;
1465         int lowest_pow_st;      /* max npss = lowest power consumption */
1466         unsigned ps_desired = 0;
1467
1468         /* NVMe Controller Identify */
1469         mem = dma_alloc_coherent(&dev->pci_dev->dev,
1470                                 sizeof(struct nvme_id_ctrl),
1471                                 &dma_addr, GFP_KERNEL);
1472         if (mem == NULL) {
1473                 res = -ENOMEM;
1474                 goto out;
1475         }
1476         nvme_sc = nvme_identify(dev, 0, 1, dma_addr);
1477         res = nvme_trans_status_code(hdr, nvme_sc);
1478         if (res)
1479                 goto out_dma;
1480         if (nvme_sc) {
1481                 res = nvme_sc;
1482                 goto out_dma;
1483         }
1484         id_ctrl = mem;
1485         lowest_pow_st = id_ctrl->npss - 1;
1486
1487         switch (pc) {
1488         case NVME_POWER_STATE_START_VALID:
1489                 /* Action unspecified if POWER CONDITION MODIFIER != 0 */
1490                 if (pcmod == 0 && start == 0x1)
1491                         ps_desired = POWER_STATE_0;
1492                 if (pcmod == 0 && start == 0x0)
1493                         ps_desired = lowest_pow_st;
1494                 break;
1495         case NVME_POWER_STATE_ACTIVE:
1496                 /* Action unspecified if POWER CONDITION MODIFIER != 0 */
1497                 if (pcmod == 0)
1498                         ps_desired = POWER_STATE_0;
1499                 break;
1500         case NVME_POWER_STATE_IDLE:
1501                 /* Action unspecified if POWER CONDITION MODIFIER != [0,1,2] */
1502                 /* min of desired state and (lps-1) because lps is STOP */
1503                 if (pcmod == 0x0)
1504                         ps_desired = min(POWER_STATE_1, (lowest_pow_st - 1));
1505                 else if (pcmod == 0x1)
1506                         ps_desired = min(POWER_STATE_2, (lowest_pow_st - 1));
1507                 else if (pcmod == 0x2)
1508                         ps_desired = min(POWER_STATE_3, (lowest_pow_st - 1));
1509                 break;
1510         case NVME_POWER_STATE_STANDBY:
1511                 /* Action unspecified if POWER CONDITION MODIFIER != [0,1] */
1512                 if (pcmod == 0x0)
1513                         ps_desired = max(0, (lowest_pow_st - 2));
1514                 else if (pcmod == 0x1)
1515                         ps_desired = max(0, (lowest_pow_st - 1));
1516                 break;
1517         case NVME_POWER_STATE_LU_CONTROL:
1518         default:
1519                 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
1520                                 ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
1521                                 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
1522                 break;
1523         }
1524         nvme_sc = nvme_set_features(dev, NVME_FEAT_POWER_MGMT, ps_desired, 0,
1525                                     NULL);
1526         res = nvme_trans_status_code(hdr, nvme_sc);
1527         if (res)
1528                 goto out_dma;
1529         if (nvme_sc)
1530                 res = nvme_sc;
1531  out_dma:
1532         dma_free_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ctrl), mem,
1533                           dma_addr);
1534  out:
1535         return res;
1536 }
1537
1538 /* Write Buffer Helper Functions */
1539 /* Also using this for Format Unit with hdr passed as NULL, and buffer_id, 0 */
1540
1541 static int nvme_trans_send_fw_cmd(struct nvme_ns *ns, struct sg_io_hdr *hdr,
1542                                         u8 opcode, u32 tot_len, u32 offset,
1543                                         u8 buffer_id)
1544 {
1545         int res = SNTI_TRANSLATION_SUCCESS;
1546         int nvme_sc;
1547         struct nvme_dev *dev = ns->dev;
1548         struct nvme_command c;
1549         struct nvme_iod *iod = NULL;
1550         unsigned length;
1551
1552         memset(&c, 0, sizeof(c));
1553         c.common.opcode = opcode;
1554         if (opcode == nvme_admin_download_fw) {
1555                 if (hdr->iovec_count > 0) {
1556                         /* Assuming SGL is not allowed for this command */
1557                         res = nvme_trans_completion(hdr,
1558                                                 SAM_STAT_CHECK_CONDITION,
1559                                                 ILLEGAL_REQUEST,
1560                                                 SCSI_ASC_INVALID_CDB,
1561                                                 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
1562                         goto out;
1563                 }
1564                 iod = nvme_map_user_pages(dev, DMA_TO_DEVICE,
1565                                 (unsigned long)hdr->dxferp, tot_len);
1566                 if (IS_ERR(iod)) {
1567                         res = PTR_ERR(iod);
1568                         goto out;
1569                 }
1570                 length = nvme_setup_prps(dev, &c.common, iod, tot_len,
1571                                                                 GFP_KERNEL);
1572                 if (length != tot_len) {
1573                         res = -ENOMEM;
1574                         goto out_unmap;
1575                 }
1576
1577                 c.dlfw.numd = cpu_to_le32((tot_len/BYTES_TO_DWORDS) - 1);
1578                 c.dlfw.offset = cpu_to_le32(offset/BYTES_TO_DWORDS);
1579         } else if (opcode == nvme_admin_activate_fw) {
1580                 c.common.cdw10[0] = cpu_to_le32(buffer_id);
1581                 /* AA=01b Replace & activate at reset */
1582                 c.common.cdw10[0] = cpu_to_le32(le32_to_cpu(
1583                                                 c.common.cdw10[0]) | 0x00000008);
1584         }
1585
1586         nvme_sc = nvme_submit_admin_cmd(dev, &c, NULL);
1587         res = nvme_trans_status_code(hdr, nvme_sc);
1588         if (res)
1589                 goto out_unmap;
1590         if (nvme_sc)
1591                 res = nvme_sc;
1592
1593  out_unmap:
1594         if (opcode == nvme_admin_download_fw) {
1595                 nvme_unmap_user_pages(dev, DMA_TO_DEVICE, iod);
1596                 nvme_free_iod(dev, iod);
1597         }
1598  out:
1599         return res;
1600 }
1601
1602 /* Mode Select Helper Functions */
1603
1604 static inline void nvme_trans_modesel_get_bd_len(u8 *parm_list, u8 cdb10,
1605                                                 u16 *bd_len, u8 *llbaa)
1606 {
1607         if (cdb10) {
1608                 /* 10 Byte CDB */
1609                 *bd_len = (parm_list[MODE_SELECT_10_BD_OFFSET] << 8) +
1610                         parm_list[MODE_SELECT_10_BD_OFFSET + 1];
1611                 *llbaa = parm_list[MODE_SELECT_10_LLBAA_OFFSET] &&
1612                                 MODE_SELECT_10_LLBAA_MASK;
1613         } else {
1614                 /* 6 Byte CDB */
1615                 *bd_len = parm_list[MODE_SELECT_6_BD_OFFSET];
1616         }
1617 }
1618
1619 static void nvme_trans_modesel_save_bd(struct nvme_ns *ns, u8 *parm_list,
1620                                         u16 idx, u16 bd_len, u8 llbaa)
1621 {
1622         u16 bd_num;
1623
1624         bd_num = bd_len / ((llbaa == 0) ?
1625                         SHORT_DESC_BLOCK : LONG_DESC_BLOCK);
1626         /* Store block descriptor info if a FORMAT UNIT comes later */
1627         /* TODO Saving 1st BD info; what to do if multiple BD received? */
1628         if (llbaa == 0) {
1629                 /* Standard Block Descriptor - spc4r34 7.5.5.1 */
1630                 ns->mode_select_num_blocks =
1631                                 (parm_list[idx + 1] << 16) +
1632                                 (parm_list[idx + 2] << 8) +
1633                                 (parm_list[idx + 3]);
1634
1635                 ns->mode_select_block_len =
1636                                 (parm_list[idx + 5] << 16) +
1637                                 (parm_list[idx + 6] << 8) +
1638                                 (parm_list[idx + 7]);
1639         } else {
1640                 /* Long LBA Block Descriptor - sbc3r27 6.4.2.3 */
1641                 ns->mode_select_num_blocks =
1642                                 (((u64)parm_list[idx + 0]) << 56) +
1643                                 (((u64)parm_list[idx + 1]) << 48) +
1644                                 (((u64)parm_list[idx + 2]) << 40) +
1645                                 (((u64)parm_list[idx + 3]) << 32) +
1646                                 (((u64)parm_list[idx + 4]) << 24) +
1647                                 (((u64)parm_list[idx + 5]) << 16) +
1648                                 (((u64)parm_list[idx + 6]) << 8) +
1649                                 ((u64)parm_list[idx + 7]);
1650
1651                 ns->mode_select_block_len =
1652                                 (parm_list[idx + 12] << 24) +
1653                                 (parm_list[idx + 13] << 16) +
1654                                 (parm_list[idx + 14] << 8) +
1655                                 (parm_list[idx + 15]);
1656         }
1657 }
1658
1659 static u16 nvme_trans_modesel_get_mp(struct nvme_ns *ns, struct sg_io_hdr *hdr,
1660                                         u8 *mode_page, u8 page_code)
1661 {
1662         int res = SNTI_TRANSLATION_SUCCESS;
1663         int nvme_sc;
1664         struct nvme_dev *dev = ns->dev;
1665         unsigned dword11;
1666
1667         switch (page_code) {
1668         case MODE_PAGE_CACHING:
1669                 dword11 = ((mode_page[2] & CACHING_MODE_PAGE_WCE_MASK) ? 1 : 0);
1670                 nvme_sc = nvme_set_features(dev, NVME_FEAT_VOLATILE_WC, dword11,
1671                                             0, NULL);
1672                 res = nvme_trans_status_code(hdr, nvme_sc);
1673                 if (res)
1674                         break;
1675                 if (nvme_sc) {
1676                         res = nvme_sc;
1677                         break;
1678                 }
1679                 break;
1680         case MODE_PAGE_CONTROL:
1681                 break;
1682         case MODE_PAGE_POWER_CONDITION:
1683                 /* Verify the OS is not trying to set timers */
1684                 if ((mode_page[2] & 0x01) != 0 || (mode_page[3] & 0x0F) != 0) {
1685                         res = nvme_trans_completion(hdr,
1686                                                 SAM_STAT_CHECK_CONDITION,
1687                                                 ILLEGAL_REQUEST,
1688                                                 SCSI_ASC_INVALID_PARAMETER,
1689                                                 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
1690                         if (!res)
1691                                 res = SNTI_INTERNAL_ERROR;
1692                         break;
1693                 }
1694                 break;
1695         default:
1696                 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
1697                                         ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
1698                                         SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
1699                 if (!res)
1700                         res = SNTI_INTERNAL_ERROR;
1701                 break;
1702         }
1703
1704         return res;
1705 }
1706
1707 static int nvme_trans_modesel_data(struct nvme_ns *ns, struct sg_io_hdr *hdr,
1708                                         u8 *cmd, u16 parm_list_len, u8 pf,
1709                                         u8 sp, u8 cdb10)
1710 {
1711         int res = SNTI_TRANSLATION_SUCCESS;
1712         u8 *parm_list;
1713         u16 bd_len;
1714         u8 llbaa = 0;
1715         u16 index, saved_index;
1716         u8 page_code;
1717         u16 mp_size;
1718
1719         /* Get parm list from data-in/out buffer */
1720         parm_list = kmalloc(parm_list_len, GFP_KERNEL);
1721         if (parm_list == NULL) {
1722                 res = -ENOMEM;
1723                 goto out;
1724         }
1725
1726         res = nvme_trans_copy_from_user(hdr, parm_list, parm_list_len);
1727         if (res != SNTI_TRANSLATION_SUCCESS)
1728                 goto out_mem;
1729
1730         nvme_trans_modesel_get_bd_len(parm_list, cdb10, &bd_len, &llbaa);
1731         index = (cdb10) ? (MODE_SELECT_10_MPH_SIZE) : (MODE_SELECT_6_MPH_SIZE);
1732
1733         if (bd_len != 0) {
1734                 /* Block Descriptors present, parse */
1735                 nvme_trans_modesel_save_bd(ns, parm_list, index, bd_len, llbaa);
1736                 index += bd_len;
1737         }
1738         saved_index = index;
1739
1740         /* Multiple mode pages may be present; iterate through all */
1741         /* In 1st Iteration, don't do NVME Command, only check for CDB errors */
1742         do {
1743                 page_code = parm_list[index] & MODE_SELECT_PAGE_CODE_MASK;
1744                 mp_size = parm_list[index + 1] + 2;
1745                 if ((page_code != MODE_PAGE_CACHING) &&
1746                     (page_code != MODE_PAGE_CONTROL) &&
1747                     (page_code != MODE_PAGE_POWER_CONDITION)) {
1748                         res = nvme_trans_completion(hdr,
1749                                                 SAM_STAT_CHECK_CONDITION,
1750                                                 ILLEGAL_REQUEST,
1751                                                 SCSI_ASC_INVALID_CDB,
1752                                                 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
1753                         goto out_mem;
1754                 }
1755                 index += mp_size;
1756         } while (index < parm_list_len);
1757
1758         /* In 2nd Iteration, do the NVME Commands */
1759         index = saved_index;
1760         do {
1761                 page_code = parm_list[index] & MODE_SELECT_PAGE_CODE_MASK;
1762                 mp_size = parm_list[index + 1] + 2;
1763                 res = nvme_trans_modesel_get_mp(ns, hdr, &parm_list[index],
1764                                                                 page_code);
1765                 if (res != SNTI_TRANSLATION_SUCCESS)
1766                         break;
1767                 index += mp_size;
1768         } while (index < parm_list_len);
1769
1770  out_mem:
1771         kfree(parm_list);
1772  out:
1773         return res;
1774 }
1775
1776 /* Format Unit Helper Functions */
1777
1778 static int nvme_trans_fmt_set_blk_size_count(struct nvme_ns *ns,
1779                                              struct sg_io_hdr *hdr)
1780 {
1781         int res = SNTI_TRANSLATION_SUCCESS;
1782         int nvme_sc;
1783         struct nvme_dev *dev = ns->dev;
1784         dma_addr_t dma_addr;
1785         void *mem;
1786         struct nvme_id_ns *id_ns;
1787         u8 flbas;
1788
1789         /*
1790          * SCSI Expects a MODE SELECT would have been issued prior to
1791          * a FORMAT UNIT, and the block size and number would be used
1792          * from the block descriptor in it. If a MODE SELECT had not
1793          * been issued, FORMAT shall use the current values for both.
1794          */
1795
1796         if (ns->mode_select_num_blocks == 0 || ns->mode_select_block_len == 0) {
1797                 mem = dma_alloc_coherent(&dev->pci_dev->dev,
1798                         sizeof(struct nvme_id_ns), &dma_addr, GFP_KERNEL);
1799                 if (mem == NULL) {
1800                         res = -ENOMEM;
1801                         goto out;
1802                 }
1803                 /* nvme ns identify */
1804                 nvme_sc = nvme_identify(dev, ns->ns_id, 0, dma_addr);
1805                 res = nvme_trans_status_code(hdr, nvme_sc);
1806                 if (res)
1807                         goto out_dma;
1808                 if (nvme_sc) {
1809                         res = nvme_sc;
1810                         goto out_dma;
1811                 }
1812                 id_ns = mem;
1813
1814                 if (ns->mode_select_num_blocks == 0)
1815                         ns->mode_select_num_blocks = le64_to_cpu(id_ns->ncap);
1816                 if (ns->mode_select_block_len == 0) {
1817                         flbas = (id_ns->flbas) & 0x0F;
1818                         ns->mode_select_block_len =
1819                                                 (1 << (id_ns->lbaf[flbas].ds));
1820                 }
1821  out_dma:
1822                 dma_free_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ns),
1823                                   mem, dma_addr);
1824         }
1825  out:
1826         return res;
1827 }
1828
1829 static int nvme_trans_fmt_get_parm_header(struct sg_io_hdr *hdr, u8 len,
1830                                         u8 format_prot_info, u8 *nvme_pf_code)
1831 {
1832         int res = SNTI_TRANSLATION_SUCCESS;
1833         u8 *parm_list;
1834         u8 pf_usage, pf_code;
1835
1836         parm_list = kmalloc(len, GFP_KERNEL);
1837         if (parm_list == NULL) {
1838                 res = -ENOMEM;
1839                 goto out;
1840         }
1841         res = nvme_trans_copy_from_user(hdr, parm_list, len);
1842         if (res != SNTI_TRANSLATION_SUCCESS)
1843                 goto out_mem;
1844
1845         if ((parm_list[FORMAT_UNIT_IMMED_OFFSET] &
1846                                 FORMAT_UNIT_IMMED_MASK) != 0) {
1847                 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
1848                                         ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
1849                                         SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
1850                 goto out_mem;
1851         }
1852
1853         if (len == FORMAT_UNIT_LONG_PARM_LIST_LEN &&
1854             (parm_list[FORMAT_UNIT_PROT_INT_OFFSET] & 0x0F) != 0) {
1855                 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
1856                                         ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
1857                                         SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
1858                 goto out_mem;
1859         }
1860         pf_usage = parm_list[FORMAT_UNIT_PROT_FIELD_USAGE_OFFSET] &
1861                         FORMAT_UNIT_PROT_FIELD_USAGE_MASK;
1862         pf_code = (pf_usage << 2) | format_prot_info;
1863         switch (pf_code) {
1864         case 0:
1865                 *nvme_pf_code = 0;
1866                 break;
1867         case 2:
1868                 *nvme_pf_code = 1;
1869                 break;
1870         case 3:
1871                 *nvme_pf_code = 2;
1872                 break;
1873         case 7:
1874                 *nvme_pf_code = 3;
1875                 break;
1876         default:
1877                 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
1878                                         ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
1879                                         SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
1880                 break;
1881         }
1882
1883  out_mem:
1884         kfree(parm_list);
1885  out:
1886         return res;
1887 }
1888
1889 static int nvme_trans_fmt_send_cmd(struct nvme_ns *ns, struct sg_io_hdr *hdr,
1890                                    u8 prot_info)
1891 {
1892         int res = SNTI_TRANSLATION_SUCCESS;
1893         int nvme_sc;
1894         struct nvme_dev *dev = ns->dev;
1895         dma_addr_t dma_addr;
1896         void *mem;
1897         struct nvme_id_ns *id_ns;
1898         u8 i;
1899         u8 flbas, nlbaf;
1900         u8 selected_lbaf = 0xFF;
1901         u32 cdw10 = 0;
1902         struct nvme_command c;
1903
1904         /* Loop thru LBAF's in id_ns to match reqd lbaf, put in cdw10 */
1905         mem = dma_alloc_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ns),
1906                                                         &dma_addr, GFP_KERNEL);
1907         if (mem == NULL) {
1908                 res = -ENOMEM;
1909                 goto out;
1910         }
1911         /* nvme ns identify */
1912         nvme_sc = nvme_identify(dev, ns->ns_id, 0, dma_addr);
1913         res = nvme_trans_status_code(hdr, nvme_sc);
1914         if (res)
1915                 goto out_dma;
1916         if (nvme_sc) {
1917                 res = nvme_sc;
1918                 goto out_dma;
1919         }
1920         id_ns = mem;
1921         flbas = (id_ns->flbas) & 0x0F;
1922         nlbaf = id_ns->nlbaf;
1923
1924         for (i = 0; i < nlbaf; i++) {
1925                 if (ns->mode_select_block_len == (1 << (id_ns->lbaf[i].ds))) {
1926                         selected_lbaf = i;
1927                         break;
1928                 }
1929         }
1930         if (selected_lbaf > 0x0F) {
1931                 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
1932                                 ILLEGAL_REQUEST, SCSI_ASC_INVALID_PARAMETER,
1933                                 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
1934         }
1935         if (ns->mode_select_num_blocks != le64_to_cpu(id_ns->ncap)) {
1936                 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
1937                                 ILLEGAL_REQUEST, SCSI_ASC_INVALID_PARAMETER,
1938                                 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
1939         }
1940
1941         cdw10 |= prot_info << 5;
1942         cdw10 |= selected_lbaf & 0x0F;
1943         memset(&c, 0, sizeof(c));
1944         c.format.opcode = nvme_admin_format_nvm;
1945         c.format.nsid = cpu_to_le32(ns->ns_id);
1946         c.format.cdw10 = cpu_to_le32(cdw10);
1947
1948         nvme_sc = nvme_submit_admin_cmd(dev, &c, NULL);
1949         res = nvme_trans_status_code(hdr, nvme_sc);
1950         if (res)
1951                 goto out_dma;
1952         if (nvme_sc)
1953                 res = nvme_sc;
1954
1955  out_dma:
1956         dma_free_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ns), mem,
1957                           dma_addr);
1958  out:
1959         return res;
1960 }
1961
1962 /* Read/Write Helper Functions */
1963
1964 static inline void nvme_trans_get_io_cdb6(u8 *cmd,
1965                                         struct nvme_trans_io_cdb *cdb_info)
1966 {
1967         cdb_info->fua = 0;
1968         cdb_info->prot_info = 0;
1969         cdb_info->lba = GET_U32_FROM_CDB(cmd, IO_6_CDB_LBA_OFFSET) &
1970                                         IO_6_CDB_LBA_MASK;
1971         cdb_info->xfer_len = GET_U8_FROM_CDB(cmd, IO_6_CDB_TX_LEN_OFFSET);
1972
1973         /* sbc3r27 sec 5.32 - TRANSFER LEN of 0 implies a 256 Block transfer */
1974         if (cdb_info->xfer_len == 0)
1975                 cdb_info->xfer_len = IO_6_DEFAULT_TX_LEN;
1976 }
1977
1978 static inline void nvme_trans_get_io_cdb10(u8 *cmd,
1979                                         struct nvme_trans_io_cdb *cdb_info)
1980 {
1981         cdb_info->fua = GET_U8_FROM_CDB(cmd, IO_10_CDB_FUA_OFFSET) &
1982                                         IO_CDB_FUA_MASK;
1983         cdb_info->prot_info = GET_U8_FROM_CDB(cmd, IO_10_CDB_WP_OFFSET) &
1984                                         IO_CDB_WP_MASK >> IO_CDB_WP_SHIFT;
1985         cdb_info->lba = GET_U32_FROM_CDB(cmd, IO_10_CDB_LBA_OFFSET);
1986         cdb_info->xfer_len = GET_U16_FROM_CDB(cmd, IO_10_CDB_TX_LEN_OFFSET);
1987 }
1988
1989 static inline void nvme_trans_get_io_cdb12(u8 *cmd,
1990                                         struct nvme_trans_io_cdb *cdb_info)
1991 {
1992         cdb_info->fua = GET_U8_FROM_CDB(cmd, IO_12_CDB_FUA_OFFSET) &
1993                                         IO_CDB_FUA_MASK;
1994         cdb_info->prot_info = GET_U8_FROM_CDB(cmd, IO_12_CDB_WP_OFFSET) &
1995                                         IO_CDB_WP_MASK >> IO_CDB_WP_SHIFT;
1996         cdb_info->lba = GET_U32_FROM_CDB(cmd, IO_12_CDB_LBA_OFFSET);
1997         cdb_info->xfer_len = GET_U32_FROM_CDB(cmd, IO_12_CDB_TX_LEN_OFFSET);
1998 }
1999
2000 static inline void nvme_trans_get_io_cdb16(u8 *cmd,
2001                                         struct nvme_trans_io_cdb *cdb_info)
2002 {
2003         cdb_info->fua = GET_U8_FROM_CDB(cmd, IO_16_CDB_FUA_OFFSET) &
2004                                         IO_CDB_FUA_MASK;
2005         cdb_info->prot_info = GET_U8_FROM_CDB(cmd, IO_16_CDB_WP_OFFSET) &
2006                                         IO_CDB_WP_MASK >> IO_CDB_WP_SHIFT;
2007         cdb_info->lba = GET_U64_FROM_CDB(cmd, IO_16_CDB_LBA_OFFSET);
2008         cdb_info->xfer_len = GET_U32_FROM_CDB(cmd, IO_16_CDB_TX_LEN_OFFSET);
2009 }
2010
2011 static inline u32 nvme_trans_io_get_num_cmds(struct sg_io_hdr *hdr,
2012                                         struct nvme_trans_io_cdb *cdb_info,
2013                                         u32 max_blocks)
2014 {
2015         /* If using iovecs, send one nvme command per vector */
2016         if (hdr->iovec_count > 0)
2017                 return hdr->iovec_count;
2018         else if (cdb_info->xfer_len > max_blocks)
2019                 return ((cdb_info->xfer_len - 1) / max_blocks) + 1;
2020         else
2021                 return 1;
2022 }
2023
2024 static u16 nvme_trans_io_get_control(struct nvme_ns *ns,
2025                                         struct nvme_trans_io_cdb *cdb_info)
2026 {
2027         u16 control = 0;
2028
2029         /* When Protection information support is added, implement here */
2030
2031         if (cdb_info->fua > 0)
2032                 control |= NVME_RW_FUA;
2033
2034         return control;
2035 }
2036
2037 static int nvme_trans_do_nvme_io(struct nvme_ns *ns, struct sg_io_hdr *hdr,
2038                                 struct nvme_trans_io_cdb *cdb_info, u8 is_write)
2039 {
2040         int res = SNTI_TRANSLATION_SUCCESS;
2041         int nvme_sc;
2042         struct nvme_dev *dev = ns->dev;
2043         struct nvme_queue *nvmeq;
2044         u32 num_cmds;
2045         struct nvme_iod *iod;
2046         u64 unit_len;
2047         u64 unit_num_blocks;    /* Number of blocks to xfer in each nvme cmd */
2048         u32 retcode;
2049         u32 i = 0;
2050         u64 nvme_offset = 0;
2051         void __user *next_mapping_addr;
2052         struct nvme_command c;
2053         u8 opcode = (is_write ? nvme_cmd_write : nvme_cmd_read);
2054         u16 control;
2055         u32 max_blocks = nvme_block_nr(ns, dev->max_hw_sectors);
2056
2057         num_cmds = nvme_trans_io_get_num_cmds(hdr, cdb_info, max_blocks);
2058
2059         /*
2060          * This loop handles two cases.
2061          * First, when an SGL is used in the form of an iovec list:
2062          *   - Use iov_base as the next mapping address for the nvme command_id
2063          *   - Use iov_len as the data transfer length for the command.
2064          * Second, when we have a single buffer
2065          *   - If larger than max_blocks, split into chunks, offset
2066          *        each nvme command accordingly.
2067          */
2068         for (i = 0; i < num_cmds; i++) {
2069                 memset(&c, 0, sizeof(c));
2070                 if (hdr->iovec_count > 0) {
2071                         struct sg_iovec sgl;
2072
2073                         retcode = copy_from_user(&sgl, hdr->dxferp +
2074                                         i * sizeof(struct sg_iovec),
2075                                         sizeof(struct sg_iovec));
2076                         if (retcode)
2077                                 return -EFAULT;
2078                         unit_len = sgl.iov_len;
2079                         unit_num_blocks = unit_len >> ns->lba_shift;
2080                         next_mapping_addr = sgl.iov_base;
2081                 } else {
2082                         unit_num_blocks = min((u64)max_blocks,
2083                                         (cdb_info->xfer_len - nvme_offset));
2084                         unit_len = unit_num_blocks << ns->lba_shift;
2085                         next_mapping_addr = hdr->dxferp +
2086                                         ((1 << ns->lba_shift) * nvme_offset);
2087                 }
2088
2089                 c.rw.opcode = opcode;
2090                 c.rw.nsid = cpu_to_le32(ns->ns_id);
2091                 c.rw.slba = cpu_to_le64(cdb_info->lba + nvme_offset);
2092                 c.rw.length = cpu_to_le16(unit_num_blocks - 1);
2093                 control = nvme_trans_io_get_control(ns, cdb_info);
2094                 c.rw.control = cpu_to_le16(control);
2095
2096                 iod = nvme_map_user_pages(dev,
2097                         (is_write) ? DMA_TO_DEVICE : DMA_FROM_DEVICE,
2098                         (unsigned long)next_mapping_addr, unit_len);
2099                 if (IS_ERR(iod)) {
2100                         res = PTR_ERR(iod);
2101                         goto out;
2102                 }
2103                 retcode = nvme_setup_prps(dev, &c.common, iod, unit_len,
2104                                                         GFP_KERNEL);
2105                 if (retcode != unit_len) {
2106                         nvme_unmap_user_pages(dev,
2107                                 (is_write) ? DMA_TO_DEVICE : DMA_FROM_DEVICE,
2108                                 iod);
2109                         nvme_free_iod(dev, iod);
2110                         res = -ENOMEM;
2111                         goto out;
2112                 }
2113
2114                 nvme_offset += unit_num_blocks;
2115
2116                 nvmeq = get_nvmeq(dev);
2117                 /*
2118                  * Since nvme_submit_sync_cmd sleeps, we can't keep
2119                  * preemption disabled.  We may be preempted at any
2120                  * point, and be rescheduled to a different CPU.  That
2121                  * will cause cacheline bouncing, but no additional
2122                  * races since q_lock already protects against other
2123                  * CPUs.
2124                  */
2125                 put_nvmeq(nvmeq);
2126                 nvme_sc = nvme_submit_sync_cmd(nvmeq, &c, NULL,
2127                                                 NVME_IO_TIMEOUT);
2128                 if (nvme_sc != NVME_SC_SUCCESS) {
2129                         nvme_unmap_user_pages(dev,
2130                                 (is_write) ? DMA_TO_DEVICE : DMA_FROM_DEVICE,
2131                                 iod);
2132                         nvme_free_iod(dev, iod);
2133                         res = nvme_trans_status_code(hdr, nvme_sc);
2134                         goto out;
2135                 }
2136                 nvme_unmap_user_pages(dev,
2137                                 (is_write) ? DMA_TO_DEVICE : DMA_FROM_DEVICE,
2138                                 iod);
2139                 nvme_free_iod(dev, iod);
2140         }
2141         res = nvme_trans_status_code(hdr, NVME_SC_SUCCESS);
2142
2143  out:
2144         return res;
2145 }
2146
2147
2148 /* SCSI Command Translation Functions */
2149
2150 static int nvme_trans_io(struct nvme_ns *ns, struct sg_io_hdr *hdr, u8 is_write,
2151                                                         u8 *cmd)
2152 {
2153         int res = SNTI_TRANSLATION_SUCCESS;
2154         struct nvme_trans_io_cdb cdb_info;
2155         u8 opcode = cmd[0];
2156         u64 xfer_bytes;
2157         u64 sum_iov_len = 0;
2158         struct sg_iovec sgl;
2159         int i;
2160         size_t not_copied;
2161
2162         /* Extract Fields from CDB */
2163         switch (opcode) {
2164         case WRITE_6:
2165         case READ_6:
2166                 nvme_trans_get_io_cdb6(cmd, &cdb_info);
2167                 break;
2168         case WRITE_10:
2169         case READ_10:
2170                 nvme_trans_get_io_cdb10(cmd, &cdb_info);
2171                 break;
2172         case WRITE_12:
2173         case READ_12:
2174                 nvme_trans_get_io_cdb12(cmd, &cdb_info);
2175                 break;
2176         case WRITE_16:
2177         case READ_16:
2178                 nvme_trans_get_io_cdb16(cmd, &cdb_info);
2179                 break;
2180         default:
2181                 /* Will never really reach here */
2182                 res = SNTI_INTERNAL_ERROR;
2183                 goto out;
2184         }
2185
2186         /* Calculate total length of transfer (in bytes) */
2187         if (hdr->iovec_count > 0) {
2188                 for (i = 0; i < hdr->iovec_count; i++) {
2189                         not_copied = copy_from_user(&sgl, hdr->dxferp +
2190                                                 i * sizeof(struct sg_iovec),
2191                                                 sizeof(struct sg_iovec));
2192                         if (not_copied)
2193                                 return -EFAULT;
2194                         sum_iov_len += sgl.iov_len;
2195                         /* IO vector sizes should be multiples of block size */
2196                         if (sgl.iov_len % (1 << ns->lba_shift) != 0) {
2197                                 res = nvme_trans_completion(hdr,
2198                                                 SAM_STAT_CHECK_CONDITION,
2199                                                 ILLEGAL_REQUEST,
2200                                                 SCSI_ASC_INVALID_PARAMETER,
2201                                                 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2202                                 goto out;
2203                         }
2204                 }
2205         } else {
2206                 sum_iov_len = hdr->dxfer_len;
2207         }
2208
2209         /* As Per sg ioctl howto, if the lengths differ, use the lower one */
2210         xfer_bytes = min(((u64)hdr->dxfer_len), sum_iov_len);
2211
2212         /* If block count and actual data buffer size dont match, error out */
2213         if (xfer_bytes != (cdb_info.xfer_len << ns->lba_shift)) {
2214                 res = -EINVAL;
2215                 goto out;
2216         }
2217
2218         /* Check for 0 length transfer - it is not illegal */
2219         if (cdb_info.xfer_len == 0)
2220                 goto out;
2221
2222         /* Send NVMe IO Command(s) */
2223         res = nvme_trans_do_nvme_io(ns, hdr, &cdb_info, is_write);
2224         if (res != SNTI_TRANSLATION_SUCCESS)
2225                 goto out;
2226
2227  out:
2228         return res;
2229 }
2230
2231 static int nvme_trans_inquiry(struct nvme_ns *ns, struct sg_io_hdr *hdr,
2232                                                         u8 *cmd)
2233 {
2234         int res = SNTI_TRANSLATION_SUCCESS;
2235         u8 evpd;
2236         u8 page_code;
2237         int alloc_len;
2238         u8 *inq_response;
2239
2240         evpd = GET_INQ_EVPD_BIT(cmd);
2241         page_code = GET_INQ_PAGE_CODE(cmd);
2242         alloc_len = GET_INQ_ALLOC_LENGTH(cmd);
2243
2244         inq_response = kmalloc(STANDARD_INQUIRY_LENGTH, GFP_KERNEL);
2245         if (inq_response == NULL) {
2246                 res = -ENOMEM;
2247                 goto out_mem;
2248         }
2249
2250         if (evpd == 0) {
2251                 if (page_code == INQ_STANDARD_INQUIRY_PAGE) {
2252                         res = nvme_trans_standard_inquiry_page(ns, hdr,
2253                                                 inq_response, alloc_len);
2254                 } else {
2255                         res = nvme_trans_completion(hdr,
2256                                                 SAM_STAT_CHECK_CONDITION,
2257                                                 ILLEGAL_REQUEST,
2258                                                 SCSI_ASC_INVALID_CDB,
2259                                                 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2260                 }
2261         } else {
2262                 switch (page_code) {
2263                 case VPD_SUPPORTED_PAGES:
2264                         res = nvme_trans_supported_vpd_pages(ns, hdr,
2265                                                 inq_response, alloc_len);
2266                         break;
2267                 case VPD_SERIAL_NUMBER:
2268                         res = nvme_trans_unit_serial_page(ns, hdr, inq_response,
2269                                                                 alloc_len);
2270                         break;
2271                 case VPD_DEVICE_IDENTIFIERS:
2272                         res = nvme_trans_device_id_page(ns, hdr, inq_response,
2273                                                                 alloc_len);
2274                         break;
2275                 case VPD_EXTENDED_INQUIRY:
2276                         res = nvme_trans_ext_inq_page(ns, hdr, alloc_len);
2277                         break;
2278                 case VPD_BLOCK_DEV_CHARACTERISTICS:
2279                         res = nvme_trans_bdev_char_page(ns, hdr, alloc_len);
2280                         break;
2281                 default:
2282                         res = nvme_trans_completion(hdr,
2283                                                 SAM_STAT_CHECK_CONDITION,
2284                                                 ILLEGAL_REQUEST,
2285                                                 SCSI_ASC_INVALID_CDB,
2286                                                 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2287                         break;
2288                 }
2289         }
2290         kfree(inq_response);
2291  out_mem:
2292         return res;
2293 }
2294
2295 static int nvme_trans_log_sense(struct nvme_ns *ns, struct sg_io_hdr *hdr,
2296                                                         u8 *cmd)
2297 {
2298         int res = SNTI_TRANSLATION_SUCCESS;
2299         u16 alloc_len;
2300         u8 sp;
2301         u8 pc;
2302         u8 page_code;
2303
2304         sp = GET_U8_FROM_CDB(cmd, LOG_SENSE_CDB_SP_OFFSET);
2305         if (sp != LOG_SENSE_CDB_SP_NOT_ENABLED) {
2306                 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2307                                         ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
2308                                         SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2309                 goto out;
2310         }
2311         pc = GET_U8_FROM_CDB(cmd, LOG_SENSE_CDB_PC_OFFSET);
2312         page_code = pc & LOG_SENSE_CDB_PAGE_CODE_MASK;
2313         pc = (pc & LOG_SENSE_CDB_PC_MASK) >> LOG_SENSE_CDB_PC_SHIFT;
2314         if (pc != LOG_SENSE_CDB_PC_CUMULATIVE_VALUES) {
2315                 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2316                                         ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
2317                                         SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2318                 goto out;
2319         }
2320         alloc_len = GET_U16_FROM_CDB(cmd, LOG_SENSE_CDB_ALLOC_LENGTH_OFFSET);
2321         switch (page_code) {
2322         case LOG_PAGE_SUPPORTED_LOG_PAGES_PAGE:
2323                 res = nvme_trans_log_supp_pages(ns, hdr, alloc_len);
2324                 break;
2325         case LOG_PAGE_INFORMATIONAL_EXCEPTIONS_PAGE:
2326                 res = nvme_trans_log_info_exceptions(ns, hdr, alloc_len);
2327                 break;
2328         case LOG_PAGE_TEMPERATURE_PAGE:
2329                 res = nvme_trans_log_temperature(ns, hdr, alloc_len);
2330                 break;
2331         default:
2332                 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2333                                         ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
2334                                         SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2335                 break;
2336         }
2337
2338  out:
2339         return res;
2340 }
2341
2342 static int nvme_trans_mode_select(struct nvme_ns *ns, struct sg_io_hdr *hdr,
2343                                                         u8 *cmd)
2344 {
2345         int res = SNTI_TRANSLATION_SUCCESS;
2346         u8 cdb10 = 0;
2347         u16 parm_list_len;
2348         u8 page_format;
2349         u8 save_pages;
2350
2351         page_format = GET_U8_FROM_CDB(cmd, MODE_SELECT_CDB_PAGE_FORMAT_OFFSET);
2352         page_format &= MODE_SELECT_CDB_PAGE_FORMAT_MASK;
2353
2354         save_pages = GET_U8_FROM_CDB(cmd, MODE_SELECT_CDB_SAVE_PAGES_OFFSET);
2355         save_pages &= MODE_SELECT_CDB_SAVE_PAGES_MASK;
2356
2357         if (GET_OPCODE(cmd) == MODE_SELECT) {
2358                 parm_list_len = GET_U8_FROM_CDB(cmd,
2359                                 MODE_SELECT_6_CDB_PARAM_LIST_LENGTH_OFFSET);
2360         } else {
2361                 parm_list_len = GET_U16_FROM_CDB(cmd,
2362                                 MODE_SELECT_10_CDB_PARAM_LIST_LENGTH_OFFSET);
2363                 cdb10 = 1;
2364         }
2365
2366         if (parm_list_len != 0) {
2367                 /*
2368                  * According to SPC-4 r24, a paramter list length field of 0
2369                  * shall not be considered an error
2370                  */
2371                 res = nvme_trans_modesel_data(ns, hdr, cmd, parm_list_len,
2372                                                 page_format, save_pages, cdb10);
2373         }
2374
2375         return res;
2376 }
2377
2378 static int nvme_trans_mode_sense(struct nvme_ns *ns, struct sg_io_hdr *hdr,
2379                                                         u8 *cmd)
2380 {
2381         int res = SNTI_TRANSLATION_SUCCESS;
2382         u16 alloc_len;
2383         u8 cdb10 = 0;
2384         u8 page_code;
2385         u8 pc;
2386
2387         if (GET_OPCODE(cmd) == MODE_SENSE) {
2388                 alloc_len = GET_U8_FROM_CDB(cmd, MODE_SENSE6_ALLOC_LEN_OFFSET);
2389         } else {
2390                 alloc_len = GET_U16_FROM_CDB(cmd,
2391                                                 MODE_SENSE10_ALLOC_LEN_OFFSET);
2392                 cdb10 = 1;
2393         }
2394
2395         pc = GET_U8_FROM_CDB(cmd, MODE_SENSE_PAGE_CONTROL_OFFSET) &
2396                                                 MODE_SENSE_PAGE_CONTROL_MASK;
2397         if (pc != MODE_SENSE_PC_CURRENT_VALUES) {
2398                 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2399                                         ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
2400                                         SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2401                 goto out;
2402         }
2403
2404         page_code = GET_U8_FROM_CDB(cmd, MODE_SENSE_PAGE_CODE_OFFSET) &
2405                                         MODE_SENSE_PAGE_CODE_MASK;
2406         switch (page_code) {
2407         case MODE_PAGE_CACHING:
2408                 res = nvme_trans_mode_page_create(ns, hdr, cmd, alloc_len,
2409                                                 cdb10,
2410                                                 &nvme_trans_fill_caching_page,
2411                                                 MODE_PAGE_CACHING_LEN);
2412                 break;
2413         case MODE_PAGE_CONTROL:
2414                 res = nvme_trans_mode_page_create(ns, hdr, cmd, alloc_len,
2415                                                 cdb10,
2416                                                 &nvme_trans_fill_control_page,
2417                                                 MODE_PAGE_CONTROL_LEN);
2418                 break;
2419         case MODE_PAGE_POWER_CONDITION:
2420                 res = nvme_trans_mode_page_create(ns, hdr, cmd, alloc_len,
2421                                                 cdb10,
2422                                                 &nvme_trans_fill_pow_cnd_page,
2423                                                 MODE_PAGE_POW_CND_LEN);
2424                 break;
2425         case MODE_PAGE_INFO_EXCEP:
2426                 res = nvme_trans_mode_page_create(ns, hdr, cmd, alloc_len,
2427                                                 cdb10,
2428                                                 &nvme_trans_fill_inf_exc_page,
2429                                                 MODE_PAGE_INF_EXC_LEN);
2430                 break;
2431         case MODE_PAGE_RETURN_ALL:
2432                 res = nvme_trans_mode_page_create(ns, hdr, cmd, alloc_len,
2433                                                 cdb10,
2434                                                 &nvme_trans_fill_all_pages,
2435                                                 MODE_PAGE_ALL_LEN);
2436                 break;
2437         default:
2438                 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2439                                         ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
2440                                         SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2441                 break;
2442         }
2443
2444  out:
2445         return res;
2446 }
2447
2448 static int nvme_trans_read_capacity(struct nvme_ns *ns, struct sg_io_hdr *hdr,
2449                                                         u8 *cmd)
2450 {
2451         int res = SNTI_TRANSLATION_SUCCESS;
2452         int nvme_sc;
2453         u32 alloc_len = READ_CAP_10_RESP_SIZE;
2454         u32 resp_size = READ_CAP_10_RESP_SIZE;
2455         u32 xfer_len;
2456         u8 cdb16;
2457         struct nvme_dev *dev = ns->dev;
2458         dma_addr_t dma_addr;
2459         void *mem;
2460         struct nvme_id_ns *id_ns;
2461         u8 *response;
2462
2463         cdb16 = IS_READ_CAP_16(cmd);
2464         if (cdb16) {
2465                 alloc_len = GET_READ_CAP_16_ALLOC_LENGTH(cmd);
2466                 resp_size = READ_CAP_16_RESP_SIZE;
2467         }
2468
2469         mem = dma_alloc_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ns),
2470                                                         &dma_addr, GFP_KERNEL);
2471         if (mem == NULL) {
2472                 res = -ENOMEM;
2473                 goto out;
2474         }
2475         /* nvme ns identify */
2476         nvme_sc = nvme_identify(dev, ns->ns_id, 0, dma_addr);
2477         res = nvme_trans_status_code(hdr, nvme_sc);
2478         if (res)
2479                 goto out_dma;
2480         if (nvme_sc) {
2481                 res = nvme_sc;
2482                 goto out_dma;
2483         }
2484         id_ns = mem;
2485
2486         response = kmalloc(resp_size, GFP_KERNEL);
2487         if (response == NULL) {
2488                 res = -ENOMEM;
2489                 goto out_dma;
2490         }
2491         memset(response, 0, resp_size);
2492         nvme_trans_fill_read_cap(response, id_ns, cdb16);
2493
2494         xfer_len = min(alloc_len, resp_size);
2495         res = nvme_trans_copy_to_user(hdr, response, xfer_len);
2496
2497         kfree(response);
2498  out_dma:
2499         dma_free_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ns), mem,
2500                           dma_addr);
2501  out:
2502         return res;
2503 }
2504
2505 static int nvme_trans_report_luns(struct nvme_ns *ns, struct sg_io_hdr *hdr,
2506                                                         u8 *cmd)
2507 {
2508         int res = SNTI_TRANSLATION_SUCCESS;
2509         int nvme_sc;
2510         u32 alloc_len, xfer_len, resp_size;
2511         u8 select_report;
2512         u8 *response;
2513         struct nvme_dev *dev = ns->dev;
2514         dma_addr_t dma_addr;
2515         void *mem;
2516         struct nvme_id_ctrl *id_ctrl;
2517         u32 ll_length, lun_id;
2518         u8 lun_id_offset = REPORT_LUNS_FIRST_LUN_OFFSET;
2519         __be32 tmp_len;
2520
2521         alloc_len = GET_REPORT_LUNS_ALLOC_LENGTH(cmd);
2522         select_report = GET_U8_FROM_CDB(cmd, REPORT_LUNS_SR_OFFSET);
2523
2524         if ((select_report != ALL_LUNS_RETURNED) &&
2525             (select_report != ALL_WELL_KNOWN_LUNS_RETURNED) &&
2526             (select_report != RESTRICTED_LUNS_RETURNED)) {
2527                 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2528                                         ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
2529                                         SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2530                 goto out;
2531         } else {
2532                 /* NVMe Controller Identify */
2533                 mem = dma_alloc_coherent(&dev->pci_dev->dev,
2534                                         sizeof(struct nvme_id_ctrl),
2535                                         &dma_addr, GFP_KERNEL);
2536                 if (mem == NULL) {
2537                         res = -ENOMEM;
2538                         goto out;
2539                 }
2540                 nvme_sc = nvme_identify(dev, 0, 1, dma_addr);
2541                 res = nvme_trans_status_code(hdr, nvme_sc);
2542                 if (res)
2543                         goto out_dma;
2544                 if (nvme_sc) {
2545                         res = nvme_sc;
2546                         goto out_dma;
2547                 }
2548                 id_ctrl = mem;
2549                 ll_length = le32_to_cpu(id_ctrl->nn) * LUN_ENTRY_SIZE;
2550                 resp_size = ll_length + LUN_DATA_HEADER_SIZE;
2551
2552                 if (alloc_len < resp_size) {
2553                         res = nvme_trans_completion(hdr,
2554                                         SAM_STAT_CHECK_CONDITION,
2555                                         ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
2556                                         SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2557                         goto out_dma;
2558                 }
2559
2560                 response = kmalloc(resp_size, GFP_KERNEL);
2561                 if (response == NULL) {
2562                         res = -ENOMEM;
2563                         goto out_dma;
2564                 }
2565                 memset(response, 0, resp_size);
2566
2567                 /* The first LUN ID will always be 0 per the SAM spec */
2568                 for (lun_id = 0; lun_id < le32_to_cpu(id_ctrl->nn); lun_id++) {
2569                         /*
2570                          * Set the LUN Id and then increment to the next LUN
2571                          * location in the parameter data.
2572                          */
2573                         __be64 tmp_id = cpu_to_be64(lun_id);
2574                         memcpy(&response[lun_id_offset], &tmp_id, sizeof(u64));
2575                         lun_id_offset += LUN_ENTRY_SIZE;
2576                 }
2577                 tmp_len = cpu_to_be32(ll_length);
2578                 memcpy(response, &tmp_len, sizeof(u32));
2579         }
2580
2581         xfer_len = min(alloc_len, resp_size);
2582         res = nvme_trans_copy_to_user(hdr, response, xfer_len);
2583
2584         kfree(response);
2585  out_dma:
2586         dma_free_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ctrl), mem,
2587                           dma_addr);
2588  out:
2589         return res;
2590 }
2591
2592 static int nvme_trans_request_sense(struct nvme_ns *ns, struct sg_io_hdr *hdr,
2593                                                         u8 *cmd)
2594 {
2595         int res = SNTI_TRANSLATION_SUCCESS;
2596         u8 alloc_len, xfer_len, resp_size;
2597         u8 desc_format;
2598         u8 *response;
2599
2600         alloc_len = GET_REQUEST_SENSE_ALLOC_LENGTH(cmd);
2601         desc_format = GET_U8_FROM_CDB(cmd, REQUEST_SENSE_DESC_OFFSET);
2602         desc_format &= REQUEST_SENSE_DESC_MASK;
2603
2604         resp_size = ((desc_format) ? (DESC_FMT_SENSE_DATA_SIZE) :
2605                                         (FIXED_FMT_SENSE_DATA_SIZE));
2606         response = kmalloc(resp_size, GFP_KERNEL);
2607         if (response == NULL) {
2608                 res = -ENOMEM;
2609                 goto out;
2610         }
2611         memset(response, 0, resp_size);
2612
2613         if (desc_format == DESCRIPTOR_FORMAT_SENSE_DATA_TYPE) {
2614                 /* Descriptor Format Sense Data */
2615                 response[0] = DESC_FORMAT_SENSE_DATA;
2616                 response[1] = NO_SENSE;
2617                 /* TODO How is LOW POWER CONDITION ON handled? (byte 2) */
2618                 response[2] = SCSI_ASC_NO_SENSE;
2619                 response[3] = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
2620                 /* SDAT_OVFL = 0 | Additional Sense Length = 0 */
2621         } else {
2622                 /* Fixed Format Sense Data */
2623                 response[0] = FIXED_SENSE_DATA;
2624                 /* Byte 1 = Obsolete */
2625                 response[2] = NO_SENSE; /* FM, EOM, ILI, SDAT_OVFL = 0 */
2626                 /* Bytes 3-6 - Information - set to zero */
2627                 response[7] = FIXED_SENSE_DATA_ADD_LENGTH;
2628                 /* Bytes 8-11 - Cmd Specific Information - set to zero */
2629                 response[12] = SCSI_ASC_NO_SENSE;
2630                 response[13] = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
2631                 /* Byte 14 = Field Replaceable Unit Code = 0 */
2632                 /* Bytes 15-17 - SKSV=0; Sense Key Specific = 0 */
2633         }
2634
2635         xfer_len = min(alloc_len, resp_size);
2636         res = nvme_trans_copy_to_user(hdr, response, xfer_len);
2637
2638         kfree(response);
2639  out:
2640         return res;
2641 }
2642
2643 static int nvme_trans_security_protocol(struct nvme_ns *ns,
2644                                         struct sg_io_hdr *hdr,
2645                                         u8 *cmd)
2646 {
2647         return nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2648                                 ILLEGAL_REQUEST, SCSI_ASC_ILLEGAL_COMMAND,
2649                                 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2650 }
2651
2652 static int nvme_trans_start_stop(struct nvme_ns *ns, struct sg_io_hdr *hdr,
2653                                                         u8 *cmd)
2654 {
2655         int res = SNTI_TRANSLATION_SUCCESS;
2656         int nvme_sc;
2657         struct nvme_queue *nvmeq;
2658         struct nvme_command c;
2659         u8 immed, pcmod, pc, no_flush, start;
2660
2661         immed = GET_U8_FROM_CDB(cmd, START_STOP_UNIT_CDB_IMMED_OFFSET);
2662         pcmod = GET_U8_FROM_CDB(cmd, START_STOP_UNIT_CDB_POWER_COND_MOD_OFFSET);
2663         pc = GET_U8_FROM_CDB(cmd, START_STOP_UNIT_CDB_POWER_COND_OFFSET);
2664         no_flush = GET_U8_FROM_CDB(cmd, START_STOP_UNIT_CDB_NO_FLUSH_OFFSET);
2665         start = GET_U8_FROM_CDB(cmd, START_STOP_UNIT_CDB_START_OFFSET);
2666
2667         immed &= START_STOP_UNIT_CDB_IMMED_MASK;
2668         pcmod &= START_STOP_UNIT_CDB_POWER_COND_MOD_MASK;
2669         pc = (pc & START_STOP_UNIT_CDB_POWER_COND_MASK) >> NIBBLE_SHIFT;
2670         no_flush &= START_STOP_UNIT_CDB_NO_FLUSH_MASK;
2671         start &= START_STOP_UNIT_CDB_START_MASK;
2672
2673         if (immed != 0) {
2674                 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2675                                         ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
2676                                         SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2677         } else {
2678                 if (no_flush == 0) {
2679                         /* Issue NVME FLUSH command prior to START STOP UNIT */
2680                         memset(&c, 0, sizeof(c));
2681                         c.common.opcode = nvme_cmd_flush;
2682                         c.common.nsid = cpu_to_le32(ns->ns_id);
2683
2684                         nvmeq = get_nvmeq(ns->dev);
2685                         put_nvmeq(nvmeq);
2686                         nvme_sc = nvme_submit_sync_cmd(nvmeq, &c, NULL, NVME_IO_TIMEOUT);
2687
2688                         res = nvme_trans_status_code(hdr, nvme_sc);
2689                         if (res)
2690                                 goto out;
2691                         if (nvme_sc) {
2692                                 res = nvme_sc;
2693                                 goto out;
2694                         }
2695                 }
2696                 /* Setup the expected power state transition */
2697                 res = nvme_trans_power_state(ns, hdr, pc, pcmod, start);
2698         }
2699
2700  out:
2701         return res;
2702 }
2703
2704 static int nvme_trans_synchronize_cache(struct nvme_ns *ns,
2705                                         struct sg_io_hdr *hdr, u8 *cmd)
2706 {
2707         int res = SNTI_TRANSLATION_SUCCESS;
2708         int nvme_sc;
2709         struct nvme_command c;
2710         struct nvme_queue *nvmeq;
2711
2712         memset(&c, 0, sizeof(c));
2713         c.common.opcode = nvme_cmd_flush;
2714         c.common.nsid = cpu_to_le32(ns->ns_id);
2715
2716         nvmeq = get_nvmeq(ns->dev);
2717         put_nvmeq(nvmeq);
2718         nvme_sc = nvme_submit_sync_cmd(nvmeq, &c, NULL, NVME_IO_TIMEOUT);
2719
2720         res = nvme_trans_status_code(hdr, nvme_sc);
2721         if (res)
2722                 goto out;
2723         if (nvme_sc)
2724                 res = nvme_sc;
2725
2726  out:
2727         return res;
2728 }
2729
2730 static int nvme_trans_format_unit(struct nvme_ns *ns, struct sg_io_hdr *hdr,
2731                                                         u8 *cmd)
2732 {
2733         int res = SNTI_TRANSLATION_SUCCESS;
2734         u8 parm_hdr_len = 0;
2735         u8 nvme_pf_code = 0;
2736         u8 format_prot_info, long_list, format_data;
2737
2738         format_prot_info = GET_U8_FROM_CDB(cmd,
2739                                 FORMAT_UNIT_CDB_FORMAT_PROT_INFO_OFFSET);
2740         long_list = GET_U8_FROM_CDB(cmd, FORMAT_UNIT_CDB_LONG_LIST_OFFSET);
2741         format_data = GET_U8_FROM_CDB(cmd, FORMAT_UNIT_CDB_FORMAT_DATA_OFFSET);
2742
2743         format_prot_info = (format_prot_info &
2744                                 FORMAT_UNIT_CDB_FORMAT_PROT_INFO_MASK) >>
2745                                 FORMAT_UNIT_CDB_FORMAT_PROT_INFO_SHIFT;
2746         long_list &= FORMAT_UNIT_CDB_LONG_LIST_MASK;
2747         format_data &= FORMAT_UNIT_CDB_FORMAT_DATA_MASK;
2748
2749         if (format_data != 0) {
2750                 if (format_prot_info != 0) {
2751                         if (long_list == 0)
2752                                 parm_hdr_len = FORMAT_UNIT_SHORT_PARM_LIST_LEN;
2753                         else
2754                                 parm_hdr_len = FORMAT_UNIT_LONG_PARM_LIST_LEN;
2755                 }
2756         } else if (format_data == 0 && format_prot_info != 0) {
2757                 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2758                                         ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
2759                                         SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2760                 goto out;
2761         }
2762
2763         /* Get parm header from data-in/out buffer */
2764         /*
2765          * According to the translation spec, the only fields in the parameter
2766          * list we are concerned with are in the header. So allocate only that.
2767          */
2768         if (parm_hdr_len > 0) {
2769                 res = nvme_trans_fmt_get_parm_header(hdr, parm_hdr_len,
2770                                         format_prot_info, &nvme_pf_code);
2771                 if (res != SNTI_TRANSLATION_SUCCESS)
2772                         goto out;
2773         }
2774
2775         /* Attempt to activate any previously downloaded firmware image */
2776         res = nvme_trans_send_fw_cmd(ns, hdr, nvme_admin_activate_fw, 0, 0, 0);
2777
2778         /* Determine Block size and count and send format command */
2779         res = nvme_trans_fmt_set_blk_size_count(ns, hdr);
2780         if (res != SNTI_TRANSLATION_SUCCESS)
2781                 goto out;
2782
2783         res = nvme_trans_fmt_send_cmd(ns, hdr, nvme_pf_code);
2784
2785  out:
2786         return res;
2787 }
2788
2789 static int nvme_trans_test_unit_ready(struct nvme_ns *ns,
2790                                         struct sg_io_hdr *hdr,
2791                                         u8 *cmd)
2792 {
2793         int res = SNTI_TRANSLATION_SUCCESS;
2794         struct nvme_dev *dev = ns->dev;
2795
2796         if (!(readl(&dev->bar->csts) & NVME_CSTS_RDY))
2797                 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2798                                             NOT_READY, SCSI_ASC_LUN_NOT_READY,
2799                                             SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2800         else
2801                 res = nvme_trans_completion(hdr, SAM_STAT_GOOD, NO_SENSE, 0, 0);
2802
2803         return res;
2804 }
2805
2806 static int nvme_trans_write_buffer(struct nvme_ns *ns, struct sg_io_hdr *hdr,
2807                                                         u8 *cmd)
2808 {
2809         int res = SNTI_TRANSLATION_SUCCESS;
2810         u32 buffer_offset, parm_list_length;
2811         u8 buffer_id, mode;
2812
2813         parm_list_length =
2814                 GET_U24_FROM_CDB(cmd, WRITE_BUFFER_CDB_PARM_LIST_LENGTH_OFFSET);
2815         if (parm_list_length % BYTES_TO_DWORDS != 0) {
2816                 /* NVMe expects Firmware file to be a whole number of DWORDS */
2817                 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2818                                         ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
2819                                         SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2820                 goto out;
2821         }
2822         buffer_id = GET_U8_FROM_CDB(cmd, WRITE_BUFFER_CDB_BUFFER_ID_OFFSET);
2823         if (buffer_id > NVME_MAX_FIRMWARE_SLOT) {
2824                 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2825                                         ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
2826                                         SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2827                 goto out;
2828         }
2829         mode = GET_U8_FROM_CDB(cmd, WRITE_BUFFER_CDB_MODE_OFFSET) &
2830                                                 WRITE_BUFFER_CDB_MODE_MASK;
2831         buffer_offset =
2832                 GET_U24_FROM_CDB(cmd, WRITE_BUFFER_CDB_BUFFER_OFFSET_OFFSET);
2833
2834         switch (mode) {
2835         case DOWNLOAD_SAVE_ACTIVATE:
2836                 res = nvme_trans_send_fw_cmd(ns, hdr, nvme_admin_download_fw,
2837                                                 parm_list_length, buffer_offset,
2838                                                 buffer_id);
2839                 if (res != SNTI_TRANSLATION_SUCCESS)
2840                         goto out;
2841                 res = nvme_trans_send_fw_cmd(ns, hdr, nvme_admin_activate_fw,
2842                                                 parm_list_length, buffer_offset,
2843                                                 buffer_id);
2844                 break;
2845         case DOWNLOAD_SAVE_DEFER_ACTIVATE:
2846                 res = nvme_trans_send_fw_cmd(ns, hdr, nvme_admin_download_fw,
2847                                                 parm_list_length, buffer_offset,
2848                                                 buffer_id);
2849                 break;
2850         case ACTIVATE_DEFERRED_MICROCODE:
2851                 res = nvme_trans_send_fw_cmd(ns, hdr, nvme_admin_activate_fw,
2852                                                 parm_list_length, buffer_offset,
2853                                                 buffer_id);
2854                 break;
2855         default:
2856                 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2857                                         ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
2858                                         SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2859                 break;
2860         }
2861
2862  out:
2863         return res;
2864 }
2865
2866 struct scsi_unmap_blk_desc {
2867         __be64  slba;
2868         __be32  nlb;
2869         u32     resv;
2870 };
2871
2872 struct scsi_unmap_parm_list {
2873         __be16  unmap_data_len;
2874         __be16  unmap_blk_desc_data_len;
2875         u32     resv;
2876         struct scsi_unmap_blk_desc desc[0];
2877 };
2878
2879 static int nvme_trans_unmap(struct nvme_ns *ns, struct sg_io_hdr *hdr,
2880                                                         u8 *cmd)
2881 {
2882         struct nvme_dev *dev = ns->dev;
2883         struct scsi_unmap_parm_list *plist;
2884         struct nvme_dsm_range *range;
2885         struct nvme_queue *nvmeq;
2886         struct nvme_command c;
2887         int i, nvme_sc, res = -ENOMEM;
2888         u16 ndesc, list_len;
2889         dma_addr_t dma_addr;
2890
2891         list_len = GET_U16_FROM_CDB(cmd, UNMAP_CDB_PARAM_LIST_LENGTH_OFFSET);
2892         if (!list_len)
2893                 return -EINVAL;
2894
2895         plist = kmalloc(list_len, GFP_KERNEL);
2896         if (!plist)
2897                 return -ENOMEM;
2898
2899         res = nvme_trans_copy_from_user(hdr, plist, list_len);
2900         if (res != SNTI_TRANSLATION_SUCCESS)
2901                 goto out;
2902
2903         ndesc = be16_to_cpu(plist->unmap_blk_desc_data_len) >> 4;
2904         if (!ndesc || ndesc > 256) {
2905                 res = -EINVAL;
2906                 goto out;
2907         }
2908
2909         range = dma_alloc_coherent(&dev->pci_dev->dev, ndesc * sizeof(*range),
2910                                                         &dma_addr, GFP_KERNEL);
2911         if (!range)
2912                 goto out;
2913
2914         for (i = 0; i < ndesc; i++) {
2915                 range[i].nlb = cpu_to_le32(be32_to_cpu(plist->desc[i].nlb));
2916                 range[i].slba = cpu_to_le64(be64_to_cpu(plist->desc[i].slba));
2917                 range[i].cattr = 0;
2918         }
2919
2920         memset(&c, 0, sizeof(c));
2921         c.dsm.opcode = nvme_cmd_dsm;
2922         c.dsm.nsid = cpu_to_le32(ns->ns_id);
2923         c.dsm.prp1 = cpu_to_le64(dma_addr);
2924         c.dsm.nr = cpu_to_le32(ndesc - 1);
2925         c.dsm.attributes = cpu_to_le32(NVME_DSMGMT_AD);
2926
2927         nvmeq = get_nvmeq(dev);
2928         put_nvmeq(nvmeq);
2929
2930         nvme_sc = nvme_submit_sync_cmd(nvmeq, &c, NULL, NVME_IO_TIMEOUT);
2931         res = nvme_trans_status_code(hdr, nvme_sc);
2932
2933         dma_free_coherent(&dev->pci_dev->dev, ndesc * sizeof(*range),
2934                                                         range, dma_addr);
2935  out:
2936         kfree(plist);
2937         return res;
2938 }
2939
2940 static int nvme_scsi_translate(struct nvme_ns *ns, struct sg_io_hdr *hdr)
2941 {
2942         u8 cmd[BLK_MAX_CDB];
2943         int retcode;
2944         unsigned int opcode;
2945
2946         if (hdr->cmdp == NULL)
2947                 return -EMSGSIZE;
2948         if (copy_from_user(cmd, hdr->cmdp, hdr->cmd_len))
2949                 return -EFAULT;
2950
2951         opcode = cmd[0];
2952
2953         switch (opcode) {
2954         case READ_6:
2955         case READ_10:
2956         case READ_12:
2957         case READ_16:
2958                 retcode = nvme_trans_io(ns, hdr, 0, cmd);
2959                 break;
2960         case WRITE_6:
2961         case WRITE_10:
2962         case WRITE_12:
2963         case WRITE_16:
2964                 retcode = nvme_trans_io(ns, hdr, 1, cmd);
2965                 break;
2966         case INQUIRY:
2967                 retcode = nvme_trans_inquiry(ns, hdr, cmd);
2968                 break;
2969         case LOG_SENSE:
2970                 retcode = nvme_trans_log_sense(ns, hdr, cmd);
2971                 break;
2972         case MODE_SELECT:
2973         case MODE_SELECT_10:
2974                 retcode = nvme_trans_mode_select(ns, hdr, cmd);
2975                 break;
2976         case MODE_SENSE:
2977         case MODE_SENSE_10:
2978                 retcode = nvme_trans_mode_sense(ns, hdr, cmd);
2979                 break;
2980         case READ_CAPACITY:
2981                 retcode = nvme_trans_read_capacity(ns, hdr, cmd);
2982                 break;
2983         case SERVICE_ACTION_IN:
2984                 if (IS_READ_CAP_16(cmd))
2985                         retcode = nvme_trans_read_capacity(ns, hdr, cmd);
2986                 else
2987                         goto out;
2988                 break;
2989         case REPORT_LUNS:
2990                 retcode = nvme_trans_report_luns(ns, hdr, cmd);
2991                 break;
2992         case REQUEST_SENSE:
2993                 retcode = nvme_trans_request_sense(ns, hdr, cmd);
2994                 break;
2995         case SECURITY_PROTOCOL_IN:
2996         case SECURITY_PROTOCOL_OUT:
2997                 retcode = nvme_trans_security_protocol(ns, hdr, cmd);
2998                 break;
2999         case START_STOP:
3000                 retcode = nvme_trans_start_stop(ns, hdr, cmd);
3001                 break;
3002         case SYNCHRONIZE_CACHE:
3003                 retcode = nvme_trans_synchronize_cache(ns, hdr, cmd);
3004                 break;
3005         case FORMAT_UNIT:
3006                 retcode = nvme_trans_format_unit(ns, hdr, cmd);
3007                 break;
3008         case TEST_UNIT_READY:
3009                 retcode = nvme_trans_test_unit_ready(ns, hdr, cmd);
3010                 break;
3011         case WRITE_BUFFER:
3012                 retcode = nvme_trans_write_buffer(ns, hdr, cmd);
3013                 break;
3014         case UNMAP:
3015                 retcode = nvme_trans_unmap(ns, hdr, cmd);
3016                 break;
3017         default:
3018  out:
3019                 retcode = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
3020                                 ILLEGAL_REQUEST, SCSI_ASC_ILLEGAL_COMMAND,
3021                                 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
3022                 break;
3023         }
3024         return retcode;
3025 }
3026
3027 int nvme_sg_io(struct nvme_ns *ns, struct sg_io_hdr __user *u_hdr)
3028 {
3029         struct sg_io_hdr hdr;
3030         int retcode;
3031
3032         if (!capable(CAP_SYS_ADMIN))
3033                 return -EACCES;
3034         if (copy_from_user(&hdr, u_hdr, sizeof(hdr)))
3035                 return -EFAULT;
3036         if (hdr.interface_id != 'S')
3037                 return -EINVAL;
3038         if (hdr.cmd_len > BLK_MAX_CDB)
3039                 return -EINVAL;
3040
3041         retcode = nvme_scsi_translate(ns, &hdr);
3042         if (retcode < 0)
3043                 return retcode;
3044         if (retcode > 0)
3045                 retcode = SNTI_TRANSLATION_SUCCESS;
3046         if (copy_to_user(u_hdr, &hdr, sizeof(sg_io_hdr_t)) > 0)
3047                 return -EFAULT;
3048
3049         return retcode;
3050 }
3051
3052 int nvme_sg_get_version_num(int __user *ip)
3053 {
3054         return put_user(sg_version_num, ip);
3055 }