2 * NVM Express device driver
3 * Copyright (c) 2011, Intel Corporation.
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.
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
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.
20 * Refer to the SCSI-NVMe Translation spec for details on how
21 * each command is translated.
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>
31 #include <linux/genhd.h>
32 #include <linux/idr.h>
33 #include <linux/init.h>
34 #include <linux/interrupt.h>
36 #include <linux/kdev_t.h>
37 #include <linux/kthread.h>
38 #include <linux/kernel.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>
49 #include <scsi/scsi.h>
52 static int sg_version_num = 30534; /* 2 digits for each component */
54 #define SNTI_TRANSLATION_SUCCESS 0
55 #define SNTI_INTERNAL_ERROR 1
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
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
105 #define NIBBLE_SHIFT 4
106 #define FIXED_SENSE_DATA 0x70
107 #define DESC_FORMAT_SENSE_DATA 0x72
108 #define FIXED_SENSE_DATA_ADD_LENGTH 10
109 #define LUN_ENTRY_SIZE 8
110 #define LUN_DATA_HEADER_SIZE 8
111 #define ALL_LUNS_RETURNED 0x02
112 #define ALL_WELL_KNOWN_LUNS_RETURNED 0x01
113 #define RESTRICTED_LUNS_RETURNED 0x00
114 #define NVME_POWER_STATE_START_VALID 0x00
115 #define NVME_POWER_STATE_ACTIVE 0x01
116 #define NVME_POWER_STATE_IDLE 0x02
117 #define NVME_POWER_STATE_STANDBY 0x03
118 #define NVME_POWER_STATE_LU_CONTROL 0x07
119 #define POWER_STATE_0 0
120 #define POWER_STATE_1 1
121 #define POWER_STATE_2 2
122 #define POWER_STATE_3 3
123 #define DOWNLOAD_SAVE_ACTIVATE 0x05
124 #define DOWNLOAD_SAVE_DEFER_ACTIVATE 0x0E
125 #define ACTIVATE_DEFERRED_MICROCODE 0x0F
126 #define FORMAT_UNIT_IMMED_MASK 0x2
127 #define FORMAT_UNIT_IMMED_OFFSET 1
128 #define KELVIN_TEMP_FACTOR 273
129 #define FIXED_FMT_SENSE_DATA_SIZE 18
130 #define DESC_FMT_SENSE_DATA_SIZE 8
132 /* SCSI/NVMe defines and bit masks */
133 #define INQ_STANDARD_INQUIRY_PAGE 0x00
134 #define INQ_SUPPORTED_VPD_PAGES_PAGE 0x00
135 #define INQ_UNIT_SERIAL_NUMBER_PAGE 0x80
136 #define INQ_DEVICE_IDENTIFICATION_PAGE 0x83
137 #define INQ_EXTENDED_INQUIRY_DATA_PAGE 0x86
138 #define INQ_BDEV_CHARACTERISTICS_PAGE 0xB1
139 #define INQ_SERIAL_NUMBER_LENGTH 0x14
140 #define INQ_NUM_SUPPORTED_VPD_PAGES 5
141 #define VERSION_SPC_4 0x06
142 #define ACA_UNSUPPORTED 0
143 #define STANDARD_INQUIRY_LENGTH 36
144 #define ADDITIONAL_STD_INQ_LENGTH 31
145 #define EXTENDED_INQUIRY_DATA_PAGE_LENGTH 0x3C
146 #define RESERVED_FIELD 0
148 /* SCSI READ/WRITE Defines */
149 #define IO_CDB_WP_MASK 0xE0
150 #define IO_CDB_WP_SHIFT 5
151 #define IO_CDB_FUA_MASK 0x8
152 #define IO_6_CDB_LBA_OFFSET 0
153 #define IO_6_CDB_LBA_MASK 0x001FFFFF
154 #define IO_6_CDB_TX_LEN_OFFSET 4
155 #define IO_6_DEFAULT_TX_LEN 256
156 #define IO_10_CDB_LBA_OFFSET 2
157 #define IO_10_CDB_TX_LEN_OFFSET 7
158 #define IO_10_CDB_WP_OFFSET 1
159 #define IO_10_CDB_FUA_OFFSET 1
160 #define IO_12_CDB_LBA_OFFSET 2
161 #define IO_12_CDB_TX_LEN_OFFSET 6
162 #define IO_12_CDB_WP_OFFSET 1
163 #define IO_12_CDB_FUA_OFFSET 1
164 #define IO_16_CDB_FUA_OFFSET 1
165 #define IO_16_CDB_WP_OFFSET 1
166 #define IO_16_CDB_LBA_OFFSET 2
167 #define IO_16_CDB_TX_LEN_OFFSET 10
169 /* Mode Sense/Select defines */
170 #define MODE_PAGE_INFO_EXCEP 0x1C
171 #define MODE_PAGE_CACHING 0x08
172 #define MODE_PAGE_CONTROL 0x0A
173 #define MODE_PAGE_POWER_CONDITION 0x1A
174 #define MODE_PAGE_RETURN_ALL 0x3F
175 #define MODE_PAGE_BLK_DES_LEN 0x08
176 #define MODE_PAGE_LLBAA_BLK_DES_LEN 0x10
177 #define MODE_PAGE_CACHING_LEN 0x14
178 #define MODE_PAGE_CONTROL_LEN 0x0C
179 #define MODE_PAGE_POW_CND_LEN 0x28
180 #define MODE_PAGE_INF_EXC_LEN 0x0C
181 #define MODE_PAGE_ALL_LEN 0x54
182 #define MODE_SENSE6_MPH_SIZE 4
183 #define MODE_SENSE6_ALLOC_LEN_OFFSET 4
184 #define MODE_SENSE_PAGE_CONTROL_OFFSET 2
185 #define MODE_SENSE_PAGE_CONTROL_MASK 0xC0
186 #define MODE_SENSE_PAGE_CODE_OFFSET 2
187 #define MODE_SENSE_PAGE_CODE_MASK 0x3F
188 #define MODE_SENSE_LLBAA_OFFSET 1
189 #define MODE_SENSE_LLBAA_MASK 0x10
190 #define MODE_SENSE_LLBAA_SHIFT 4
191 #define MODE_SENSE_DBD_OFFSET 1
192 #define MODE_SENSE_DBD_MASK 8
193 #define MODE_SENSE_DBD_SHIFT 3
194 #define MODE_SENSE10_MPH_SIZE 8
195 #define MODE_SENSE10_ALLOC_LEN_OFFSET 7
196 #define MODE_SELECT_CDB_PAGE_FORMAT_OFFSET 1
197 #define MODE_SELECT_CDB_SAVE_PAGES_OFFSET 1
198 #define MODE_SELECT_6_CDB_PARAM_LIST_LENGTH_OFFSET 4
199 #define MODE_SELECT_10_CDB_PARAM_LIST_LENGTH_OFFSET 7
200 #define MODE_SELECT_CDB_PAGE_FORMAT_MASK 0x10
201 #define MODE_SELECT_CDB_SAVE_PAGES_MASK 0x1
202 #define MODE_SELECT_6_BD_OFFSET 3
203 #define MODE_SELECT_10_BD_OFFSET 6
204 #define MODE_SELECT_10_LLBAA_OFFSET 4
205 #define MODE_SELECT_10_LLBAA_MASK 1
206 #define MODE_SELECT_6_MPH_SIZE 4
207 #define MODE_SELECT_10_MPH_SIZE 8
208 #define CACHING_MODE_PAGE_WCE_MASK 0x04
209 #define MODE_SENSE_BLK_DESC_ENABLED 0
210 #define MODE_SENSE_BLK_DESC_COUNT 1
211 #define MODE_SELECT_PAGE_CODE_MASK 0x3F
212 #define SHORT_DESC_BLOCK 8
213 #define LONG_DESC_BLOCK 16
214 #define MODE_PAGE_POW_CND_LEN_FIELD 0x26
215 #define MODE_PAGE_INF_EXC_LEN_FIELD 0x0A
216 #define MODE_PAGE_CACHING_LEN_FIELD 0x12
217 #define MODE_PAGE_CONTROL_LEN_FIELD 0x0A
218 #define MODE_SENSE_PC_CURRENT_VALUES 0
220 /* Log Sense defines */
221 #define LOG_PAGE_SUPPORTED_LOG_PAGES_PAGE 0x00
222 #define LOG_PAGE_SUPPORTED_LOG_PAGES_LENGTH 0x07
223 #define LOG_PAGE_INFORMATIONAL_EXCEPTIONS_PAGE 0x2F
224 #define LOG_PAGE_TEMPERATURE_PAGE 0x0D
225 #define LOG_SENSE_CDB_SP_OFFSET 1
226 #define LOG_SENSE_CDB_SP_NOT_ENABLED 0
227 #define LOG_SENSE_CDB_PC_OFFSET 2
228 #define LOG_SENSE_CDB_PC_MASK 0xC0
229 #define LOG_SENSE_CDB_PC_SHIFT 6
230 #define LOG_SENSE_CDB_PC_CUMULATIVE_VALUES 1
231 #define LOG_SENSE_CDB_PAGE_CODE_MASK 0x3F
232 #define LOG_SENSE_CDB_ALLOC_LENGTH_OFFSET 7
233 #define REMAINING_INFO_EXCP_PAGE_LENGTH 0x8
234 #define LOG_INFO_EXCP_PAGE_LENGTH 0xC
235 #define REMAINING_TEMP_PAGE_LENGTH 0xC
236 #define LOG_TEMP_PAGE_LENGTH 0x10
237 #define LOG_TEMP_UNKNOWN 0xFF
238 #define SUPPORTED_LOG_PAGES_PAGE_LENGTH 0x3
240 /* Read Capacity defines */
241 #define READ_CAP_10_RESP_SIZE 8
242 #define READ_CAP_16_RESP_SIZE 32
244 /* NVMe Namespace and Command Defines */
245 #define NVME_GET_SMART_LOG_PAGE 0x02
246 #define NVME_GET_FEAT_TEMP_THRESH 0x04
247 #define BYTES_TO_DWORDS 4
248 #define NVME_MAX_FIRMWARE_SLOT 7
250 /* Report LUNs defines */
251 #define REPORT_LUNS_FIRST_LUN_OFFSET 8
253 /* SCSI ADDITIONAL SENSE Codes */
255 #define SCSI_ASC_NO_SENSE 0x00
256 #define SCSI_ASC_PERIPHERAL_DEV_WRITE_FAULT 0x03
257 #define SCSI_ASC_LUN_NOT_READY 0x04
258 #define SCSI_ASC_WARNING 0x0B
259 #define SCSI_ASC_LOG_BLOCK_GUARD_CHECK_FAILED 0x10
260 #define SCSI_ASC_LOG_BLOCK_APPTAG_CHECK_FAILED 0x10
261 #define SCSI_ASC_LOG_BLOCK_REFTAG_CHECK_FAILED 0x10
262 #define SCSI_ASC_UNRECOVERED_READ_ERROR 0x11
263 #define SCSI_ASC_MISCOMPARE_DURING_VERIFY 0x1D
264 #define SCSI_ASC_ACCESS_DENIED_INVALID_LUN_ID 0x20
265 #define SCSI_ASC_ILLEGAL_COMMAND 0x20
266 #define SCSI_ASC_ILLEGAL_BLOCK 0x21
267 #define SCSI_ASC_INVALID_CDB 0x24
268 #define SCSI_ASC_INVALID_LUN 0x25
269 #define SCSI_ASC_INVALID_PARAMETER 0x26
270 #define SCSI_ASC_FORMAT_COMMAND_FAILED 0x31
271 #define SCSI_ASC_INTERNAL_TARGET_FAILURE 0x44
273 /* SCSI ADDITIONAL SENSE Code Qualifiers */
275 #define SCSI_ASCQ_CAUSE_NOT_REPORTABLE 0x00
276 #define SCSI_ASCQ_FORMAT_COMMAND_FAILED 0x01
277 #define SCSI_ASCQ_LOG_BLOCK_GUARD_CHECK_FAILED 0x01
278 #define SCSI_ASCQ_LOG_BLOCK_APPTAG_CHECK_FAILED 0x02
279 #define SCSI_ASCQ_LOG_BLOCK_REFTAG_CHECK_FAILED 0x03
280 #define SCSI_ASCQ_FORMAT_IN_PROGRESS 0x04
281 #define SCSI_ASCQ_POWER_LOSS_EXPECTED 0x08
282 #define SCSI_ASCQ_INVALID_LUN_ID 0x09
285 * DEVICE_SPECIFIC_PARAMETER in mode parameter header (see sbc2r16) to
286 * enable DPOFUA support type 0x10 value.
288 #define DEVICE_SPECIFIC_PARAMETER 0
289 #define VPD_ID_DESCRIPTOR_LENGTH sizeof(VPD_IDENTIFICATION_DESCRIPTOR)
291 /* MACROs to extract information from CDBs */
293 #define GET_OPCODE(cdb) cdb[0]
295 #define GET_U8_FROM_CDB(cdb, index) (cdb[index] << 0)
297 #define GET_U16_FROM_CDB(cdb, index) ((cdb[index] << 8) | (cdb[index + 1] << 0))
299 #define GET_U24_FROM_CDB(cdb, index) ((cdb[index] << 16) | \
300 (cdb[index + 1] << 8) | \
301 (cdb[index + 2] << 0))
303 #define GET_U32_FROM_CDB(cdb, index) ((cdb[index] << 24) | \
304 (cdb[index + 1] << 16) | \
305 (cdb[index + 2] << 8) | \
306 (cdb[index + 3] << 0))
308 #define GET_U64_FROM_CDB(cdb, index) ((((u64)cdb[index]) << 56) | \
309 (((u64)cdb[index + 1]) << 48) | \
310 (((u64)cdb[index + 2]) << 40) | \
311 (((u64)cdb[index + 3]) << 32) | \
312 (((u64)cdb[index + 4]) << 24) | \
313 (((u64)cdb[index + 5]) << 16) | \
314 (((u64)cdb[index + 6]) << 8) | \
315 (((u64)cdb[index + 7]) << 0))
317 /* Inquiry Helper Macros */
318 #define GET_INQ_EVPD_BIT(cdb) \
319 ((GET_U8_FROM_CDB(cdb, INQUIRY_EVPD_BYTE_OFFSET) & \
320 INQUIRY_EVPD_BIT_MASK) ? 1 : 0)
322 #define GET_INQ_PAGE_CODE(cdb) \
323 (GET_U8_FROM_CDB(cdb, INQUIRY_PAGE_CODE_BYTE_OFFSET))
325 #define GET_INQ_ALLOC_LENGTH(cdb) \
326 (GET_U16_FROM_CDB(cdb, INQUIRY_CDB_ALLOCATION_LENGTH_OFFSET))
328 /* Report LUNs Helper Macros */
329 #define GET_REPORT_LUNS_ALLOC_LENGTH(cdb) \
330 (GET_U32_FROM_CDB(cdb, REPORT_LUNS_CDB_ALLOC_LENGTH_OFFSET))
332 /* Read Capacity Helper Macros */
333 #define GET_READ_CAP_16_ALLOC_LENGTH(cdb) \
334 (GET_U32_FROM_CDB(cdb, READ_CAP_16_CDB_ALLOC_LENGTH_OFFSET))
336 #define IS_READ_CAP_16(cdb) \
337 ((cdb[0] == SERVICE_ACTION_IN && cdb[1] == SAI_READ_CAPACITY_16) ? 1 : 0)
339 /* Request Sense Helper Macros */
340 #define GET_REQUEST_SENSE_ALLOC_LENGTH(cdb) \
341 (GET_U8_FROM_CDB(cdb, REQUEST_SENSE_CDB_ALLOC_LENGTH_OFFSET))
343 /* Mode Sense Helper Macros */
344 #define GET_MODE_SENSE_DBD(cdb) \
345 ((GET_U8_FROM_CDB(cdb, MODE_SENSE_DBD_OFFSET) & MODE_SENSE_DBD_MASK) >> \
346 MODE_SENSE_DBD_SHIFT)
348 #define GET_MODE_SENSE_LLBAA(cdb) \
349 ((GET_U8_FROM_CDB(cdb, MODE_SENSE_LLBAA_OFFSET) & \
350 MODE_SENSE_LLBAA_MASK) >> MODE_SENSE_LLBAA_SHIFT)
352 #define GET_MODE_SENSE_MPH_SIZE(cdb10) \
353 (cdb10 ? MODE_SENSE10_MPH_SIZE : MODE_SENSE6_MPH_SIZE)
356 /* Struct to gather data that needs to be extracted from a SCSI CDB.
357 Not conforming to any particular CDB variant, but compatible with all. */
359 struct nvme_trans_io_cdb {
367 /* Internal Helper Functions */
370 /* Copy data to userspace memory */
372 static int nvme_trans_copy_to_user(struct sg_io_hdr *hdr, void *from,
375 int res = SNTI_TRANSLATION_SUCCESS;
376 unsigned long not_copied;
379 size_t remaining = n;
382 if (hdr->iovec_count > 0) {
385 for (i = 0; i < hdr->iovec_count; i++) {
386 not_copied = copy_from_user(&sgl, hdr->dxferp +
387 i * sizeof(struct sg_iovec),
388 sizeof(struct sg_iovec));
391 xfer_len = min(remaining, sgl.iov_len);
392 not_copied = copy_to_user(sgl.iov_base, index,
399 remaining -= xfer_len;
405 not_copied = copy_to_user(hdr->dxferp, from, n);
411 /* Copy data from userspace memory */
413 static int nvme_trans_copy_from_user(struct sg_io_hdr *hdr, void *to,
416 int res = SNTI_TRANSLATION_SUCCESS;
417 unsigned long not_copied;
420 size_t remaining = n;
423 if (hdr->iovec_count > 0) {
426 for (i = 0; i < hdr->iovec_count; i++) {
427 not_copied = copy_from_user(&sgl, hdr->dxferp +
428 i * sizeof(struct sg_iovec),
429 sizeof(struct sg_iovec));
432 xfer_len = min(remaining, sgl.iov_len);
433 not_copied = copy_from_user(index, sgl.iov_base,
440 remaining -= xfer_len;
447 not_copied = copy_from_user(to, hdr->dxferp, n);
453 /* Status/Sense Buffer Writeback */
455 static int nvme_trans_completion(struct sg_io_hdr *hdr, u8 status, u8 sense_key,
458 int res = SNTI_TRANSLATION_SUCCESS;
460 u8 resp[DESC_FMT_SENSE_DATA_SIZE];
462 if (scsi_status_is_good(status)) {
463 hdr->status = SAM_STAT_GOOD;
464 hdr->masked_status = GOOD;
465 hdr->host_status = DID_OK;
466 hdr->driver_status = DRIVER_OK;
469 hdr->status = status;
470 hdr->masked_status = status >> 1;
471 hdr->host_status = DID_OK;
472 hdr->driver_status = DRIVER_OK;
474 memset(resp, 0, DESC_FMT_SENSE_DATA_SIZE);
475 resp[0] = DESC_FORMAT_SENSE_DATA;
480 xfer_len = min_t(u8, hdr->mx_sb_len, DESC_FMT_SENSE_DATA_SIZE);
481 hdr->sb_len_wr = xfer_len;
482 if (copy_to_user(hdr->sbp, resp, xfer_len) > 0)
489 static int nvme_trans_status_code(struct sg_io_hdr *hdr, int nvme_sc)
491 u8 status, sense_key, asc, ascq;
492 int res = SNTI_TRANSLATION_SUCCESS;
494 /* For non-nvme (Linux) errors, simply return the error code */
498 /* Mask DNR, More, and reserved fields */
502 /* Generic Command Status */
503 case NVME_SC_SUCCESS:
504 status = SAM_STAT_GOOD;
505 sense_key = NO_SENSE;
506 asc = SCSI_ASC_NO_SENSE;
507 ascq = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
509 case NVME_SC_INVALID_OPCODE:
510 status = SAM_STAT_CHECK_CONDITION;
511 sense_key = ILLEGAL_REQUEST;
512 asc = SCSI_ASC_ILLEGAL_COMMAND;
513 ascq = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
515 case NVME_SC_INVALID_FIELD:
516 status = SAM_STAT_CHECK_CONDITION;
517 sense_key = ILLEGAL_REQUEST;
518 asc = SCSI_ASC_INVALID_CDB;
519 ascq = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
521 case NVME_SC_DATA_XFER_ERROR:
522 status = SAM_STAT_CHECK_CONDITION;
523 sense_key = MEDIUM_ERROR;
524 asc = SCSI_ASC_NO_SENSE;
525 ascq = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
527 case NVME_SC_POWER_LOSS:
528 status = SAM_STAT_TASK_ABORTED;
529 sense_key = ABORTED_COMMAND;
530 asc = SCSI_ASC_WARNING;
531 ascq = SCSI_ASCQ_POWER_LOSS_EXPECTED;
533 case NVME_SC_INTERNAL:
534 status = SAM_STAT_CHECK_CONDITION;
535 sense_key = HARDWARE_ERROR;
536 asc = SCSI_ASC_INTERNAL_TARGET_FAILURE;
537 ascq = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
539 case NVME_SC_ABORT_REQ:
540 status = SAM_STAT_TASK_ABORTED;
541 sense_key = ABORTED_COMMAND;
542 asc = SCSI_ASC_NO_SENSE;
543 ascq = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
545 case NVME_SC_ABORT_QUEUE:
546 status = SAM_STAT_TASK_ABORTED;
547 sense_key = ABORTED_COMMAND;
548 asc = SCSI_ASC_NO_SENSE;
549 ascq = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
551 case NVME_SC_FUSED_FAIL:
552 status = SAM_STAT_TASK_ABORTED;
553 sense_key = ABORTED_COMMAND;
554 asc = SCSI_ASC_NO_SENSE;
555 ascq = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
557 case NVME_SC_FUSED_MISSING:
558 status = SAM_STAT_TASK_ABORTED;
559 sense_key = ABORTED_COMMAND;
560 asc = SCSI_ASC_NO_SENSE;
561 ascq = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
563 case NVME_SC_INVALID_NS:
564 status = SAM_STAT_CHECK_CONDITION;
565 sense_key = ILLEGAL_REQUEST;
566 asc = SCSI_ASC_ACCESS_DENIED_INVALID_LUN_ID;
567 ascq = SCSI_ASCQ_INVALID_LUN_ID;
569 case NVME_SC_LBA_RANGE:
570 status = SAM_STAT_CHECK_CONDITION;
571 sense_key = ILLEGAL_REQUEST;
572 asc = SCSI_ASC_ILLEGAL_BLOCK;
573 ascq = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
575 case NVME_SC_CAP_EXCEEDED:
576 status = SAM_STAT_CHECK_CONDITION;
577 sense_key = MEDIUM_ERROR;
578 asc = SCSI_ASC_NO_SENSE;
579 ascq = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
581 case NVME_SC_NS_NOT_READY:
582 status = SAM_STAT_CHECK_CONDITION;
583 sense_key = NOT_READY;
584 asc = SCSI_ASC_LUN_NOT_READY;
585 ascq = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
588 /* Command Specific Status */
589 case NVME_SC_INVALID_FORMAT:
590 status = SAM_STAT_CHECK_CONDITION;
591 sense_key = ILLEGAL_REQUEST;
592 asc = SCSI_ASC_FORMAT_COMMAND_FAILED;
593 ascq = SCSI_ASCQ_FORMAT_COMMAND_FAILED;
595 case NVME_SC_BAD_ATTRIBUTES:
596 status = SAM_STAT_CHECK_CONDITION;
597 sense_key = ILLEGAL_REQUEST;
598 asc = SCSI_ASC_INVALID_CDB;
599 ascq = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
603 case NVME_SC_WRITE_FAULT:
604 status = SAM_STAT_CHECK_CONDITION;
605 sense_key = MEDIUM_ERROR;
606 asc = SCSI_ASC_PERIPHERAL_DEV_WRITE_FAULT;
607 ascq = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
609 case NVME_SC_READ_ERROR:
610 status = SAM_STAT_CHECK_CONDITION;
611 sense_key = MEDIUM_ERROR;
612 asc = SCSI_ASC_UNRECOVERED_READ_ERROR;
613 ascq = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
615 case NVME_SC_GUARD_CHECK:
616 status = SAM_STAT_CHECK_CONDITION;
617 sense_key = MEDIUM_ERROR;
618 asc = SCSI_ASC_LOG_BLOCK_GUARD_CHECK_FAILED;
619 ascq = SCSI_ASCQ_LOG_BLOCK_GUARD_CHECK_FAILED;
621 case NVME_SC_APPTAG_CHECK:
622 status = SAM_STAT_CHECK_CONDITION;
623 sense_key = MEDIUM_ERROR;
624 asc = SCSI_ASC_LOG_BLOCK_APPTAG_CHECK_FAILED;
625 ascq = SCSI_ASCQ_LOG_BLOCK_APPTAG_CHECK_FAILED;
627 case NVME_SC_REFTAG_CHECK:
628 status = SAM_STAT_CHECK_CONDITION;
629 sense_key = MEDIUM_ERROR;
630 asc = SCSI_ASC_LOG_BLOCK_REFTAG_CHECK_FAILED;
631 ascq = SCSI_ASCQ_LOG_BLOCK_REFTAG_CHECK_FAILED;
633 case NVME_SC_COMPARE_FAILED:
634 status = SAM_STAT_CHECK_CONDITION;
635 sense_key = MISCOMPARE;
636 asc = SCSI_ASC_MISCOMPARE_DURING_VERIFY;
637 ascq = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
639 case NVME_SC_ACCESS_DENIED:
640 status = SAM_STAT_CHECK_CONDITION;
641 sense_key = ILLEGAL_REQUEST;
642 asc = SCSI_ASC_ACCESS_DENIED_INVALID_LUN_ID;
643 ascq = SCSI_ASCQ_INVALID_LUN_ID;
646 /* Unspecified/Default */
647 case NVME_SC_CMDID_CONFLICT:
648 case NVME_SC_CMD_SEQ_ERROR:
649 case NVME_SC_CQ_INVALID:
650 case NVME_SC_QID_INVALID:
651 case NVME_SC_QUEUE_SIZE:
652 case NVME_SC_ABORT_LIMIT:
653 case NVME_SC_ABORT_MISSING:
654 case NVME_SC_ASYNC_LIMIT:
655 case NVME_SC_FIRMWARE_SLOT:
656 case NVME_SC_FIRMWARE_IMAGE:
657 case NVME_SC_INVALID_VECTOR:
658 case NVME_SC_INVALID_LOG_PAGE:
660 status = SAM_STAT_CHECK_CONDITION;
661 sense_key = ILLEGAL_REQUEST;
662 asc = SCSI_ASC_NO_SENSE;
663 ascq = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
667 res = nvme_trans_completion(hdr, status, sense_key, asc, ascq);
672 /* INQUIRY Helper Functions */
674 static int nvme_trans_standard_inquiry_page(struct nvme_ns *ns,
675 struct sg_io_hdr *hdr, u8 *inq_response,
678 struct nvme_dev *dev = ns->dev;
681 struct nvme_id_ns *id_ns;
682 int res = SNTI_TRANSLATION_SUCCESS;
685 u8 resp_data_format = 0x02;
687 u8 cmdque = 0x01 << 1;
689 mem = dma_alloc_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ns),
690 &dma_addr, GFP_KERNEL);
696 /* nvme ns identify - use DPS value for PROTECT field */
697 nvme_sc = nvme_identify(dev, ns->ns_id, 0, dma_addr);
698 res = nvme_trans_status_code(hdr, nvme_sc);
700 * If nvme_sc was -ve, res will be -ve here.
701 * If nvme_sc was +ve, the status would bace been translated, and res
702 * can only be 0 or -ve.
703 * - If 0 && nvme_sc > 0, then go into next if where res gets nvme_sc
704 * - If -ve, return because its a Linux error.
713 (id_ns->dps) ? (protect = 0x01) : (protect = 0);
715 memset(inq_response, 0, STANDARD_INQUIRY_LENGTH);
716 inq_response[2] = VERSION_SPC_4;
717 inq_response[3] = resp_data_format; /*normaca=0 | hisup=0 */
718 inq_response[4] = ADDITIONAL_STD_INQ_LENGTH;
719 inq_response[5] = protect; /* sccs=0 | acc=0 | tpgs=0 | pc3=0 */
720 inq_response[7] = cmdque; /* wbus16=0 | sync=0 | vs=0 */
721 strncpy(&inq_response[8], "NVMe ", 8);
722 strncpy(&inq_response[16], dev->model, 16);
723 strncpy(&inq_response[32], dev->firmware_rev, 4);
725 xfer_len = min(alloc_len, STANDARD_INQUIRY_LENGTH);
726 res = nvme_trans_copy_to_user(hdr, inq_response, xfer_len);
729 dma_free_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ns), mem,
735 static int nvme_trans_supported_vpd_pages(struct nvme_ns *ns,
736 struct sg_io_hdr *hdr, u8 *inq_response,
739 int res = SNTI_TRANSLATION_SUCCESS;
742 memset(inq_response, 0, STANDARD_INQUIRY_LENGTH);
743 inq_response[1] = INQ_SUPPORTED_VPD_PAGES_PAGE; /* Page Code */
744 inq_response[3] = INQ_NUM_SUPPORTED_VPD_PAGES; /* Page Length */
745 inq_response[4] = INQ_SUPPORTED_VPD_PAGES_PAGE;
746 inq_response[5] = INQ_UNIT_SERIAL_NUMBER_PAGE;
747 inq_response[6] = INQ_DEVICE_IDENTIFICATION_PAGE;
748 inq_response[7] = INQ_EXTENDED_INQUIRY_DATA_PAGE;
749 inq_response[8] = INQ_BDEV_CHARACTERISTICS_PAGE;
751 xfer_len = min(alloc_len, STANDARD_INQUIRY_LENGTH);
752 res = nvme_trans_copy_to_user(hdr, inq_response, xfer_len);
757 static int nvme_trans_unit_serial_page(struct nvme_ns *ns,
758 struct sg_io_hdr *hdr, u8 *inq_response,
761 struct nvme_dev *dev = ns->dev;
762 int res = SNTI_TRANSLATION_SUCCESS;
765 memset(inq_response, 0, STANDARD_INQUIRY_LENGTH);
766 inq_response[1] = INQ_UNIT_SERIAL_NUMBER_PAGE; /* Page Code */
767 inq_response[3] = INQ_SERIAL_NUMBER_LENGTH; /* Page Length */
768 strncpy(&inq_response[4], dev->serial, INQ_SERIAL_NUMBER_LENGTH);
770 xfer_len = min(alloc_len, STANDARD_INQUIRY_LENGTH);
771 res = nvme_trans_copy_to_user(hdr, inq_response, xfer_len);
776 static int nvme_trans_device_id_page(struct nvme_ns *ns, struct sg_io_hdr *hdr,
777 u8 *inq_response, int alloc_len)
779 struct nvme_dev *dev = ns->dev;
782 struct nvme_id_ctrl *id_ctrl;
783 int res = SNTI_TRANSLATION_SUCCESS;
787 __be32 tmp_id = cpu_to_be32(ns->ns_id);
789 mem = dma_alloc_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ns),
790 &dma_addr, GFP_KERNEL);
796 /* nvme controller identify */
797 nvme_sc = nvme_identify(dev, 0, 1, dma_addr);
798 res = nvme_trans_status_code(hdr, nvme_sc);
807 /* Since SCSI tried to save 4 bits... [SPC-4(r34) Table 591] */
808 ieee[0] = id_ctrl->ieee[0] << 4;
809 ieee[1] = id_ctrl->ieee[0] >> 4 | id_ctrl->ieee[1] << 4;
810 ieee[2] = id_ctrl->ieee[1] >> 4 | id_ctrl->ieee[2] << 4;
811 ieee[3] = id_ctrl->ieee[2] >> 4;
813 memset(inq_response, 0, STANDARD_INQUIRY_LENGTH);
814 inq_response[1] = INQ_DEVICE_IDENTIFICATION_PAGE; /* Page Code */
815 inq_response[3] = 20; /* Page Length */
816 /* Designation Descriptor start */
817 inq_response[4] = 0x01; /* Proto ID=0h | Code set=1h */
818 inq_response[5] = 0x03; /* PIV=0b | Asso=00b | Designator Type=3h */
819 inq_response[6] = 0x00; /* Rsvd */
820 inq_response[7] = 16; /* Designator Length */
821 /* Designator start */
822 inq_response[8] = 0x60 | ieee[3]; /* NAA=6h | IEEE ID MSB, High nibble*/
823 inq_response[9] = ieee[2]; /* IEEE ID */
824 inq_response[10] = ieee[1]; /* IEEE ID */
825 inq_response[11] = ieee[0]; /* IEEE ID| Vendor Specific ID... */
826 inq_response[12] = (dev->pci_dev->vendor & 0xFF00) >> 8;
827 inq_response[13] = (dev->pci_dev->vendor & 0x00FF);
828 inq_response[14] = dev->serial[0];
829 inq_response[15] = dev->serial[1];
830 inq_response[16] = dev->model[0];
831 inq_response[17] = dev->model[1];
832 memcpy(&inq_response[18], &tmp_id, sizeof(u32));
833 /* Last 2 bytes are zero */
835 xfer_len = min(alloc_len, STANDARD_INQUIRY_LENGTH);
836 res = nvme_trans_copy_to_user(hdr, inq_response, xfer_len);
839 dma_free_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ns), mem,
845 static int nvme_trans_ext_inq_page(struct nvme_ns *ns, struct sg_io_hdr *hdr,
849 int res = SNTI_TRANSLATION_SUCCESS;
851 struct nvme_dev *dev = ns->dev;
854 struct nvme_id_ctrl *id_ctrl;
855 struct nvme_id_ns *id_ns;
859 u8 spt_lut[8] = {0, 0, 2, 1, 4, 6, 5, 7};
860 u8 grd_chk, app_chk, ref_chk, protect;
865 inq_response = kmalloc(EXTENDED_INQUIRY_DATA_PAGE_LENGTH, GFP_KERNEL);
866 if (inq_response == NULL) {
871 mem = dma_alloc_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ns),
872 &dma_addr, GFP_KERNEL);
878 /* nvme ns identify */
879 nvme_sc = nvme_identify(dev, ns->ns_id, 0, dma_addr);
880 res = nvme_trans_status_code(hdr, nvme_sc);
888 spt = spt_lut[(id_ns->dpc) & 0x07] << 3;
889 (id_ns->dps) ? (protect = 0x01) : (protect = 0);
890 grd_chk = protect << 2;
891 app_chk = protect << 1;
894 /* nvme controller identify */
895 nvme_sc = nvme_identify(dev, 0, 1, dma_addr);
896 res = nvme_trans_status_code(hdr, nvme_sc);
904 v_sup = id_ctrl->vwc;
906 memset(inq_response, 0, EXTENDED_INQUIRY_DATA_PAGE_LENGTH);
907 inq_response[1] = INQ_EXTENDED_INQUIRY_DATA_PAGE; /* Page Code */
908 inq_response[2] = 0x00; /* Page Length MSB */
909 inq_response[3] = 0x3C; /* Page Length LSB */
910 inq_response[4] = microcode | spt | grd_chk | app_chk | ref_chk;
911 inq_response[5] = uask_sup;
912 inq_response[6] = v_sup;
913 inq_response[7] = luiclr;
917 xfer_len = min(alloc_len, EXTENDED_INQUIRY_DATA_PAGE_LENGTH);
918 res = nvme_trans_copy_to_user(hdr, inq_response, xfer_len);
921 dma_free_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ns), mem,
929 static int nvme_trans_bdev_char_page(struct nvme_ns *ns, struct sg_io_hdr *hdr,
933 int res = SNTI_TRANSLATION_SUCCESS;
936 inq_response = kmalloc(EXTENDED_INQUIRY_DATA_PAGE_LENGTH, GFP_KERNEL);
937 if (inq_response == NULL) {
942 memset(inq_response, 0, EXTENDED_INQUIRY_DATA_PAGE_LENGTH);
943 inq_response[1] = INQ_BDEV_CHARACTERISTICS_PAGE; /* Page Code */
944 inq_response[2] = 0x00; /* Page Length MSB */
945 inq_response[3] = 0x3C; /* Page Length LSB */
946 inq_response[4] = 0x00; /* Medium Rotation Rate MSB */
947 inq_response[5] = 0x01; /* Medium Rotation Rate LSB */
948 inq_response[6] = 0x00; /* Form Factor */
950 xfer_len = min(alloc_len, EXTENDED_INQUIRY_DATA_PAGE_LENGTH);
951 res = nvme_trans_copy_to_user(hdr, inq_response, xfer_len);
958 /* LOG SENSE Helper Functions */
960 static int nvme_trans_log_supp_pages(struct nvme_ns *ns, struct sg_io_hdr *hdr,
963 int res = SNTI_TRANSLATION_SUCCESS;
967 log_response = kmalloc(LOG_PAGE_SUPPORTED_LOG_PAGES_LENGTH, GFP_KERNEL);
968 if (log_response == NULL) {
972 memset(log_response, 0, LOG_PAGE_SUPPORTED_LOG_PAGES_LENGTH);
974 log_response[0] = LOG_PAGE_SUPPORTED_LOG_PAGES_PAGE;
975 /* Subpage=0x00, Page Length MSB=0 */
976 log_response[3] = SUPPORTED_LOG_PAGES_PAGE_LENGTH;
977 log_response[4] = LOG_PAGE_SUPPORTED_LOG_PAGES_PAGE;
978 log_response[5] = LOG_PAGE_INFORMATIONAL_EXCEPTIONS_PAGE;
979 log_response[6] = LOG_PAGE_TEMPERATURE_PAGE;
981 xfer_len = min(alloc_len, LOG_PAGE_SUPPORTED_LOG_PAGES_LENGTH);
982 res = nvme_trans_copy_to_user(hdr, log_response, xfer_len);
989 static int nvme_trans_log_info_exceptions(struct nvme_ns *ns,
990 struct sg_io_hdr *hdr, int alloc_len)
992 int res = SNTI_TRANSLATION_SUCCESS;
995 struct nvme_command c;
996 struct nvme_dev *dev = ns->dev;
997 struct nvme_smart_log *smart_log;
1003 log_response = kmalloc(LOG_INFO_EXCP_PAGE_LENGTH, GFP_KERNEL);
1004 if (log_response == NULL) {
1008 memset(log_response, 0, LOG_INFO_EXCP_PAGE_LENGTH);
1010 mem = dma_alloc_coherent(&dev->pci_dev->dev,
1011 sizeof(struct nvme_smart_log),
1012 &dma_addr, GFP_KERNEL);
1018 /* Get SMART Log Page */
1019 memset(&c, 0, sizeof(c));
1020 c.common.opcode = nvme_admin_get_log_page;
1021 c.common.nsid = cpu_to_le32(0xFFFFFFFF);
1022 c.common.prp1 = cpu_to_le64(dma_addr);
1023 c.common.cdw10[0] = cpu_to_le32(((sizeof(struct nvme_smart_log) /
1024 BYTES_TO_DWORDS) << 16) | NVME_GET_SMART_LOG_PAGE);
1025 res = nvme_submit_admin_cmd(dev, &c, NULL);
1026 if (res != NVME_SC_SUCCESS) {
1027 temp_c = LOG_TEMP_UNKNOWN;
1030 temp_k = (smart_log->temperature[1] << 8) +
1031 (smart_log->temperature[0]);
1032 temp_c = temp_k - KELVIN_TEMP_FACTOR;
1035 log_response[0] = LOG_PAGE_INFORMATIONAL_EXCEPTIONS_PAGE;
1036 /* Subpage=0x00, Page Length MSB=0 */
1037 log_response[3] = REMAINING_INFO_EXCP_PAGE_LENGTH;
1038 /* Informational Exceptions Log Parameter 1 Start */
1039 /* Parameter Code=0x0000 bytes 4,5 */
1040 log_response[6] = 0x23; /* DU=0, TSD=1, ETC=0, TMC=0, FMT_AND_LNK=11b */
1041 log_response[7] = 0x04; /* PARAMETER LENGTH */
1042 /* Add sense Code and qualifier = 0x00 each */
1043 /* Use Temperature from NVMe Get Log Page, convert to C from K */
1044 log_response[10] = temp_c;
1046 xfer_len = min(alloc_len, LOG_INFO_EXCP_PAGE_LENGTH);
1047 res = nvme_trans_copy_to_user(hdr, log_response, xfer_len);
1049 dma_free_coherent(&dev->pci_dev->dev, sizeof(struct nvme_smart_log),
1052 kfree(log_response);
1057 static int nvme_trans_log_temperature(struct nvme_ns *ns, struct sg_io_hdr *hdr,
1060 int res = SNTI_TRANSLATION_SUCCESS;
1063 struct nvme_command c;
1064 struct nvme_dev *dev = ns->dev;
1065 struct nvme_smart_log *smart_log;
1066 dma_addr_t dma_addr;
1069 u8 temp_c_cur, temp_c_thresh;
1072 log_response = kmalloc(LOG_TEMP_PAGE_LENGTH, GFP_KERNEL);
1073 if (log_response == NULL) {
1077 memset(log_response, 0, LOG_TEMP_PAGE_LENGTH);
1079 mem = dma_alloc_coherent(&dev->pci_dev->dev,
1080 sizeof(struct nvme_smart_log),
1081 &dma_addr, GFP_KERNEL);
1087 /* Get SMART Log Page */
1088 memset(&c, 0, sizeof(c));
1089 c.common.opcode = nvme_admin_get_log_page;
1090 c.common.nsid = cpu_to_le32(0xFFFFFFFF);
1091 c.common.prp1 = cpu_to_le64(dma_addr);
1092 c.common.cdw10[0] = cpu_to_le32(((sizeof(struct nvme_smart_log) /
1093 BYTES_TO_DWORDS) << 16) | NVME_GET_SMART_LOG_PAGE);
1094 res = nvme_submit_admin_cmd(dev, &c, NULL);
1095 if (res != NVME_SC_SUCCESS) {
1096 temp_c_cur = LOG_TEMP_UNKNOWN;
1099 temp_k = (smart_log->temperature[1] << 8) +
1100 (smart_log->temperature[0]);
1101 temp_c_cur = temp_k - KELVIN_TEMP_FACTOR;
1104 /* Get Features for Temp Threshold */
1105 res = nvme_get_features(dev, NVME_FEAT_TEMP_THRESH, 0, 0,
1107 if (res != NVME_SC_SUCCESS)
1108 temp_c_thresh = LOG_TEMP_UNKNOWN;
1110 temp_c_thresh = (feature_resp & 0xFFFF) - KELVIN_TEMP_FACTOR;
1112 log_response[0] = LOG_PAGE_TEMPERATURE_PAGE;
1113 /* Subpage=0x00, Page Length MSB=0 */
1114 log_response[3] = REMAINING_TEMP_PAGE_LENGTH;
1115 /* Temperature Log Parameter 1 (Temperature) Start */
1116 /* Parameter Code = 0x0000 */
1117 log_response[6] = 0x01; /* Format and Linking = 01b */
1118 log_response[7] = 0x02; /* Parameter Length */
1119 /* Use Temperature from NVMe Get Log Page, convert to C from K */
1120 log_response[9] = temp_c_cur;
1121 /* Temperature Log Parameter 2 (Reference Temperature) Start */
1122 log_response[11] = 0x01; /* Parameter Code = 0x0001 */
1123 log_response[12] = 0x01; /* Format and Linking = 01b */
1124 log_response[13] = 0x02; /* Parameter Length */
1125 /* Use Temperature Thresh from NVMe Get Log Page, convert to C from K */
1126 log_response[15] = temp_c_thresh;
1128 xfer_len = min(alloc_len, LOG_TEMP_PAGE_LENGTH);
1129 res = nvme_trans_copy_to_user(hdr, log_response, xfer_len);
1131 dma_free_coherent(&dev->pci_dev->dev, sizeof(struct nvme_smart_log),
1134 kfree(log_response);
1139 /* MODE SENSE Helper Functions */
1141 static int nvme_trans_fill_mode_parm_hdr(u8 *resp, int len, u8 cdb10, u8 llbaa,
1142 u16 mode_data_length, u16 blk_desc_len)
1144 /* Quick check to make sure I don't stomp on my own memory... */
1145 if ((cdb10 && len < 8) || (!cdb10 && len < 4))
1146 return SNTI_INTERNAL_ERROR;
1149 resp[0] = (mode_data_length & 0xFF00) >> 8;
1150 resp[1] = (mode_data_length & 0x00FF);
1151 /* resp[2] and [3] are zero */
1153 resp[5] = RESERVED_FIELD;
1154 resp[6] = (blk_desc_len & 0xFF00) >> 8;
1155 resp[7] = (blk_desc_len & 0x00FF);
1157 resp[0] = (mode_data_length & 0x00FF);
1158 /* resp[1] and [2] are zero */
1159 resp[3] = (blk_desc_len & 0x00FF);
1162 return SNTI_TRANSLATION_SUCCESS;
1165 static int nvme_trans_fill_blk_desc(struct nvme_ns *ns, struct sg_io_hdr *hdr,
1166 u8 *resp, int len, u8 llbaa)
1168 int res = SNTI_TRANSLATION_SUCCESS;
1170 struct nvme_dev *dev = ns->dev;
1171 dma_addr_t dma_addr;
1173 struct nvme_id_ns *id_ns;
1177 if (llbaa == 0 && len < MODE_PAGE_BLK_DES_LEN)
1178 return SNTI_INTERNAL_ERROR;
1179 else if (llbaa > 0 && len < MODE_PAGE_LLBAA_BLK_DES_LEN)
1180 return SNTI_INTERNAL_ERROR;
1182 mem = dma_alloc_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ns),
1183 &dma_addr, GFP_KERNEL);
1189 /* nvme ns identify */
1190 nvme_sc = nvme_identify(dev, ns->ns_id, 0, dma_addr);
1191 res = nvme_trans_status_code(hdr, nvme_sc);
1199 flbas = (id_ns->flbas) & 0x0F;
1200 lba_length = (1 << (id_ns->lbaf[flbas].ds));
1203 __be32 tmp_cap = cpu_to_be32(le64_to_cpu(id_ns->ncap));
1204 /* Byte 4 is reserved */
1205 __be32 tmp_len = cpu_to_be32(lba_length & 0x00FFFFFF);
1207 memcpy(resp, &tmp_cap, sizeof(u32));
1208 memcpy(&resp[4], &tmp_len, sizeof(u32));
1210 __be64 tmp_cap = cpu_to_be64(le64_to_cpu(id_ns->ncap));
1211 __be32 tmp_len = cpu_to_be32(lba_length);
1213 memcpy(resp, &tmp_cap, sizeof(u64));
1214 /* Bytes 8, 9, 10, 11 are reserved */
1215 memcpy(&resp[12], &tmp_len, sizeof(u32));
1219 dma_free_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ns), mem,
1225 static int nvme_trans_fill_control_page(struct nvme_ns *ns,
1226 struct sg_io_hdr *hdr, u8 *resp,
1229 if (len < MODE_PAGE_CONTROL_LEN)
1230 return SNTI_INTERNAL_ERROR;
1232 resp[0] = MODE_PAGE_CONTROL;
1233 resp[1] = MODE_PAGE_CONTROL_LEN_FIELD;
1234 resp[2] = 0x0E; /* TST=000b, TMF_ONLY=0, DPICZ=1,
1235 * D_SENSE=1, GLTSD=1, RLEC=0 */
1236 resp[3] = 0x12; /* Q_ALGO_MODIFIER=1h, NUAR=0, QERR=01b */
1237 /* Byte 4: VS=0, RAC=0, UA_INT=0, SWP=0 */
1238 resp[5] = 0x40; /* ATO=0, TAS=1, ATMPE=0, RWWP=0, AUTOLOAD=0 */
1239 /* resp[6] and [7] are obsolete, thus zero */
1240 resp[8] = 0xFF; /* Busy timeout period = 0xffff */
1242 /* Bytes 10,11: Extended selftest completion time = 0x0000 */
1244 return SNTI_TRANSLATION_SUCCESS;
1247 static int nvme_trans_fill_caching_page(struct nvme_ns *ns,
1248 struct sg_io_hdr *hdr,
1251 int res = SNTI_TRANSLATION_SUCCESS;
1253 struct nvme_dev *dev = ns->dev;
1257 if (len < MODE_PAGE_CACHING_LEN)
1258 return SNTI_INTERNAL_ERROR;
1260 nvme_sc = nvme_get_features(dev, NVME_FEAT_VOLATILE_WC, 0, 0,
1262 res = nvme_trans_status_code(hdr, nvme_sc);
1269 vwc = feature_resp & 0x00000001;
1271 resp[0] = MODE_PAGE_CACHING;
1272 resp[1] = MODE_PAGE_CACHING_LEN_FIELD;
1279 static int nvme_trans_fill_pow_cnd_page(struct nvme_ns *ns,
1280 struct sg_io_hdr *hdr, u8 *resp,
1283 int res = SNTI_TRANSLATION_SUCCESS;
1285 if (len < MODE_PAGE_POW_CND_LEN)
1286 return SNTI_INTERNAL_ERROR;
1288 resp[0] = MODE_PAGE_POWER_CONDITION;
1289 resp[1] = MODE_PAGE_POW_CND_LEN_FIELD;
1290 /* All other bytes are zero */
1295 static int nvme_trans_fill_inf_exc_page(struct nvme_ns *ns,
1296 struct sg_io_hdr *hdr, u8 *resp,
1299 int res = SNTI_TRANSLATION_SUCCESS;
1301 if (len < MODE_PAGE_INF_EXC_LEN)
1302 return SNTI_INTERNAL_ERROR;
1304 resp[0] = MODE_PAGE_INFO_EXCEP;
1305 resp[1] = MODE_PAGE_INF_EXC_LEN_FIELD;
1307 /* All other bytes are zero */
1312 static int nvme_trans_fill_all_pages(struct nvme_ns *ns, struct sg_io_hdr *hdr,
1315 int res = SNTI_TRANSLATION_SUCCESS;
1316 u16 mode_pages_offset_1 = 0;
1317 u16 mode_pages_offset_2, mode_pages_offset_3, mode_pages_offset_4;
1319 mode_pages_offset_2 = mode_pages_offset_1 + MODE_PAGE_CACHING_LEN;
1320 mode_pages_offset_3 = mode_pages_offset_2 + MODE_PAGE_CONTROL_LEN;
1321 mode_pages_offset_4 = mode_pages_offset_3 + MODE_PAGE_POW_CND_LEN;
1323 res = nvme_trans_fill_caching_page(ns, hdr, &resp[mode_pages_offset_1],
1324 MODE_PAGE_CACHING_LEN);
1325 if (res != SNTI_TRANSLATION_SUCCESS)
1327 res = nvme_trans_fill_control_page(ns, hdr, &resp[mode_pages_offset_2],
1328 MODE_PAGE_CONTROL_LEN);
1329 if (res != SNTI_TRANSLATION_SUCCESS)
1331 res = nvme_trans_fill_pow_cnd_page(ns, hdr, &resp[mode_pages_offset_3],
1332 MODE_PAGE_POW_CND_LEN);
1333 if (res != SNTI_TRANSLATION_SUCCESS)
1335 res = nvme_trans_fill_inf_exc_page(ns, hdr, &resp[mode_pages_offset_4],
1336 MODE_PAGE_INF_EXC_LEN);
1337 if (res != SNTI_TRANSLATION_SUCCESS)
1344 static inline int nvme_trans_get_blk_desc_len(u8 dbd, u8 llbaa)
1346 if (dbd == MODE_SENSE_BLK_DESC_ENABLED) {
1347 /* SPC-4: len = 8 x Num_of_descriptors if llbaa = 0, 16x if 1 */
1348 return 8 * (llbaa + 1) * MODE_SENSE_BLK_DESC_COUNT;
1354 static int nvme_trans_mode_page_create(struct nvme_ns *ns,
1355 struct sg_io_hdr *hdr, u8 *cmd,
1356 u16 alloc_len, u8 cdb10,
1357 int (*mode_page_fill_func)
1359 struct sg_io_hdr *hdr, u8 *, int),
1360 u16 mode_pages_tot_len)
1362 int res = SNTI_TRANSLATION_SUCCESS;
1368 u16 mode_pages_offset_1;
1369 u16 blk_desc_len, blk_desc_offset, mode_data_length;
1371 dbd = GET_MODE_SENSE_DBD(cmd);
1372 llbaa = GET_MODE_SENSE_LLBAA(cmd);
1373 mph_size = GET_MODE_SENSE_MPH_SIZE(cdb10);
1374 blk_desc_len = nvme_trans_get_blk_desc_len(dbd, llbaa);
1376 resp_size = mph_size + blk_desc_len + mode_pages_tot_len;
1377 /* Refer spc4r34 Table 440 for calculation of Mode data Length field */
1378 mode_data_length = 3 + (3 * cdb10) + blk_desc_len + mode_pages_tot_len;
1380 blk_desc_offset = mph_size;
1381 mode_pages_offset_1 = blk_desc_offset + blk_desc_len;
1383 response = kmalloc(resp_size, GFP_KERNEL);
1384 if (response == NULL) {
1388 memset(response, 0, resp_size);
1390 res = nvme_trans_fill_mode_parm_hdr(&response[0], mph_size, cdb10,
1391 llbaa, mode_data_length, blk_desc_len);
1392 if (res != SNTI_TRANSLATION_SUCCESS)
1394 if (blk_desc_len > 0) {
1395 res = nvme_trans_fill_blk_desc(ns, hdr,
1396 &response[blk_desc_offset],
1397 blk_desc_len, llbaa);
1398 if (res != SNTI_TRANSLATION_SUCCESS)
1401 res = mode_page_fill_func(ns, hdr, &response[mode_pages_offset_1],
1402 mode_pages_tot_len);
1403 if (res != SNTI_TRANSLATION_SUCCESS)
1406 xfer_len = min(alloc_len, resp_size);
1407 res = nvme_trans_copy_to_user(hdr, response, xfer_len);
1415 /* Read Capacity Helper Functions */
1417 static void nvme_trans_fill_read_cap(u8 *response, struct nvme_id_ns *id_ns,
1424 u8 p_type_lut[4] = {0, 0, 1, 2};
1429 flbas = (id_ns->flbas) & 0x0F;
1430 lba_length = (1 << (id_ns->lbaf[flbas].ds));
1431 rlba = le64_to_cpup(&id_ns->nsze) - 1;
1432 (id_ns->dps) ? (prot_en = 0x01) : (prot_en = 0);
1435 if (rlba > 0xFFFFFFFF)
1437 tmp_rlba_32 = cpu_to_be32(rlba);
1438 tmp_len = cpu_to_be32(lba_length);
1439 memcpy(response, &tmp_rlba_32, sizeof(u32));
1440 memcpy(&response[4], &tmp_len, sizeof(u32));
1442 tmp_rlba = cpu_to_be64(rlba);
1443 tmp_len = cpu_to_be32(lba_length);
1444 memcpy(response, &tmp_rlba, sizeof(u64));
1445 memcpy(&response[8], &tmp_len, sizeof(u32));
1446 response[12] = (p_type_lut[id_ns->dps & 0x3] << 1) | prot_en;
1447 /* P_I_Exponent = 0x0 | LBPPBE = 0x0 */
1448 /* LBPME = 0 | LBPRZ = 0 | LALBA = 0x00 */
1449 /* Bytes 16-31 - Reserved */
1453 /* Start Stop Unit Helper Functions */
1455 static int nvme_trans_power_state(struct nvme_ns *ns, struct sg_io_hdr *hdr,
1456 u8 pc, u8 pcmod, u8 start)
1458 int res = SNTI_TRANSLATION_SUCCESS;
1460 struct nvme_dev *dev = ns->dev;
1461 dma_addr_t dma_addr;
1463 struct nvme_id_ctrl *id_ctrl;
1464 int lowest_pow_st; /* max npss = lowest power consumption */
1465 unsigned ps_desired = 0;
1467 /* NVMe Controller Identify */
1468 mem = dma_alloc_coherent(&dev->pci_dev->dev,
1469 sizeof(struct nvme_id_ctrl),
1470 &dma_addr, GFP_KERNEL);
1475 nvme_sc = nvme_identify(dev, 0, 1, dma_addr);
1476 res = nvme_trans_status_code(hdr, nvme_sc);
1484 lowest_pow_st = id_ctrl->npss - 1;
1487 case NVME_POWER_STATE_START_VALID:
1488 /* Action unspecified if POWER CONDITION MODIFIER != 0 */
1489 if (pcmod == 0 && start == 0x1)
1490 ps_desired = POWER_STATE_0;
1491 if (pcmod == 0 && start == 0x0)
1492 ps_desired = lowest_pow_st;
1494 case NVME_POWER_STATE_ACTIVE:
1495 /* Action unspecified if POWER CONDITION MODIFIER != 0 */
1497 ps_desired = POWER_STATE_0;
1499 case NVME_POWER_STATE_IDLE:
1500 /* Action unspecified if POWER CONDITION MODIFIER != [0,1,2] */
1501 /* min of desired state and (lps-1) because lps is STOP */
1503 ps_desired = min(POWER_STATE_1, (lowest_pow_st - 1));
1504 else if (pcmod == 0x1)
1505 ps_desired = min(POWER_STATE_2, (lowest_pow_st - 1));
1506 else if (pcmod == 0x2)
1507 ps_desired = min(POWER_STATE_3, (lowest_pow_st - 1));
1509 case NVME_POWER_STATE_STANDBY:
1510 /* Action unspecified if POWER CONDITION MODIFIER != [0,1] */
1512 ps_desired = max(0, (lowest_pow_st - 2));
1513 else if (pcmod == 0x1)
1514 ps_desired = max(0, (lowest_pow_st - 1));
1516 case NVME_POWER_STATE_LU_CONTROL:
1518 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
1519 ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
1520 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
1523 nvme_sc = nvme_set_features(dev, NVME_FEAT_POWER_MGMT, ps_desired, 0,
1525 res = nvme_trans_status_code(hdr, nvme_sc);
1531 dma_free_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ctrl), mem,
1537 /* Write Buffer Helper Functions */
1538 /* Also using this for Format Unit with hdr passed as NULL, and buffer_id, 0 */
1540 static int nvme_trans_send_fw_cmd(struct nvme_ns *ns, struct sg_io_hdr *hdr,
1541 u8 opcode, u32 tot_len, u32 offset,
1544 int res = SNTI_TRANSLATION_SUCCESS;
1546 struct nvme_dev *dev = ns->dev;
1547 struct nvme_command c;
1548 struct nvme_iod *iod = NULL;
1551 memset(&c, 0, sizeof(c));
1552 c.common.opcode = opcode;
1553 if (opcode == nvme_admin_download_fw) {
1554 if (hdr->iovec_count > 0) {
1555 /* Assuming SGL is not allowed for this command */
1556 res = nvme_trans_completion(hdr,
1557 SAM_STAT_CHECK_CONDITION,
1559 SCSI_ASC_INVALID_CDB,
1560 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
1563 iod = nvme_map_user_pages(dev, DMA_TO_DEVICE,
1564 (unsigned long)hdr->dxferp, tot_len);
1569 length = nvme_setup_prps(dev, &c.common, iod, tot_len,
1571 if (length != tot_len) {
1576 c.dlfw.numd = cpu_to_le32((tot_len/BYTES_TO_DWORDS) - 1);
1577 c.dlfw.offset = cpu_to_le32(offset/BYTES_TO_DWORDS);
1578 } else if (opcode == nvme_admin_activate_fw) {
1579 c.common.cdw10[0] = cpu_to_le32(buffer_id);
1580 /* AA=01b Replace & activate at reset */
1581 c.common.cdw10[0] = cpu_to_le32(le32_to_cpu(
1582 c.common.cdw10[0]) | 0x00000008);
1585 nvme_sc = nvme_submit_admin_cmd(dev, &c, NULL);
1586 res = nvme_trans_status_code(hdr, nvme_sc);
1593 if (opcode == nvme_admin_download_fw) {
1594 nvme_unmap_user_pages(dev, DMA_TO_DEVICE, iod);
1595 nvme_free_iod(dev, iod);
1601 /* Mode Select Helper Functions */
1603 static inline void nvme_trans_modesel_get_bd_len(u8 *parm_list, u8 cdb10,
1604 u16 *bd_len, u8 *llbaa)
1608 *bd_len = (parm_list[MODE_SELECT_10_BD_OFFSET] << 8) +
1609 parm_list[MODE_SELECT_10_BD_OFFSET + 1];
1610 *llbaa = parm_list[MODE_SELECT_10_LLBAA_OFFSET] &&
1611 MODE_SELECT_10_LLBAA_MASK;
1614 *bd_len = parm_list[MODE_SELECT_6_BD_OFFSET];
1618 static void nvme_trans_modesel_save_bd(struct nvme_ns *ns, u8 *parm_list,
1619 u16 idx, u16 bd_len, u8 llbaa)
1623 bd_num = bd_len / ((llbaa == 0) ?
1624 SHORT_DESC_BLOCK : LONG_DESC_BLOCK);
1625 /* Store block descriptor info if a FORMAT UNIT comes later */
1626 /* TODO Saving 1st BD info; what to do if multiple BD received? */
1628 /* Standard Block Descriptor - spc4r34 7.5.5.1 */
1629 ns->mode_select_num_blocks =
1630 (parm_list[idx + 1] << 16) +
1631 (parm_list[idx + 2] << 8) +
1632 (parm_list[idx + 3]);
1634 ns->mode_select_block_len =
1635 (parm_list[idx + 5] << 16) +
1636 (parm_list[idx + 6] << 8) +
1637 (parm_list[idx + 7]);
1639 /* Long LBA Block Descriptor - sbc3r27 6.4.2.3 */
1640 ns->mode_select_num_blocks =
1641 (((u64)parm_list[idx + 0]) << 56) +
1642 (((u64)parm_list[idx + 1]) << 48) +
1643 (((u64)parm_list[idx + 2]) << 40) +
1644 (((u64)parm_list[idx + 3]) << 32) +
1645 (((u64)parm_list[idx + 4]) << 24) +
1646 (((u64)parm_list[idx + 5]) << 16) +
1647 (((u64)parm_list[idx + 6]) << 8) +
1648 ((u64)parm_list[idx + 7]);
1650 ns->mode_select_block_len =
1651 (parm_list[idx + 12] << 24) +
1652 (parm_list[idx + 13] << 16) +
1653 (parm_list[idx + 14] << 8) +
1654 (parm_list[idx + 15]);
1658 static u16 nvme_trans_modesel_get_mp(struct nvme_ns *ns, struct sg_io_hdr *hdr,
1659 u8 *mode_page, u8 page_code)
1661 int res = SNTI_TRANSLATION_SUCCESS;
1663 struct nvme_dev *dev = ns->dev;
1666 switch (page_code) {
1667 case MODE_PAGE_CACHING:
1668 dword11 = ((mode_page[2] & CACHING_MODE_PAGE_WCE_MASK) ? 1 : 0);
1669 nvme_sc = nvme_set_features(dev, NVME_FEAT_VOLATILE_WC, dword11,
1671 res = nvme_trans_status_code(hdr, nvme_sc);
1679 case MODE_PAGE_CONTROL:
1681 case MODE_PAGE_POWER_CONDITION:
1682 /* Verify the OS is not trying to set timers */
1683 if ((mode_page[2] & 0x01) != 0 || (mode_page[3] & 0x0F) != 0) {
1684 res = nvme_trans_completion(hdr,
1685 SAM_STAT_CHECK_CONDITION,
1687 SCSI_ASC_INVALID_PARAMETER,
1688 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
1690 res = SNTI_INTERNAL_ERROR;
1695 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
1696 ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
1697 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
1699 res = SNTI_INTERNAL_ERROR;
1706 static int nvme_trans_modesel_data(struct nvme_ns *ns, struct sg_io_hdr *hdr,
1707 u8 *cmd, u16 parm_list_len, u8 pf,
1710 int res = SNTI_TRANSLATION_SUCCESS;
1714 u16 index, saved_index;
1718 /* Get parm list from data-in/out buffer */
1719 parm_list = kmalloc(parm_list_len, GFP_KERNEL);
1720 if (parm_list == NULL) {
1725 res = nvme_trans_copy_from_user(hdr, parm_list, parm_list_len);
1726 if (res != SNTI_TRANSLATION_SUCCESS)
1729 nvme_trans_modesel_get_bd_len(parm_list, cdb10, &bd_len, &llbaa);
1730 index = (cdb10) ? (MODE_SELECT_10_MPH_SIZE) : (MODE_SELECT_6_MPH_SIZE);
1733 /* Block Descriptors present, parse */
1734 nvme_trans_modesel_save_bd(ns, parm_list, index, bd_len, llbaa);
1737 saved_index = index;
1739 /* Multiple mode pages may be present; iterate through all */
1740 /* In 1st Iteration, don't do NVME Command, only check for CDB errors */
1742 page_code = parm_list[index] & MODE_SELECT_PAGE_CODE_MASK;
1743 mp_size = parm_list[index + 1] + 2;
1744 if ((page_code != MODE_PAGE_CACHING) &&
1745 (page_code != MODE_PAGE_CONTROL) &&
1746 (page_code != MODE_PAGE_POWER_CONDITION)) {
1747 res = nvme_trans_completion(hdr,
1748 SAM_STAT_CHECK_CONDITION,
1750 SCSI_ASC_INVALID_CDB,
1751 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
1755 } while (index < parm_list_len);
1757 /* In 2nd Iteration, do the NVME Commands */
1758 index = saved_index;
1760 page_code = parm_list[index] & MODE_SELECT_PAGE_CODE_MASK;
1761 mp_size = parm_list[index + 1] + 2;
1762 res = nvme_trans_modesel_get_mp(ns, hdr, &parm_list[index],
1764 if (res != SNTI_TRANSLATION_SUCCESS)
1767 } while (index < parm_list_len);
1775 /* Format Unit Helper Functions */
1777 static int nvme_trans_fmt_set_blk_size_count(struct nvme_ns *ns,
1778 struct sg_io_hdr *hdr)
1780 int res = SNTI_TRANSLATION_SUCCESS;
1782 struct nvme_dev *dev = ns->dev;
1783 dma_addr_t dma_addr;
1785 struct nvme_id_ns *id_ns;
1789 * SCSI Expects a MODE SELECT would have been issued prior to
1790 * a FORMAT UNIT, and the block size and number would be used
1791 * from the block descriptor in it. If a MODE SELECT had not
1792 * been issued, FORMAT shall use the current values for both.
1795 if (ns->mode_select_num_blocks == 0 || ns->mode_select_block_len == 0) {
1796 mem = dma_alloc_coherent(&dev->pci_dev->dev,
1797 sizeof(struct nvme_id_ns), &dma_addr, GFP_KERNEL);
1802 /* nvme ns identify */
1803 nvme_sc = nvme_identify(dev, ns->ns_id, 0, dma_addr);
1804 res = nvme_trans_status_code(hdr, nvme_sc);
1813 if (ns->mode_select_num_blocks == 0)
1814 ns->mode_select_num_blocks = le64_to_cpu(id_ns->ncap);
1815 if (ns->mode_select_block_len == 0) {
1816 flbas = (id_ns->flbas) & 0x0F;
1817 ns->mode_select_block_len =
1818 (1 << (id_ns->lbaf[flbas].ds));
1821 dma_free_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ns),
1828 static int nvme_trans_fmt_get_parm_header(struct sg_io_hdr *hdr, u8 len,
1829 u8 format_prot_info, u8 *nvme_pf_code)
1831 int res = SNTI_TRANSLATION_SUCCESS;
1833 u8 pf_usage, pf_code;
1835 parm_list = kmalloc(len, GFP_KERNEL);
1836 if (parm_list == NULL) {
1840 res = nvme_trans_copy_from_user(hdr, parm_list, len);
1841 if (res != SNTI_TRANSLATION_SUCCESS)
1844 if ((parm_list[FORMAT_UNIT_IMMED_OFFSET] &
1845 FORMAT_UNIT_IMMED_MASK) != 0) {
1846 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
1847 ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
1848 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
1852 if (len == FORMAT_UNIT_LONG_PARM_LIST_LEN &&
1853 (parm_list[FORMAT_UNIT_PROT_INT_OFFSET] & 0x0F) != 0) {
1854 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
1855 ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
1856 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
1859 pf_usage = parm_list[FORMAT_UNIT_PROT_FIELD_USAGE_OFFSET] &
1860 FORMAT_UNIT_PROT_FIELD_USAGE_MASK;
1861 pf_code = (pf_usage << 2) | format_prot_info;
1876 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
1877 ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
1878 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
1888 static int nvme_trans_fmt_send_cmd(struct nvme_ns *ns, struct sg_io_hdr *hdr,
1891 int res = SNTI_TRANSLATION_SUCCESS;
1893 struct nvme_dev *dev = ns->dev;
1894 dma_addr_t dma_addr;
1896 struct nvme_id_ns *id_ns;
1899 u8 selected_lbaf = 0xFF;
1901 struct nvme_command c;
1903 /* Loop thru LBAF's in id_ns to match reqd lbaf, put in cdw10 */
1904 mem = dma_alloc_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ns),
1905 &dma_addr, GFP_KERNEL);
1910 /* nvme ns identify */
1911 nvme_sc = nvme_identify(dev, ns->ns_id, 0, dma_addr);
1912 res = nvme_trans_status_code(hdr, nvme_sc);
1920 flbas = (id_ns->flbas) & 0x0F;
1921 nlbaf = id_ns->nlbaf;
1923 for (i = 0; i < nlbaf; i++) {
1924 if (ns->mode_select_block_len == (1 << (id_ns->lbaf[i].ds))) {
1929 if (selected_lbaf > 0x0F) {
1930 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
1931 ILLEGAL_REQUEST, SCSI_ASC_INVALID_PARAMETER,
1932 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
1934 if (ns->mode_select_num_blocks != le64_to_cpu(id_ns->ncap)) {
1935 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
1936 ILLEGAL_REQUEST, SCSI_ASC_INVALID_PARAMETER,
1937 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
1940 cdw10 |= prot_info << 5;
1941 cdw10 |= selected_lbaf & 0x0F;
1942 memset(&c, 0, sizeof(c));
1943 c.format.opcode = nvme_admin_format_nvm;
1944 c.format.nsid = cpu_to_le32(ns->ns_id);
1945 c.format.cdw10 = cpu_to_le32(cdw10);
1947 nvme_sc = nvme_submit_admin_cmd(dev, &c, NULL);
1948 res = nvme_trans_status_code(hdr, nvme_sc);
1955 dma_free_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ns), mem,
1961 /* Read/Write Helper Functions */
1963 static inline void nvme_trans_get_io_cdb6(u8 *cmd,
1964 struct nvme_trans_io_cdb *cdb_info)
1967 cdb_info->prot_info = 0;
1968 cdb_info->lba = GET_U32_FROM_CDB(cmd, IO_6_CDB_LBA_OFFSET) &
1970 cdb_info->xfer_len = GET_U8_FROM_CDB(cmd, IO_6_CDB_TX_LEN_OFFSET);
1972 /* sbc3r27 sec 5.32 - TRANSFER LEN of 0 implies a 256 Block transfer */
1973 if (cdb_info->xfer_len == 0)
1974 cdb_info->xfer_len = IO_6_DEFAULT_TX_LEN;
1977 static inline void nvme_trans_get_io_cdb10(u8 *cmd,
1978 struct nvme_trans_io_cdb *cdb_info)
1980 cdb_info->fua = GET_U8_FROM_CDB(cmd, IO_10_CDB_FUA_OFFSET) &
1982 cdb_info->prot_info = GET_U8_FROM_CDB(cmd, IO_10_CDB_WP_OFFSET) &
1983 IO_CDB_WP_MASK >> IO_CDB_WP_SHIFT;
1984 cdb_info->lba = GET_U32_FROM_CDB(cmd, IO_10_CDB_LBA_OFFSET);
1985 cdb_info->xfer_len = GET_U16_FROM_CDB(cmd, IO_10_CDB_TX_LEN_OFFSET);
1988 static inline void nvme_trans_get_io_cdb12(u8 *cmd,
1989 struct nvme_trans_io_cdb *cdb_info)
1991 cdb_info->fua = GET_U8_FROM_CDB(cmd, IO_12_CDB_FUA_OFFSET) &
1993 cdb_info->prot_info = GET_U8_FROM_CDB(cmd, IO_12_CDB_WP_OFFSET) &
1994 IO_CDB_WP_MASK >> IO_CDB_WP_SHIFT;
1995 cdb_info->lba = GET_U32_FROM_CDB(cmd, IO_12_CDB_LBA_OFFSET);
1996 cdb_info->xfer_len = GET_U32_FROM_CDB(cmd, IO_12_CDB_TX_LEN_OFFSET);
1999 static inline void nvme_trans_get_io_cdb16(u8 *cmd,
2000 struct nvme_trans_io_cdb *cdb_info)
2002 cdb_info->fua = GET_U8_FROM_CDB(cmd, IO_16_CDB_FUA_OFFSET) &
2004 cdb_info->prot_info = GET_U8_FROM_CDB(cmd, IO_16_CDB_WP_OFFSET) &
2005 IO_CDB_WP_MASK >> IO_CDB_WP_SHIFT;
2006 cdb_info->lba = GET_U64_FROM_CDB(cmd, IO_16_CDB_LBA_OFFSET);
2007 cdb_info->xfer_len = GET_U32_FROM_CDB(cmd, IO_16_CDB_TX_LEN_OFFSET);
2010 static inline u32 nvme_trans_io_get_num_cmds(struct sg_io_hdr *hdr,
2011 struct nvme_trans_io_cdb *cdb_info,
2014 /* If using iovecs, send one nvme command per vector */
2015 if (hdr->iovec_count > 0)
2016 return hdr->iovec_count;
2017 else if (cdb_info->xfer_len > max_blocks)
2018 return ((cdb_info->xfer_len - 1) / max_blocks) + 1;
2023 static u16 nvme_trans_io_get_control(struct nvme_ns *ns,
2024 struct nvme_trans_io_cdb *cdb_info)
2028 /* When Protection information support is added, implement here */
2030 if (cdb_info->fua > 0)
2031 control |= NVME_RW_FUA;
2036 static int nvme_trans_do_nvme_io(struct nvme_ns *ns, struct sg_io_hdr *hdr,
2037 struct nvme_trans_io_cdb *cdb_info, u8 is_write)
2039 int res = SNTI_TRANSLATION_SUCCESS;
2041 struct nvme_dev *dev = ns->dev;
2042 struct nvme_queue *nvmeq;
2044 struct nvme_iod *iod;
2046 u64 unit_num_blocks; /* Number of blocks to xfer in each nvme cmd */
2049 u64 nvme_offset = 0;
2050 void __user *next_mapping_addr;
2051 struct nvme_command c;
2052 u8 opcode = (is_write ? nvme_cmd_write : nvme_cmd_read);
2054 u32 max_blocks = nvme_block_nr(ns, dev->max_hw_sectors);
2056 num_cmds = nvme_trans_io_get_num_cmds(hdr, cdb_info, max_blocks);
2059 * This loop handles two cases.
2060 * First, when an SGL is used in the form of an iovec list:
2061 * - Use iov_base as the next mapping address for the nvme command_id
2062 * - Use iov_len as the data transfer length for the command.
2063 * Second, when we have a single buffer
2064 * - If larger than max_blocks, split into chunks, offset
2065 * each nvme command accordingly.
2067 for (i = 0; i < num_cmds; i++) {
2068 memset(&c, 0, sizeof(c));
2069 if (hdr->iovec_count > 0) {
2070 struct sg_iovec sgl;
2072 retcode = copy_from_user(&sgl, hdr->dxferp +
2073 i * sizeof(struct sg_iovec),
2074 sizeof(struct sg_iovec));
2077 unit_len = sgl.iov_len;
2078 unit_num_blocks = unit_len >> ns->lba_shift;
2079 next_mapping_addr = sgl.iov_base;
2081 unit_num_blocks = min((u64)max_blocks,
2082 (cdb_info->xfer_len - nvme_offset));
2083 unit_len = unit_num_blocks << ns->lba_shift;
2084 next_mapping_addr = hdr->dxferp +
2085 ((1 << ns->lba_shift) * nvme_offset);
2088 c.rw.opcode = opcode;
2089 c.rw.nsid = cpu_to_le32(ns->ns_id);
2090 c.rw.slba = cpu_to_le64(cdb_info->lba + nvme_offset);
2091 c.rw.length = cpu_to_le16(unit_num_blocks - 1);
2092 control = nvme_trans_io_get_control(ns, cdb_info);
2093 c.rw.control = cpu_to_le16(control);
2095 iod = nvme_map_user_pages(dev,
2096 (is_write) ? DMA_TO_DEVICE : DMA_FROM_DEVICE,
2097 (unsigned long)next_mapping_addr, unit_len);
2102 retcode = nvme_setup_prps(dev, &c.common, iod, unit_len,
2104 if (retcode != unit_len) {
2105 nvme_unmap_user_pages(dev,
2106 (is_write) ? DMA_TO_DEVICE : DMA_FROM_DEVICE,
2108 nvme_free_iod(dev, iod);
2113 nvme_offset += unit_num_blocks;
2115 nvmeq = get_nvmeq(dev);
2117 * Since nvme_submit_sync_cmd sleeps, we can't keep
2118 * preemption disabled. We may be preempted at any
2119 * point, and be rescheduled to a different CPU. That
2120 * will cause cacheline bouncing, but no additional
2121 * races since q_lock already protects against other
2125 nvme_sc = nvme_submit_sync_cmd(nvmeq, &c, NULL,
2127 if (nvme_sc != NVME_SC_SUCCESS) {
2128 nvme_unmap_user_pages(dev,
2129 (is_write) ? DMA_TO_DEVICE : DMA_FROM_DEVICE,
2131 nvme_free_iod(dev, iod);
2132 res = nvme_trans_status_code(hdr, nvme_sc);
2135 nvme_unmap_user_pages(dev,
2136 (is_write) ? DMA_TO_DEVICE : DMA_FROM_DEVICE,
2138 nvme_free_iod(dev, iod);
2140 res = nvme_trans_status_code(hdr, NVME_SC_SUCCESS);
2147 /* SCSI Command Translation Functions */
2149 static int nvme_trans_io(struct nvme_ns *ns, struct sg_io_hdr *hdr, u8 is_write,
2152 int res = SNTI_TRANSLATION_SUCCESS;
2153 struct nvme_trans_io_cdb cdb_info;
2156 u64 sum_iov_len = 0;
2157 struct sg_iovec sgl;
2161 /* Extract Fields from CDB */
2165 nvme_trans_get_io_cdb6(cmd, &cdb_info);
2169 nvme_trans_get_io_cdb10(cmd, &cdb_info);
2173 nvme_trans_get_io_cdb12(cmd, &cdb_info);
2177 nvme_trans_get_io_cdb16(cmd, &cdb_info);
2180 /* Will never really reach here */
2181 res = SNTI_INTERNAL_ERROR;
2185 /* Calculate total length of transfer (in bytes) */
2186 if (hdr->iovec_count > 0) {
2187 for (i = 0; i < hdr->iovec_count; i++) {
2188 not_copied = copy_from_user(&sgl, hdr->dxferp +
2189 i * sizeof(struct sg_iovec),
2190 sizeof(struct sg_iovec));
2193 sum_iov_len += sgl.iov_len;
2194 /* IO vector sizes should be multiples of block size */
2195 if (sgl.iov_len % (1 << ns->lba_shift) != 0) {
2196 res = nvme_trans_completion(hdr,
2197 SAM_STAT_CHECK_CONDITION,
2199 SCSI_ASC_INVALID_PARAMETER,
2200 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2205 sum_iov_len = hdr->dxfer_len;
2208 /* As Per sg ioctl howto, if the lengths differ, use the lower one */
2209 xfer_bytes = min(((u64)hdr->dxfer_len), sum_iov_len);
2211 /* If block count and actual data buffer size dont match, error out */
2212 if (xfer_bytes != (cdb_info.xfer_len << ns->lba_shift)) {
2217 /* Check for 0 length transfer - it is not illegal */
2218 if (cdb_info.xfer_len == 0)
2221 /* Send NVMe IO Command(s) */
2222 res = nvme_trans_do_nvme_io(ns, hdr, &cdb_info, is_write);
2223 if (res != SNTI_TRANSLATION_SUCCESS)
2230 static int nvme_trans_inquiry(struct nvme_ns *ns, struct sg_io_hdr *hdr,
2233 int res = SNTI_TRANSLATION_SUCCESS;
2239 evpd = GET_INQ_EVPD_BIT(cmd);
2240 page_code = GET_INQ_PAGE_CODE(cmd);
2241 alloc_len = GET_INQ_ALLOC_LENGTH(cmd);
2243 inq_response = kmalloc(STANDARD_INQUIRY_LENGTH, GFP_KERNEL);
2244 if (inq_response == NULL) {
2250 if (page_code == INQ_STANDARD_INQUIRY_PAGE) {
2251 res = nvme_trans_standard_inquiry_page(ns, hdr,
2252 inq_response, alloc_len);
2254 res = nvme_trans_completion(hdr,
2255 SAM_STAT_CHECK_CONDITION,
2257 SCSI_ASC_INVALID_CDB,
2258 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2261 switch (page_code) {
2262 case VPD_SUPPORTED_PAGES:
2263 res = nvme_trans_supported_vpd_pages(ns, hdr,
2264 inq_response, alloc_len);
2266 case VPD_SERIAL_NUMBER:
2267 res = nvme_trans_unit_serial_page(ns, hdr, inq_response,
2270 case VPD_DEVICE_IDENTIFIERS:
2271 res = nvme_trans_device_id_page(ns, hdr, inq_response,
2274 case VPD_EXTENDED_INQUIRY:
2275 res = nvme_trans_ext_inq_page(ns, hdr, alloc_len);
2277 case VPD_BLOCK_DEV_CHARACTERISTICS:
2278 res = nvme_trans_bdev_char_page(ns, hdr, alloc_len);
2281 res = nvme_trans_completion(hdr,
2282 SAM_STAT_CHECK_CONDITION,
2284 SCSI_ASC_INVALID_CDB,
2285 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2289 kfree(inq_response);
2294 static int nvme_trans_log_sense(struct nvme_ns *ns, struct sg_io_hdr *hdr,
2297 int res = SNTI_TRANSLATION_SUCCESS;
2303 sp = GET_U8_FROM_CDB(cmd, LOG_SENSE_CDB_SP_OFFSET);
2304 if (sp != LOG_SENSE_CDB_SP_NOT_ENABLED) {
2305 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2306 ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
2307 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2310 pc = GET_U8_FROM_CDB(cmd, LOG_SENSE_CDB_PC_OFFSET);
2311 page_code = pc & LOG_SENSE_CDB_PAGE_CODE_MASK;
2312 pc = (pc & LOG_SENSE_CDB_PC_MASK) >> LOG_SENSE_CDB_PC_SHIFT;
2313 if (pc != LOG_SENSE_CDB_PC_CUMULATIVE_VALUES) {
2314 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2315 ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
2316 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2319 alloc_len = GET_U16_FROM_CDB(cmd, LOG_SENSE_CDB_ALLOC_LENGTH_OFFSET);
2320 switch (page_code) {
2321 case LOG_PAGE_SUPPORTED_LOG_PAGES_PAGE:
2322 res = nvme_trans_log_supp_pages(ns, hdr, alloc_len);
2324 case LOG_PAGE_INFORMATIONAL_EXCEPTIONS_PAGE:
2325 res = nvme_trans_log_info_exceptions(ns, hdr, alloc_len);
2327 case LOG_PAGE_TEMPERATURE_PAGE:
2328 res = nvme_trans_log_temperature(ns, hdr, alloc_len);
2331 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2332 ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
2333 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2341 static int nvme_trans_mode_select(struct nvme_ns *ns, struct sg_io_hdr *hdr,
2344 int res = SNTI_TRANSLATION_SUCCESS;
2350 page_format = GET_U8_FROM_CDB(cmd, MODE_SELECT_CDB_PAGE_FORMAT_OFFSET);
2351 page_format &= MODE_SELECT_CDB_PAGE_FORMAT_MASK;
2353 save_pages = GET_U8_FROM_CDB(cmd, MODE_SELECT_CDB_SAVE_PAGES_OFFSET);
2354 save_pages &= MODE_SELECT_CDB_SAVE_PAGES_MASK;
2356 if (GET_OPCODE(cmd) == MODE_SELECT) {
2357 parm_list_len = GET_U8_FROM_CDB(cmd,
2358 MODE_SELECT_6_CDB_PARAM_LIST_LENGTH_OFFSET);
2360 parm_list_len = GET_U16_FROM_CDB(cmd,
2361 MODE_SELECT_10_CDB_PARAM_LIST_LENGTH_OFFSET);
2365 if (parm_list_len != 0) {
2367 * According to SPC-4 r24, a paramter list length field of 0
2368 * shall not be considered an error
2370 res = nvme_trans_modesel_data(ns, hdr, cmd, parm_list_len,
2371 page_format, save_pages, cdb10);
2377 static int nvme_trans_mode_sense(struct nvme_ns *ns, struct sg_io_hdr *hdr,
2380 int res = SNTI_TRANSLATION_SUCCESS;
2386 if (GET_OPCODE(cmd) == MODE_SENSE) {
2387 alloc_len = GET_U8_FROM_CDB(cmd, MODE_SENSE6_ALLOC_LEN_OFFSET);
2389 alloc_len = GET_U16_FROM_CDB(cmd,
2390 MODE_SENSE10_ALLOC_LEN_OFFSET);
2394 pc = GET_U8_FROM_CDB(cmd, MODE_SENSE_PAGE_CONTROL_OFFSET) &
2395 MODE_SENSE_PAGE_CONTROL_MASK;
2396 if (pc != MODE_SENSE_PC_CURRENT_VALUES) {
2397 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2398 ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
2399 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2403 page_code = GET_U8_FROM_CDB(cmd, MODE_SENSE_PAGE_CODE_OFFSET) &
2404 MODE_SENSE_PAGE_CODE_MASK;
2405 switch (page_code) {
2406 case MODE_PAGE_CACHING:
2407 res = nvme_trans_mode_page_create(ns, hdr, cmd, alloc_len,
2409 &nvme_trans_fill_caching_page,
2410 MODE_PAGE_CACHING_LEN);
2412 case MODE_PAGE_CONTROL:
2413 res = nvme_trans_mode_page_create(ns, hdr, cmd, alloc_len,
2415 &nvme_trans_fill_control_page,
2416 MODE_PAGE_CONTROL_LEN);
2418 case MODE_PAGE_POWER_CONDITION:
2419 res = nvme_trans_mode_page_create(ns, hdr, cmd, alloc_len,
2421 &nvme_trans_fill_pow_cnd_page,
2422 MODE_PAGE_POW_CND_LEN);
2424 case MODE_PAGE_INFO_EXCEP:
2425 res = nvme_trans_mode_page_create(ns, hdr, cmd, alloc_len,
2427 &nvme_trans_fill_inf_exc_page,
2428 MODE_PAGE_INF_EXC_LEN);
2430 case MODE_PAGE_RETURN_ALL:
2431 res = nvme_trans_mode_page_create(ns, hdr, cmd, alloc_len,
2433 &nvme_trans_fill_all_pages,
2437 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2438 ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
2439 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2447 static int nvme_trans_read_capacity(struct nvme_ns *ns, struct sg_io_hdr *hdr,
2450 int res = SNTI_TRANSLATION_SUCCESS;
2452 u32 alloc_len = READ_CAP_10_RESP_SIZE;
2453 u32 resp_size = READ_CAP_10_RESP_SIZE;
2456 struct nvme_dev *dev = ns->dev;
2457 dma_addr_t dma_addr;
2459 struct nvme_id_ns *id_ns;
2462 cdb16 = IS_READ_CAP_16(cmd);
2464 alloc_len = GET_READ_CAP_16_ALLOC_LENGTH(cmd);
2465 resp_size = READ_CAP_16_RESP_SIZE;
2468 mem = dma_alloc_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ns),
2469 &dma_addr, GFP_KERNEL);
2474 /* nvme ns identify */
2475 nvme_sc = nvme_identify(dev, ns->ns_id, 0, dma_addr);
2476 res = nvme_trans_status_code(hdr, nvme_sc);
2485 response = kmalloc(resp_size, GFP_KERNEL);
2486 if (response == NULL) {
2490 memset(response, 0, resp_size);
2491 nvme_trans_fill_read_cap(response, id_ns, cdb16);
2493 xfer_len = min(alloc_len, resp_size);
2494 res = nvme_trans_copy_to_user(hdr, response, xfer_len);
2498 dma_free_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ns), mem,
2504 static int nvme_trans_report_luns(struct nvme_ns *ns, struct sg_io_hdr *hdr,
2507 int res = SNTI_TRANSLATION_SUCCESS;
2509 u32 alloc_len, xfer_len, resp_size;
2512 struct nvme_dev *dev = ns->dev;
2513 dma_addr_t dma_addr;
2515 struct nvme_id_ctrl *id_ctrl;
2516 u32 ll_length, lun_id;
2517 u8 lun_id_offset = REPORT_LUNS_FIRST_LUN_OFFSET;
2520 alloc_len = GET_REPORT_LUNS_ALLOC_LENGTH(cmd);
2521 select_report = GET_U8_FROM_CDB(cmd, REPORT_LUNS_SR_OFFSET);
2523 if ((select_report != ALL_LUNS_RETURNED) &&
2524 (select_report != ALL_WELL_KNOWN_LUNS_RETURNED) &&
2525 (select_report != RESTRICTED_LUNS_RETURNED)) {
2526 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2527 ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
2528 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2531 /* NVMe Controller Identify */
2532 mem = dma_alloc_coherent(&dev->pci_dev->dev,
2533 sizeof(struct nvme_id_ctrl),
2534 &dma_addr, GFP_KERNEL);
2539 nvme_sc = nvme_identify(dev, 0, 1, dma_addr);
2540 res = nvme_trans_status_code(hdr, nvme_sc);
2548 ll_length = le32_to_cpu(id_ctrl->nn) * LUN_ENTRY_SIZE;
2549 resp_size = ll_length + LUN_DATA_HEADER_SIZE;
2551 if (alloc_len < resp_size) {
2552 res = nvme_trans_completion(hdr,
2553 SAM_STAT_CHECK_CONDITION,
2554 ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
2555 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2559 response = kmalloc(resp_size, GFP_KERNEL);
2560 if (response == NULL) {
2564 memset(response, 0, resp_size);
2566 /* The first LUN ID will always be 0 per the SAM spec */
2567 for (lun_id = 0; lun_id < le32_to_cpu(id_ctrl->nn); lun_id++) {
2569 * Set the LUN Id and then increment to the next LUN
2570 * location in the parameter data.
2572 __be64 tmp_id = cpu_to_be64(lun_id);
2573 memcpy(&response[lun_id_offset], &tmp_id, sizeof(u64));
2574 lun_id_offset += LUN_ENTRY_SIZE;
2576 tmp_len = cpu_to_be32(ll_length);
2577 memcpy(response, &tmp_len, sizeof(u32));
2580 xfer_len = min(alloc_len, resp_size);
2581 res = nvme_trans_copy_to_user(hdr, response, xfer_len);
2585 dma_free_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ctrl), mem,
2591 static int nvme_trans_request_sense(struct nvme_ns *ns, struct sg_io_hdr *hdr,
2594 int res = SNTI_TRANSLATION_SUCCESS;
2595 u8 alloc_len, xfer_len, resp_size;
2599 alloc_len = GET_REQUEST_SENSE_ALLOC_LENGTH(cmd);
2600 desc_format = GET_U8_FROM_CDB(cmd, REQUEST_SENSE_DESC_OFFSET);
2601 desc_format &= REQUEST_SENSE_DESC_MASK;
2603 resp_size = ((desc_format) ? (DESC_FMT_SENSE_DATA_SIZE) :
2604 (FIXED_FMT_SENSE_DATA_SIZE));
2605 response = kmalloc(resp_size, GFP_KERNEL);
2606 if (response == NULL) {
2610 memset(response, 0, resp_size);
2612 if (desc_format == DESCRIPTOR_FORMAT_SENSE_DATA_TYPE) {
2613 /* Descriptor Format Sense Data */
2614 response[0] = DESC_FORMAT_SENSE_DATA;
2615 response[1] = NO_SENSE;
2616 /* TODO How is LOW POWER CONDITION ON handled? (byte 2) */
2617 response[2] = SCSI_ASC_NO_SENSE;
2618 response[3] = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
2619 /* SDAT_OVFL = 0 | Additional Sense Length = 0 */
2621 /* Fixed Format Sense Data */
2622 response[0] = FIXED_SENSE_DATA;
2623 /* Byte 1 = Obsolete */
2624 response[2] = NO_SENSE; /* FM, EOM, ILI, SDAT_OVFL = 0 */
2625 /* Bytes 3-6 - Information - set to zero */
2626 response[7] = FIXED_SENSE_DATA_ADD_LENGTH;
2627 /* Bytes 8-11 - Cmd Specific Information - set to zero */
2628 response[12] = SCSI_ASC_NO_SENSE;
2629 response[13] = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
2630 /* Byte 14 = Field Replaceable Unit Code = 0 */
2631 /* Bytes 15-17 - SKSV=0; Sense Key Specific = 0 */
2634 xfer_len = min(alloc_len, resp_size);
2635 res = nvme_trans_copy_to_user(hdr, response, xfer_len);
2642 static int nvme_trans_security_protocol(struct nvme_ns *ns,
2643 struct sg_io_hdr *hdr,
2646 return nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2647 ILLEGAL_REQUEST, SCSI_ASC_ILLEGAL_COMMAND,
2648 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2651 static int nvme_trans_start_stop(struct nvme_ns *ns, struct sg_io_hdr *hdr,
2654 int res = SNTI_TRANSLATION_SUCCESS;
2656 struct nvme_queue *nvmeq;
2657 struct nvme_command c;
2658 u8 immed, pcmod, pc, no_flush, start;
2660 immed = GET_U8_FROM_CDB(cmd, START_STOP_UNIT_CDB_IMMED_OFFSET);
2661 pcmod = GET_U8_FROM_CDB(cmd, START_STOP_UNIT_CDB_POWER_COND_MOD_OFFSET);
2662 pc = GET_U8_FROM_CDB(cmd, START_STOP_UNIT_CDB_POWER_COND_OFFSET);
2663 no_flush = GET_U8_FROM_CDB(cmd, START_STOP_UNIT_CDB_NO_FLUSH_OFFSET);
2664 start = GET_U8_FROM_CDB(cmd, START_STOP_UNIT_CDB_START_OFFSET);
2666 immed &= START_STOP_UNIT_CDB_IMMED_MASK;
2667 pcmod &= START_STOP_UNIT_CDB_POWER_COND_MOD_MASK;
2668 pc = (pc & START_STOP_UNIT_CDB_POWER_COND_MASK) >> NIBBLE_SHIFT;
2669 no_flush &= START_STOP_UNIT_CDB_NO_FLUSH_MASK;
2670 start &= START_STOP_UNIT_CDB_START_MASK;
2673 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2674 ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
2675 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2677 if (no_flush == 0) {
2678 /* Issue NVME FLUSH command prior to START STOP UNIT */
2679 memset(&c, 0, sizeof(c));
2680 c.common.opcode = nvme_cmd_flush;
2681 c.common.nsid = cpu_to_le32(ns->ns_id);
2683 nvmeq = get_nvmeq(ns->dev);
2685 nvme_sc = nvme_submit_sync_cmd(nvmeq, &c, NULL, NVME_IO_TIMEOUT);
2687 res = nvme_trans_status_code(hdr, nvme_sc);
2695 /* Setup the expected power state transition */
2696 res = nvme_trans_power_state(ns, hdr, pc, pcmod, start);
2703 static int nvme_trans_synchronize_cache(struct nvme_ns *ns,
2704 struct sg_io_hdr *hdr, u8 *cmd)
2706 int res = SNTI_TRANSLATION_SUCCESS;
2708 struct nvme_command c;
2709 struct nvme_queue *nvmeq;
2711 memset(&c, 0, sizeof(c));
2712 c.common.opcode = nvme_cmd_flush;
2713 c.common.nsid = cpu_to_le32(ns->ns_id);
2715 nvmeq = get_nvmeq(ns->dev);
2717 nvme_sc = nvme_submit_sync_cmd(nvmeq, &c, NULL, NVME_IO_TIMEOUT);
2719 res = nvme_trans_status_code(hdr, nvme_sc);
2729 static int nvme_trans_format_unit(struct nvme_ns *ns, struct sg_io_hdr *hdr,
2732 int res = SNTI_TRANSLATION_SUCCESS;
2733 u8 parm_hdr_len = 0;
2734 u8 nvme_pf_code = 0;
2735 u8 format_prot_info, long_list, format_data;
2737 format_prot_info = GET_U8_FROM_CDB(cmd,
2738 FORMAT_UNIT_CDB_FORMAT_PROT_INFO_OFFSET);
2739 long_list = GET_U8_FROM_CDB(cmd, FORMAT_UNIT_CDB_LONG_LIST_OFFSET);
2740 format_data = GET_U8_FROM_CDB(cmd, FORMAT_UNIT_CDB_FORMAT_DATA_OFFSET);
2742 format_prot_info = (format_prot_info &
2743 FORMAT_UNIT_CDB_FORMAT_PROT_INFO_MASK) >>
2744 FORMAT_UNIT_CDB_FORMAT_PROT_INFO_SHIFT;
2745 long_list &= FORMAT_UNIT_CDB_LONG_LIST_MASK;
2746 format_data &= FORMAT_UNIT_CDB_FORMAT_DATA_MASK;
2748 if (format_data != 0) {
2749 if (format_prot_info != 0) {
2751 parm_hdr_len = FORMAT_UNIT_SHORT_PARM_LIST_LEN;
2753 parm_hdr_len = FORMAT_UNIT_LONG_PARM_LIST_LEN;
2755 } else if (format_data == 0 && format_prot_info != 0) {
2756 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2757 ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
2758 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2762 /* Get parm header from data-in/out buffer */
2764 * According to the translation spec, the only fields in the parameter
2765 * list we are concerned with are in the header. So allocate only that.
2767 if (parm_hdr_len > 0) {
2768 res = nvme_trans_fmt_get_parm_header(hdr, parm_hdr_len,
2769 format_prot_info, &nvme_pf_code);
2770 if (res != SNTI_TRANSLATION_SUCCESS)
2774 /* Attempt to activate any previously downloaded firmware image */
2775 res = nvme_trans_send_fw_cmd(ns, hdr, nvme_admin_activate_fw, 0, 0, 0);
2777 /* Determine Block size and count and send format command */
2778 res = nvme_trans_fmt_set_blk_size_count(ns, hdr);
2779 if (res != SNTI_TRANSLATION_SUCCESS)
2782 res = nvme_trans_fmt_send_cmd(ns, hdr, nvme_pf_code);
2788 static int nvme_trans_test_unit_ready(struct nvme_ns *ns,
2789 struct sg_io_hdr *hdr,
2792 int res = SNTI_TRANSLATION_SUCCESS;
2793 struct nvme_dev *dev = ns->dev;
2795 if (!(readl(&dev->bar->csts) & NVME_CSTS_RDY))
2796 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2797 NOT_READY, SCSI_ASC_LUN_NOT_READY,
2798 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2800 res = nvme_trans_completion(hdr, SAM_STAT_GOOD, NO_SENSE, 0, 0);
2805 static int nvme_trans_write_buffer(struct nvme_ns *ns, struct sg_io_hdr *hdr,
2808 int res = SNTI_TRANSLATION_SUCCESS;
2809 u32 buffer_offset, parm_list_length;
2813 GET_U24_FROM_CDB(cmd, WRITE_BUFFER_CDB_PARM_LIST_LENGTH_OFFSET);
2814 if (parm_list_length % BYTES_TO_DWORDS != 0) {
2815 /* NVMe expects Firmware file to be a whole number of DWORDS */
2816 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2817 ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
2818 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2821 buffer_id = GET_U8_FROM_CDB(cmd, WRITE_BUFFER_CDB_BUFFER_ID_OFFSET);
2822 if (buffer_id > NVME_MAX_FIRMWARE_SLOT) {
2823 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2824 ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
2825 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2828 mode = GET_U8_FROM_CDB(cmd, WRITE_BUFFER_CDB_MODE_OFFSET) &
2829 WRITE_BUFFER_CDB_MODE_MASK;
2831 GET_U24_FROM_CDB(cmd, WRITE_BUFFER_CDB_BUFFER_OFFSET_OFFSET);
2834 case DOWNLOAD_SAVE_ACTIVATE:
2835 res = nvme_trans_send_fw_cmd(ns, hdr, nvme_admin_download_fw,
2836 parm_list_length, buffer_offset,
2838 if (res != SNTI_TRANSLATION_SUCCESS)
2840 res = nvme_trans_send_fw_cmd(ns, hdr, nvme_admin_activate_fw,
2841 parm_list_length, buffer_offset,
2844 case DOWNLOAD_SAVE_DEFER_ACTIVATE:
2845 res = nvme_trans_send_fw_cmd(ns, hdr, nvme_admin_download_fw,
2846 parm_list_length, buffer_offset,
2849 case ACTIVATE_DEFERRED_MICROCODE:
2850 res = nvme_trans_send_fw_cmd(ns, hdr, nvme_admin_activate_fw,
2851 parm_list_length, buffer_offset,
2855 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2856 ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
2857 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2865 static int nvme_scsi_translate(struct nvme_ns *ns, struct sg_io_hdr *hdr)
2867 u8 cmd[BLK_MAX_CDB];
2869 unsigned int opcode;
2871 if (hdr->cmdp == NULL)
2873 if (copy_from_user(cmd, hdr->cmdp, hdr->cmd_len))
2883 retcode = nvme_trans_io(ns, hdr, 0, cmd);
2889 retcode = nvme_trans_io(ns, hdr, 1, cmd);
2892 retcode = nvme_trans_inquiry(ns, hdr, cmd);
2895 retcode = nvme_trans_log_sense(ns, hdr, cmd);
2898 case MODE_SELECT_10:
2899 retcode = nvme_trans_mode_select(ns, hdr, cmd);
2903 retcode = nvme_trans_mode_sense(ns, hdr, cmd);
2906 retcode = nvme_trans_read_capacity(ns, hdr, cmd);
2908 case SERVICE_ACTION_IN:
2909 if (IS_READ_CAP_16(cmd))
2910 retcode = nvme_trans_read_capacity(ns, hdr, cmd);
2915 retcode = nvme_trans_report_luns(ns, hdr, cmd);
2918 retcode = nvme_trans_request_sense(ns, hdr, cmd);
2920 case SECURITY_PROTOCOL_IN:
2921 case SECURITY_PROTOCOL_OUT:
2922 retcode = nvme_trans_security_protocol(ns, hdr, cmd);
2925 retcode = nvme_trans_start_stop(ns, hdr, cmd);
2927 case SYNCHRONIZE_CACHE:
2928 retcode = nvme_trans_synchronize_cache(ns, hdr, cmd);
2931 retcode = nvme_trans_format_unit(ns, hdr, cmd);
2933 case TEST_UNIT_READY:
2934 retcode = nvme_trans_test_unit_ready(ns, hdr, cmd);
2937 retcode = nvme_trans_write_buffer(ns, hdr, cmd);
2941 retcode = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2942 ILLEGAL_REQUEST, SCSI_ASC_ILLEGAL_COMMAND,
2943 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2949 int nvme_sg_io(struct nvme_ns *ns, struct sg_io_hdr __user *u_hdr)
2951 struct sg_io_hdr hdr;
2954 if (!capable(CAP_SYS_ADMIN))
2956 if (copy_from_user(&hdr, u_hdr, sizeof(hdr)))
2958 if (hdr.interface_id != 'S')
2960 if (hdr.cmd_len > BLK_MAX_CDB)
2963 retcode = nvme_scsi_translate(ns, &hdr);
2967 retcode = SNTI_TRANSLATION_SUCCESS;
2968 if (copy_to_user(u_hdr, &hdr, sizeof(sg_io_hdr_t)) > 0)
2974 int nvme_sg_get_version_num(int __user *ip)
2976 return put_user(sg_version_num, ip);