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
103 #define UNMAP_CDB_PARAM_LIST_LENGTH_OFFSET 7
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
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
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
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
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
241 /* Read Capacity defines */
242 #define READ_CAP_10_RESP_SIZE 8
243 #define READ_CAP_16_RESP_SIZE 32
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
251 /* Report LUNs defines */
252 #define REPORT_LUNS_FIRST_LUN_OFFSET 8
254 /* SCSI ADDITIONAL SENSE Codes */
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
274 /* SCSI ADDITIONAL SENSE Code Qualifiers */
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
286 * DEVICE_SPECIFIC_PARAMETER in mode parameter header (see sbc2r16) to
287 * enable DPOFUA support type 0x10 value.
289 #define DEVICE_SPECIFIC_PARAMETER 0
290 #define VPD_ID_DESCRIPTOR_LENGTH sizeof(VPD_IDENTIFICATION_DESCRIPTOR)
292 /* MACROs to extract information from CDBs */
294 #define GET_OPCODE(cdb) cdb[0]
296 #define GET_U8_FROM_CDB(cdb, index) (cdb[index] << 0)
298 #define GET_U16_FROM_CDB(cdb, index) ((cdb[index] << 8) | (cdb[index + 1] << 0))
300 #define GET_U24_FROM_CDB(cdb, index) ((cdb[index] << 16) | \
301 (cdb[index + 1] << 8) | \
302 (cdb[index + 2] << 0))
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))
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))
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)
323 #define GET_INQ_PAGE_CODE(cdb) \
324 (GET_U8_FROM_CDB(cdb, INQUIRY_PAGE_CODE_BYTE_OFFSET))
326 #define GET_INQ_ALLOC_LENGTH(cdb) \
327 (GET_U16_FROM_CDB(cdb, INQUIRY_CDB_ALLOCATION_LENGTH_OFFSET))
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))
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))
337 #define IS_READ_CAP_16(cdb) \
338 ((cdb[0] == SERVICE_ACTION_IN && cdb[1] == SAI_READ_CAPACITY_16) ? 1 : 0)
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))
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)
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)
353 #define GET_MODE_SENSE_MPH_SIZE(cdb10) \
354 (cdb10 ? MODE_SENSE10_MPH_SIZE : MODE_SENSE6_MPH_SIZE)
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. */
360 struct nvme_trans_io_cdb {
368 /* Internal Helper Functions */
371 /* Copy data to userspace memory */
373 static int nvme_trans_copy_to_user(struct sg_io_hdr *hdr, void *from,
376 int res = SNTI_TRANSLATION_SUCCESS;
377 unsigned long not_copied;
380 size_t remaining = n;
383 if (hdr->iovec_count > 0) {
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));
392 xfer_len = min(remaining, sgl.iov_len);
393 not_copied = copy_to_user(sgl.iov_base, index,
400 remaining -= xfer_len;
406 not_copied = copy_to_user(hdr->dxferp, from, n);
412 /* Copy data from userspace memory */
414 static int nvme_trans_copy_from_user(struct sg_io_hdr *hdr, void *to,
417 int res = SNTI_TRANSLATION_SUCCESS;
418 unsigned long not_copied;
421 size_t remaining = n;
424 if (hdr->iovec_count > 0) {
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));
433 xfer_len = min(remaining, sgl.iov_len);
434 not_copied = copy_from_user(index, sgl.iov_base,
441 remaining -= xfer_len;
448 not_copied = copy_from_user(to, hdr->dxferp, n);
454 /* Status/Sense Buffer Writeback */
456 static int nvme_trans_completion(struct sg_io_hdr *hdr, u8 status, u8 sense_key,
459 int res = SNTI_TRANSLATION_SUCCESS;
461 u8 resp[DESC_FMT_SENSE_DATA_SIZE];
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;
470 hdr->status = status;
471 hdr->masked_status = status >> 1;
472 hdr->host_status = DID_OK;
473 hdr->driver_status = DRIVER_OK;
475 memset(resp, 0, DESC_FMT_SENSE_DATA_SIZE);
476 resp[0] = DESC_FORMAT_SENSE_DATA;
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)
490 static int nvme_trans_status_code(struct sg_io_hdr *hdr, int nvme_sc)
492 u8 status, sense_key, asc, ascq;
493 int res = SNTI_TRANSLATION_SUCCESS;
495 /* For non-nvme (Linux) errors, simply return the error code */
499 /* Mask DNR, More, and reserved fields */
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;
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;
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;
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;
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;
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;
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;
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;
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;
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;
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;
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;
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;
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;
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;
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;
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;
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;
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;
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;
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;
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;
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;
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:
661 status = SAM_STAT_CHECK_CONDITION;
662 sense_key = ILLEGAL_REQUEST;
663 asc = SCSI_ASC_NO_SENSE;
664 ascq = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
668 res = nvme_trans_completion(hdr, status, sense_key, asc, ascq);
673 /* INQUIRY Helper Functions */
675 static int nvme_trans_standard_inquiry_page(struct nvme_ns *ns,
676 struct sg_io_hdr *hdr, u8 *inq_response,
679 struct nvme_dev *dev = ns->dev;
682 struct nvme_id_ns *id_ns;
683 int res = SNTI_TRANSLATION_SUCCESS;
686 u8 resp_data_format = 0x02;
688 u8 cmdque = 0x01 << 1;
690 mem = dma_alloc_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ns),
691 &dma_addr, GFP_KERNEL);
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);
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.
714 (id_ns->dps) ? (protect = 0x01) : (protect = 0);
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);
726 xfer_len = min(alloc_len, STANDARD_INQUIRY_LENGTH);
727 res = nvme_trans_copy_to_user(hdr, inq_response, xfer_len);
730 dma_free_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ns), mem,
736 static int nvme_trans_supported_vpd_pages(struct nvme_ns *ns,
737 struct sg_io_hdr *hdr, u8 *inq_response,
740 int res = SNTI_TRANSLATION_SUCCESS;
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;
752 xfer_len = min(alloc_len, STANDARD_INQUIRY_LENGTH);
753 res = nvme_trans_copy_to_user(hdr, inq_response, xfer_len);
758 static int nvme_trans_unit_serial_page(struct nvme_ns *ns,
759 struct sg_io_hdr *hdr, u8 *inq_response,
762 struct nvme_dev *dev = ns->dev;
763 int res = SNTI_TRANSLATION_SUCCESS;
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);
771 xfer_len = min(alloc_len, STANDARD_INQUIRY_LENGTH);
772 res = nvme_trans_copy_to_user(hdr, inq_response, xfer_len);
777 static int nvme_trans_device_id_page(struct nvme_ns *ns, struct sg_io_hdr *hdr,
778 u8 *inq_response, int alloc_len)
780 struct nvme_dev *dev = ns->dev;
783 struct nvme_id_ctrl *id_ctrl;
784 int res = SNTI_TRANSLATION_SUCCESS;
788 __be32 tmp_id = cpu_to_be32(ns->ns_id);
790 mem = dma_alloc_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ns),
791 &dma_addr, GFP_KERNEL);
797 /* nvme controller identify */
798 nvme_sc = nvme_identify(dev, 0, 1, dma_addr);
799 res = nvme_trans_status_code(hdr, nvme_sc);
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;
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 */
836 xfer_len = min(alloc_len, STANDARD_INQUIRY_LENGTH);
837 res = nvme_trans_copy_to_user(hdr, inq_response, xfer_len);
840 dma_free_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ns), mem,
846 static int nvme_trans_ext_inq_page(struct nvme_ns *ns, struct sg_io_hdr *hdr,
850 int res = SNTI_TRANSLATION_SUCCESS;
852 struct nvme_dev *dev = ns->dev;
855 struct nvme_id_ctrl *id_ctrl;
856 struct nvme_id_ns *id_ns;
860 u8 spt_lut[8] = {0, 0, 2, 1, 4, 6, 5, 7};
861 u8 grd_chk, app_chk, ref_chk, protect;
866 inq_response = kmalloc(EXTENDED_INQUIRY_DATA_PAGE_LENGTH, GFP_KERNEL);
867 if (inq_response == NULL) {
872 mem = dma_alloc_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ns),
873 &dma_addr, GFP_KERNEL);
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);
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;
895 /* nvme controller identify */
896 nvme_sc = nvme_identify(dev, 0, 1, dma_addr);
897 res = nvme_trans_status_code(hdr, nvme_sc);
905 v_sup = id_ctrl->vwc;
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;
918 xfer_len = min(alloc_len, EXTENDED_INQUIRY_DATA_PAGE_LENGTH);
919 res = nvme_trans_copy_to_user(hdr, inq_response, xfer_len);
922 dma_free_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ns), mem,
930 static int nvme_trans_bdev_char_page(struct nvme_ns *ns, struct sg_io_hdr *hdr,
934 int res = SNTI_TRANSLATION_SUCCESS;
937 inq_response = kmalloc(EXTENDED_INQUIRY_DATA_PAGE_LENGTH, GFP_KERNEL);
938 if (inq_response == NULL) {
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 */
951 xfer_len = min(alloc_len, EXTENDED_INQUIRY_DATA_PAGE_LENGTH);
952 res = nvme_trans_copy_to_user(hdr, inq_response, xfer_len);
959 /* LOG SENSE Helper Functions */
961 static int nvme_trans_log_supp_pages(struct nvme_ns *ns, struct sg_io_hdr *hdr,
964 int res = SNTI_TRANSLATION_SUCCESS;
968 log_response = kmalloc(LOG_PAGE_SUPPORTED_LOG_PAGES_LENGTH, GFP_KERNEL);
969 if (log_response == NULL) {
973 memset(log_response, 0, LOG_PAGE_SUPPORTED_LOG_PAGES_LENGTH);
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;
982 xfer_len = min(alloc_len, LOG_PAGE_SUPPORTED_LOG_PAGES_LENGTH);
983 res = nvme_trans_copy_to_user(hdr, log_response, xfer_len);
990 static int nvme_trans_log_info_exceptions(struct nvme_ns *ns,
991 struct sg_io_hdr *hdr, int alloc_len)
993 int res = SNTI_TRANSLATION_SUCCESS;
996 struct nvme_command c;
997 struct nvme_dev *dev = ns->dev;
998 struct nvme_smart_log *smart_log;
1004 log_response = kmalloc(LOG_INFO_EXCP_PAGE_LENGTH, GFP_KERNEL);
1005 if (log_response == NULL) {
1009 memset(log_response, 0, LOG_INFO_EXCP_PAGE_LENGTH);
1011 mem = dma_alloc_coherent(&dev->pci_dev->dev,
1012 sizeof(struct nvme_smart_log),
1013 &dma_addr, GFP_KERNEL);
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;
1031 temp_k = (smart_log->temperature[1] << 8) +
1032 (smart_log->temperature[0]);
1033 temp_c = temp_k - KELVIN_TEMP_FACTOR;
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;
1047 xfer_len = min(alloc_len, LOG_INFO_EXCP_PAGE_LENGTH);
1048 res = nvme_trans_copy_to_user(hdr, log_response, xfer_len);
1050 dma_free_coherent(&dev->pci_dev->dev, sizeof(struct nvme_smart_log),
1053 kfree(log_response);
1058 static int nvme_trans_log_temperature(struct nvme_ns *ns, struct sg_io_hdr *hdr,
1061 int res = SNTI_TRANSLATION_SUCCESS;
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;
1070 u8 temp_c_cur, temp_c_thresh;
1073 log_response = kmalloc(LOG_TEMP_PAGE_LENGTH, GFP_KERNEL);
1074 if (log_response == NULL) {
1078 memset(log_response, 0, LOG_TEMP_PAGE_LENGTH);
1080 mem = dma_alloc_coherent(&dev->pci_dev->dev,
1081 sizeof(struct nvme_smart_log),
1082 &dma_addr, GFP_KERNEL);
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;
1100 temp_k = (smart_log->temperature[1] << 8) +
1101 (smart_log->temperature[0]);
1102 temp_c_cur = temp_k - KELVIN_TEMP_FACTOR;
1105 /* Get Features for Temp Threshold */
1106 res = nvme_get_features(dev, NVME_FEAT_TEMP_THRESH, 0, 0,
1108 if (res != NVME_SC_SUCCESS)
1109 temp_c_thresh = LOG_TEMP_UNKNOWN;
1111 temp_c_thresh = (feature_resp & 0xFFFF) - KELVIN_TEMP_FACTOR;
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;
1129 xfer_len = min(alloc_len, LOG_TEMP_PAGE_LENGTH);
1130 res = nvme_trans_copy_to_user(hdr, log_response, xfer_len);
1132 dma_free_coherent(&dev->pci_dev->dev, sizeof(struct nvme_smart_log),
1135 kfree(log_response);
1140 /* MODE SENSE Helper Functions */
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)
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;
1150 resp[0] = (mode_data_length & 0xFF00) >> 8;
1151 resp[1] = (mode_data_length & 0x00FF);
1152 /* resp[2] and [3] are zero */
1154 resp[5] = RESERVED_FIELD;
1155 resp[6] = (blk_desc_len & 0xFF00) >> 8;
1156 resp[7] = (blk_desc_len & 0x00FF);
1158 resp[0] = (mode_data_length & 0x00FF);
1159 /* resp[1] and [2] are zero */
1160 resp[3] = (blk_desc_len & 0x00FF);
1163 return SNTI_TRANSLATION_SUCCESS;
1166 static int nvme_trans_fill_blk_desc(struct nvme_ns *ns, struct sg_io_hdr *hdr,
1167 u8 *resp, int len, u8 llbaa)
1169 int res = SNTI_TRANSLATION_SUCCESS;
1171 struct nvme_dev *dev = ns->dev;
1172 dma_addr_t dma_addr;
1174 struct nvme_id_ns *id_ns;
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;
1183 mem = dma_alloc_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ns),
1184 &dma_addr, GFP_KERNEL);
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);
1200 flbas = (id_ns->flbas) & 0x0F;
1201 lba_length = (1 << (id_ns->lbaf[flbas].ds));
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);
1208 memcpy(resp, &tmp_cap, sizeof(u32));
1209 memcpy(&resp[4], &tmp_len, sizeof(u32));
1211 __be64 tmp_cap = cpu_to_be64(le64_to_cpu(id_ns->ncap));
1212 __be32 tmp_len = cpu_to_be32(lba_length);
1214 memcpy(resp, &tmp_cap, sizeof(u64));
1215 /* Bytes 8, 9, 10, 11 are reserved */
1216 memcpy(&resp[12], &tmp_len, sizeof(u32));
1220 dma_free_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ns), mem,
1226 static int nvme_trans_fill_control_page(struct nvme_ns *ns,
1227 struct sg_io_hdr *hdr, u8 *resp,
1230 if (len < MODE_PAGE_CONTROL_LEN)
1231 return SNTI_INTERNAL_ERROR;
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 */
1243 /* Bytes 10,11: Extended selftest completion time = 0x0000 */
1245 return SNTI_TRANSLATION_SUCCESS;
1248 static int nvme_trans_fill_caching_page(struct nvme_ns *ns,
1249 struct sg_io_hdr *hdr,
1252 int res = SNTI_TRANSLATION_SUCCESS;
1254 struct nvme_dev *dev = ns->dev;
1258 if (len < MODE_PAGE_CACHING_LEN)
1259 return SNTI_INTERNAL_ERROR;
1261 nvme_sc = nvme_get_features(dev, NVME_FEAT_VOLATILE_WC, 0, 0,
1263 res = nvme_trans_status_code(hdr, nvme_sc);
1270 vwc = feature_resp & 0x00000001;
1272 resp[0] = MODE_PAGE_CACHING;
1273 resp[1] = MODE_PAGE_CACHING_LEN_FIELD;
1280 static int nvme_trans_fill_pow_cnd_page(struct nvme_ns *ns,
1281 struct sg_io_hdr *hdr, u8 *resp,
1284 int res = SNTI_TRANSLATION_SUCCESS;
1286 if (len < MODE_PAGE_POW_CND_LEN)
1287 return SNTI_INTERNAL_ERROR;
1289 resp[0] = MODE_PAGE_POWER_CONDITION;
1290 resp[1] = MODE_PAGE_POW_CND_LEN_FIELD;
1291 /* All other bytes are zero */
1296 static int nvme_trans_fill_inf_exc_page(struct nvme_ns *ns,
1297 struct sg_io_hdr *hdr, u8 *resp,
1300 int res = SNTI_TRANSLATION_SUCCESS;
1302 if (len < MODE_PAGE_INF_EXC_LEN)
1303 return SNTI_INTERNAL_ERROR;
1305 resp[0] = MODE_PAGE_INFO_EXCEP;
1306 resp[1] = MODE_PAGE_INF_EXC_LEN_FIELD;
1308 /* All other bytes are zero */
1313 static int nvme_trans_fill_all_pages(struct nvme_ns *ns, struct sg_io_hdr *hdr,
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;
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;
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)
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)
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)
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)
1345 static inline int nvme_trans_get_blk_desc_len(u8 dbd, u8 llbaa)
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;
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)
1360 struct sg_io_hdr *hdr, u8 *, int),
1361 u16 mode_pages_tot_len)
1363 int res = SNTI_TRANSLATION_SUCCESS;
1369 u16 mode_pages_offset_1;
1370 u16 blk_desc_len, blk_desc_offset, mode_data_length;
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);
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;
1381 blk_desc_offset = mph_size;
1382 mode_pages_offset_1 = blk_desc_offset + blk_desc_len;
1384 response = kmalloc(resp_size, GFP_KERNEL);
1385 if (response == NULL) {
1389 memset(response, 0, resp_size);
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)
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)
1402 res = mode_page_fill_func(ns, hdr, &response[mode_pages_offset_1],
1403 mode_pages_tot_len);
1404 if (res != SNTI_TRANSLATION_SUCCESS)
1407 xfer_len = min(alloc_len, resp_size);
1408 res = nvme_trans_copy_to_user(hdr, response, xfer_len);
1416 /* Read Capacity Helper Functions */
1418 static void nvme_trans_fill_read_cap(u8 *response, struct nvme_id_ns *id_ns,
1425 u8 p_type_lut[4] = {0, 0, 1, 2};
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);
1436 if (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));
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 */
1454 /* Start Stop Unit Helper Functions */
1456 static int nvme_trans_power_state(struct nvme_ns *ns, struct sg_io_hdr *hdr,
1457 u8 pc, u8 pcmod, u8 start)
1459 int res = SNTI_TRANSLATION_SUCCESS;
1461 struct nvme_dev *dev = ns->dev;
1462 dma_addr_t dma_addr;
1464 struct nvme_id_ctrl *id_ctrl;
1465 int lowest_pow_st; /* max npss = lowest power consumption */
1466 unsigned ps_desired = 0;
1468 /* NVMe Controller Identify */
1469 mem = dma_alloc_coherent(&dev->pci_dev->dev,
1470 sizeof(struct nvme_id_ctrl),
1471 &dma_addr, GFP_KERNEL);
1476 nvme_sc = nvme_identify(dev, 0, 1, dma_addr);
1477 res = nvme_trans_status_code(hdr, nvme_sc);
1485 lowest_pow_st = id_ctrl->npss - 1;
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;
1495 case NVME_POWER_STATE_ACTIVE:
1496 /* Action unspecified if POWER CONDITION MODIFIER != 0 */
1498 ps_desired = POWER_STATE_0;
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 */
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));
1510 case NVME_POWER_STATE_STANDBY:
1511 /* Action unspecified if POWER CONDITION MODIFIER != [0,1] */
1513 ps_desired = max(0, (lowest_pow_st - 2));
1514 else if (pcmod == 0x1)
1515 ps_desired = max(0, (lowest_pow_st - 1));
1517 case NVME_POWER_STATE_LU_CONTROL:
1519 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
1520 ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
1521 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
1524 nvme_sc = nvme_set_features(dev, NVME_FEAT_POWER_MGMT, ps_desired, 0,
1526 res = nvme_trans_status_code(hdr, nvme_sc);
1532 dma_free_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ctrl), mem,
1538 /* Write Buffer Helper Functions */
1539 /* Also using this for Format Unit with hdr passed as NULL, and buffer_id, 0 */
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,
1545 int res = SNTI_TRANSLATION_SUCCESS;
1547 struct nvme_dev *dev = ns->dev;
1548 struct nvme_command c;
1549 struct nvme_iod *iod = NULL;
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,
1560 SCSI_ASC_INVALID_CDB,
1561 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
1564 iod = nvme_map_user_pages(dev, DMA_TO_DEVICE,
1565 (unsigned long)hdr->dxferp, tot_len);
1570 length = nvme_setup_prps(dev, &c.common, iod, tot_len,
1572 if (length != tot_len) {
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 u32 cdw10 = buffer_id | NVME_FWACT_REPL_ACTV;
1581 c.common.cdw10[0] = cpu_to_le32(cdw10);
1584 nvme_sc = nvme_submit_admin_cmd(dev, &c, NULL);
1585 res = nvme_trans_status_code(hdr, nvme_sc);
1592 if (opcode == nvme_admin_download_fw) {
1593 nvme_unmap_user_pages(dev, DMA_TO_DEVICE, iod);
1594 nvme_free_iod(dev, iod);
1600 /* Mode Select Helper Functions */
1602 static inline void nvme_trans_modesel_get_bd_len(u8 *parm_list, u8 cdb10,
1603 u16 *bd_len, u8 *llbaa)
1607 *bd_len = (parm_list[MODE_SELECT_10_BD_OFFSET] << 8) +
1608 parm_list[MODE_SELECT_10_BD_OFFSET + 1];
1609 *llbaa = parm_list[MODE_SELECT_10_LLBAA_OFFSET] &&
1610 MODE_SELECT_10_LLBAA_MASK;
1613 *bd_len = parm_list[MODE_SELECT_6_BD_OFFSET];
1617 static void nvme_trans_modesel_save_bd(struct nvme_ns *ns, u8 *parm_list,
1618 u16 idx, u16 bd_len, u8 llbaa)
1622 bd_num = bd_len / ((llbaa == 0) ?
1623 SHORT_DESC_BLOCK : LONG_DESC_BLOCK);
1624 /* Store block descriptor info if a FORMAT UNIT comes later */
1625 /* TODO Saving 1st BD info; what to do if multiple BD received? */
1627 /* Standard Block Descriptor - spc4r34 7.5.5.1 */
1628 ns->mode_select_num_blocks =
1629 (parm_list[idx + 1] << 16) +
1630 (parm_list[idx + 2] << 8) +
1631 (parm_list[idx + 3]);
1633 ns->mode_select_block_len =
1634 (parm_list[idx + 5] << 16) +
1635 (parm_list[idx + 6] << 8) +
1636 (parm_list[idx + 7]);
1638 /* Long LBA Block Descriptor - sbc3r27 6.4.2.3 */
1639 ns->mode_select_num_blocks =
1640 (((u64)parm_list[idx + 0]) << 56) +
1641 (((u64)parm_list[idx + 1]) << 48) +
1642 (((u64)parm_list[idx + 2]) << 40) +
1643 (((u64)parm_list[idx + 3]) << 32) +
1644 (((u64)parm_list[idx + 4]) << 24) +
1645 (((u64)parm_list[idx + 5]) << 16) +
1646 (((u64)parm_list[idx + 6]) << 8) +
1647 ((u64)parm_list[idx + 7]);
1649 ns->mode_select_block_len =
1650 (parm_list[idx + 12] << 24) +
1651 (parm_list[idx + 13] << 16) +
1652 (parm_list[idx + 14] << 8) +
1653 (parm_list[idx + 15]);
1657 static u16 nvme_trans_modesel_get_mp(struct nvme_ns *ns, struct sg_io_hdr *hdr,
1658 u8 *mode_page, u8 page_code)
1660 int res = SNTI_TRANSLATION_SUCCESS;
1662 struct nvme_dev *dev = ns->dev;
1665 switch (page_code) {
1666 case MODE_PAGE_CACHING:
1667 dword11 = ((mode_page[2] & CACHING_MODE_PAGE_WCE_MASK) ? 1 : 0);
1668 nvme_sc = nvme_set_features(dev, NVME_FEAT_VOLATILE_WC, dword11,
1670 res = nvme_trans_status_code(hdr, nvme_sc);
1678 case MODE_PAGE_CONTROL:
1680 case MODE_PAGE_POWER_CONDITION:
1681 /* Verify the OS is not trying to set timers */
1682 if ((mode_page[2] & 0x01) != 0 || (mode_page[3] & 0x0F) != 0) {
1683 res = nvme_trans_completion(hdr,
1684 SAM_STAT_CHECK_CONDITION,
1686 SCSI_ASC_INVALID_PARAMETER,
1687 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
1689 res = SNTI_INTERNAL_ERROR;
1694 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
1695 ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
1696 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
1698 res = SNTI_INTERNAL_ERROR;
1705 static int nvme_trans_modesel_data(struct nvme_ns *ns, struct sg_io_hdr *hdr,
1706 u8 *cmd, u16 parm_list_len, u8 pf,
1709 int res = SNTI_TRANSLATION_SUCCESS;
1713 u16 index, saved_index;
1717 /* Get parm list from data-in/out buffer */
1718 parm_list = kmalloc(parm_list_len, GFP_KERNEL);
1719 if (parm_list == NULL) {
1724 res = nvme_trans_copy_from_user(hdr, parm_list, parm_list_len);
1725 if (res != SNTI_TRANSLATION_SUCCESS)
1728 nvme_trans_modesel_get_bd_len(parm_list, cdb10, &bd_len, &llbaa);
1729 index = (cdb10) ? (MODE_SELECT_10_MPH_SIZE) : (MODE_SELECT_6_MPH_SIZE);
1732 /* Block Descriptors present, parse */
1733 nvme_trans_modesel_save_bd(ns, parm_list, index, bd_len, llbaa);
1736 saved_index = index;
1738 /* Multiple mode pages may be present; iterate through all */
1739 /* In 1st Iteration, don't do NVME Command, only check for CDB errors */
1741 page_code = parm_list[index] & MODE_SELECT_PAGE_CODE_MASK;
1742 mp_size = parm_list[index + 1] + 2;
1743 if ((page_code != MODE_PAGE_CACHING) &&
1744 (page_code != MODE_PAGE_CONTROL) &&
1745 (page_code != MODE_PAGE_POWER_CONDITION)) {
1746 res = nvme_trans_completion(hdr,
1747 SAM_STAT_CHECK_CONDITION,
1749 SCSI_ASC_INVALID_CDB,
1750 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
1754 } while (index < parm_list_len);
1756 /* In 2nd Iteration, do the NVME Commands */
1757 index = saved_index;
1759 page_code = parm_list[index] & MODE_SELECT_PAGE_CODE_MASK;
1760 mp_size = parm_list[index + 1] + 2;
1761 res = nvme_trans_modesel_get_mp(ns, hdr, &parm_list[index],
1763 if (res != SNTI_TRANSLATION_SUCCESS)
1766 } while (index < parm_list_len);
1774 /* Format Unit Helper Functions */
1776 static int nvme_trans_fmt_set_blk_size_count(struct nvme_ns *ns,
1777 struct sg_io_hdr *hdr)
1779 int res = SNTI_TRANSLATION_SUCCESS;
1781 struct nvme_dev *dev = ns->dev;
1782 dma_addr_t dma_addr;
1784 struct nvme_id_ns *id_ns;
1788 * SCSI Expects a MODE SELECT would have been issued prior to
1789 * a FORMAT UNIT, and the block size and number would be used
1790 * from the block descriptor in it. If a MODE SELECT had not
1791 * been issued, FORMAT shall use the current values for both.
1794 if (ns->mode_select_num_blocks == 0 || ns->mode_select_block_len == 0) {
1795 mem = dma_alloc_coherent(&dev->pci_dev->dev,
1796 sizeof(struct nvme_id_ns), &dma_addr, GFP_KERNEL);
1801 /* nvme ns identify */
1802 nvme_sc = nvme_identify(dev, ns->ns_id, 0, dma_addr);
1803 res = nvme_trans_status_code(hdr, nvme_sc);
1812 if (ns->mode_select_num_blocks == 0)
1813 ns->mode_select_num_blocks = le64_to_cpu(id_ns->ncap);
1814 if (ns->mode_select_block_len == 0) {
1815 flbas = (id_ns->flbas) & 0x0F;
1816 ns->mode_select_block_len =
1817 (1 << (id_ns->lbaf[flbas].ds));
1820 dma_free_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ns),
1827 static int nvme_trans_fmt_get_parm_header(struct sg_io_hdr *hdr, u8 len,
1828 u8 format_prot_info, u8 *nvme_pf_code)
1830 int res = SNTI_TRANSLATION_SUCCESS;
1832 u8 pf_usage, pf_code;
1834 parm_list = kmalloc(len, GFP_KERNEL);
1835 if (parm_list == NULL) {
1839 res = nvme_trans_copy_from_user(hdr, parm_list, len);
1840 if (res != SNTI_TRANSLATION_SUCCESS)
1843 if ((parm_list[FORMAT_UNIT_IMMED_OFFSET] &
1844 FORMAT_UNIT_IMMED_MASK) != 0) {
1845 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
1846 ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
1847 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
1851 if (len == FORMAT_UNIT_LONG_PARM_LIST_LEN &&
1852 (parm_list[FORMAT_UNIT_PROT_INT_OFFSET] & 0x0F) != 0) {
1853 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
1854 ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
1855 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
1858 pf_usage = parm_list[FORMAT_UNIT_PROT_FIELD_USAGE_OFFSET] &
1859 FORMAT_UNIT_PROT_FIELD_USAGE_MASK;
1860 pf_code = (pf_usage << 2) | format_prot_info;
1875 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
1876 ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
1877 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
1887 static int nvme_trans_fmt_send_cmd(struct nvme_ns *ns, struct sg_io_hdr *hdr,
1890 int res = SNTI_TRANSLATION_SUCCESS;
1892 struct nvme_dev *dev = ns->dev;
1893 dma_addr_t dma_addr;
1895 struct nvme_id_ns *id_ns;
1898 u8 selected_lbaf = 0xFF;
1900 struct nvme_command c;
1902 /* Loop thru LBAF's in id_ns to match reqd lbaf, put in cdw10 */
1903 mem = dma_alloc_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ns),
1904 &dma_addr, GFP_KERNEL);
1909 /* nvme ns identify */
1910 nvme_sc = nvme_identify(dev, ns->ns_id, 0, dma_addr);
1911 res = nvme_trans_status_code(hdr, nvme_sc);
1919 flbas = (id_ns->flbas) & 0x0F;
1920 nlbaf = id_ns->nlbaf;
1922 for (i = 0; i < nlbaf; i++) {
1923 if (ns->mode_select_block_len == (1 << (id_ns->lbaf[i].ds))) {
1928 if (selected_lbaf > 0x0F) {
1929 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
1930 ILLEGAL_REQUEST, SCSI_ASC_INVALID_PARAMETER,
1931 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
1933 if (ns->mode_select_num_blocks != le64_to_cpu(id_ns->ncap)) {
1934 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
1935 ILLEGAL_REQUEST, SCSI_ASC_INVALID_PARAMETER,
1936 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
1939 cdw10 |= prot_info << 5;
1940 cdw10 |= selected_lbaf & 0x0F;
1941 memset(&c, 0, sizeof(c));
1942 c.format.opcode = nvme_admin_format_nvm;
1943 c.format.nsid = cpu_to_le32(ns->ns_id);
1944 c.format.cdw10 = cpu_to_le32(cdw10);
1946 nvme_sc = nvme_submit_admin_cmd(dev, &c, NULL);
1947 res = nvme_trans_status_code(hdr, nvme_sc);
1954 dma_free_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ns), mem,
1960 /* Read/Write Helper Functions */
1962 static inline void nvme_trans_get_io_cdb6(u8 *cmd,
1963 struct nvme_trans_io_cdb *cdb_info)
1966 cdb_info->prot_info = 0;
1967 cdb_info->lba = GET_U32_FROM_CDB(cmd, IO_6_CDB_LBA_OFFSET) &
1969 cdb_info->xfer_len = GET_U8_FROM_CDB(cmd, IO_6_CDB_TX_LEN_OFFSET);
1971 /* sbc3r27 sec 5.32 - TRANSFER LEN of 0 implies a 256 Block transfer */
1972 if (cdb_info->xfer_len == 0)
1973 cdb_info->xfer_len = IO_6_DEFAULT_TX_LEN;
1976 static inline void nvme_trans_get_io_cdb10(u8 *cmd,
1977 struct nvme_trans_io_cdb *cdb_info)
1979 cdb_info->fua = GET_U8_FROM_CDB(cmd, IO_10_CDB_FUA_OFFSET) &
1981 cdb_info->prot_info = GET_U8_FROM_CDB(cmd, IO_10_CDB_WP_OFFSET) &
1982 IO_CDB_WP_MASK >> IO_CDB_WP_SHIFT;
1983 cdb_info->lba = GET_U32_FROM_CDB(cmd, IO_10_CDB_LBA_OFFSET);
1984 cdb_info->xfer_len = GET_U16_FROM_CDB(cmd, IO_10_CDB_TX_LEN_OFFSET);
1987 static inline void nvme_trans_get_io_cdb12(u8 *cmd,
1988 struct nvme_trans_io_cdb *cdb_info)
1990 cdb_info->fua = GET_U8_FROM_CDB(cmd, IO_12_CDB_FUA_OFFSET) &
1992 cdb_info->prot_info = GET_U8_FROM_CDB(cmd, IO_12_CDB_WP_OFFSET) &
1993 IO_CDB_WP_MASK >> IO_CDB_WP_SHIFT;
1994 cdb_info->lba = GET_U32_FROM_CDB(cmd, IO_12_CDB_LBA_OFFSET);
1995 cdb_info->xfer_len = GET_U32_FROM_CDB(cmd, IO_12_CDB_TX_LEN_OFFSET);
1998 static inline void nvme_trans_get_io_cdb16(u8 *cmd,
1999 struct nvme_trans_io_cdb *cdb_info)
2001 cdb_info->fua = GET_U8_FROM_CDB(cmd, IO_16_CDB_FUA_OFFSET) &
2003 cdb_info->prot_info = GET_U8_FROM_CDB(cmd, IO_16_CDB_WP_OFFSET) &
2004 IO_CDB_WP_MASK >> IO_CDB_WP_SHIFT;
2005 cdb_info->lba = GET_U64_FROM_CDB(cmd, IO_16_CDB_LBA_OFFSET);
2006 cdb_info->xfer_len = GET_U32_FROM_CDB(cmd, IO_16_CDB_TX_LEN_OFFSET);
2009 static inline u32 nvme_trans_io_get_num_cmds(struct sg_io_hdr *hdr,
2010 struct nvme_trans_io_cdb *cdb_info,
2013 /* If using iovecs, send one nvme command per vector */
2014 if (hdr->iovec_count > 0)
2015 return hdr->iovec_count;
2016 else if (cdb_info->xfer_len > max_blocks)
2017 return ((cdb_info->xfer_len - 1) / max_blocks) + 1;
2022 static u16 nvme_trans_io_get_control(struct nvme_ns *ns,
2023 struct nvme_trans_io_cdb *cdb_info)
2027 /* When Protection information support is added, implement here */
2029 if (cdb_info->fua > 0)
2030 control |= NVME_RW_FUA;
2035 static int nvme_trans_do_nvme_io(struct nvme_ns *ns, struct sg_io_hdr *hdr,
2036 struct nvme_trans_io_cdb *cdb_info, u8 is_write)
2038 int res = SNTI_TRANSLATION_SUCCESS;
2040 struct nvme_dev *dev = ns->dev;
2041 struct nvme_queue *nvmeq;
2043 struct nvme_iod *iod;
2045 u64 unit_num_blocks; /* Number of blocks to xfer in each nvme cmd */
2048 u64 nvme_offset = 0;
2049 void __user *next_mapping_addr;
2050 struct nvme_command c;
2051 u8 opcode = (is_write ? nvme_cmd_write : nvme_cmd_read);
2053 u32 max_blocks = nvme_block_nr(ns, dev->max_hw_sectors);
2055 num_cmds = nvme_trans_io_get_num_cmds(hdr, cdb_info, max_blocks);
2058 * This loop handles two cases.
2059 * First, when an SGL is used in the form of an iovec list:
2060 * - Use iov_base as the next mapping address for the nvme command_id
2061 * - Use iov_len as the data transfer length for the command.
2062 * Second, when we have a single buffer
2063 * - If larger than max_blocks, split into chunks, offset
2064 * each nvme command accordingly.
2066 for (i = 0; i < num_cmds; i++) {
2067 memset(&c, 0, sizeof(c));
2068 if (hdr->iovec_count > 0) {
2069 struct sg_iovec sgl;
2071 retcode = copy_from_user(&sgl, hdr->dxferp +
2072 i * sizeof(struct sg_iovec),
2073 sizeof(struct sg_iovec));
2076 unit_len = sgl.iov_len;
2077 unit_num_blocks = unit_len >> ns->lba_shift;
2078 next_mapping_addr = sgl.iov_base;
2080 unit_num_blocks = min((u64)max_blocks,
2081 (cdb_info->xfer_len - nvme_offset));
2082 unit_len = unit_num_blocks << ns->lba_shift;
2083 next_mapping_addr = hdr->dxferp +
2084 ((1 << ns->lba_shift) * nvme_offset);
2087 c.rw.opcode = opcode;
2088 c.rw.nsid = cpu_to_le32(ns->ns_id);
2089 c.rw.slba = cpu_to_le64(cdb_info->lba + nvme_offset);
2090 c.rw.length = cpu_to_le16(unit_num_blocks - 1);
2091 control = nvme_trans_io_get_control(ns, cdb_info);
2092 c.rw.control = cpu_to_le16(control);
2094 iod = nvme_map_user_pages(dev,
2095 (is_write) ? DMA_TO_DEVICE : DMA_FROM_DEVICE,
2096 (unsigned long)next_mapping_addr, unit_len);
2101 retcode = nvme_setup_prps(dev, &c.common, iod, unit_len,
2103 if (retcode != unit_len) {
2104 nvme_unmap_user_pages(dev,
2105 (is_write) ? DMA_TO_DEVICE : DMA_FROM_DEVICE,
2107 nvme_free_iod(dev, iod);
2112 nvme_offset += unit_num_blocks;
2114 nvmeq = get_nvmeq(dev);
2116 * Since nvme_submit_sync_cmd sleeps, we can't keep
2117 * preemption disabled. We may be preempted at any
2118 * point, and be rescheduled to a different CPU. That
2119 * will cause cacheline bouncing, but no additional
2120 * races since q_lock already protects against other
2124 nvme_sc = nvme_submit_sync_cmd(nvmeq, &c, NULL,
2126 if (nvme_sc != NVME_SC_SUCCESS) {
2127 nvme_unmap_user_pages(dev,
2128 (is_write) ? DMA_TO_DEVICE : DMA_FROM_DEVICE,
2130 nvme_free_iod(dev, iod);
2131 res = nvme_trans_status_code(hdr, nvme_sc);
2134 nvme_unmap_user_pages(dev,
2135 (is_write) ? DMA_TO_DEVICE : DMA_FROM_DEVICE,
2137 nvme_free_iod(dev, iod);
2139 res = nvme_trans_status_code(hdr, NVME_SC_SUCCESS);
2146 /* SCSI Command Translation Functions */
2148 static int nvme_trans_io(struct nvme_ns *ns, struct sg_io_hdr *hdr, u8 is_write,
2151 int res = SNTI_TRANSLATION_SUCCESS;
2152 struct nvme_trans_io_cdb cdb_info;
2155 u64 sum_iov_len = 0;
2156 struct sg_iovec sgl;
2160 /* Extract Fields from CDB */
2164 nvme_trans_get_io_cdb6(cmd, &cdb_info);
2168 nvme_trans_get_io_cdb10(cmd, &cdb_info);
2172 nvme_trans_get_io_cdb12(cmd, &cdb_info);
2176 nvme_trans_get_io_cdb16(cmd, &cdb_info);
2179 /* Will never really reach here */
2180 res = SNTI_INTERNAL_ERROR;
2184 /* Calculate total length of transfer (in bytes) */
2185 if (hdr->iovec_count > 0) {
2186 for (i = 0; i < hdr->iovec_count; i++) {
2187 not_copied = copy_from_user(&sgl, hdr->dxferp +
2188 i * sizeof(struct sg_iovec),
2189 sizeof(struct sg_iovec));
2192 sum_iov_len += sgl.iov_len;
2193 /* IO vector sizes should be multiples of block size */
2194 if (sgl.iov_len % (1 << ns->lba_shift) != 0) {
2195 res = nvme_trans_completion(hdr,
2196 SAM_STAT_CHECK_CONDITION,
2198 SCSI_ASC_INVALID_PARAMETER,
2199 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2204 sum_iov_len = hdr->dxfer_len;
2207 /* As Per sg ioctl howto, if the lengths differ, use the lower one */
2208 xfer_bytes = min(((u64)hdr->dxfer_len), sum_iov_len);
2210 /* If block count and actual data buffer size dont match, error out */
2211 if (xfer_bytes != (cdb_info.xfer_len << ns->lba_shift)) {
2216 /* Check for 0 length transfer - it is not illegal */
2217 if (cdb_info.xfer_len == 0)
2220 /* Send NVMe IO Command(s) */
2221 res = nvme_trans_do_nvme_io(ns, hdr, &cdb_info, is_write);
2222 if (res != SNTI_TRANSLATION_SUCCESS)
2229 static int nvme_trans_inquiry(struct nvme_ns *ns, struct sg_io_hdr *hdr,
2232 int res = SNTI_TRANSLATION_SUCCESS;
2238 evpd = GET_INQ_EVPD_BIT(cmd);
2239 page_code = GET_INQ_PAGE_CODE(cmd);
2240 alloc_len = GET_INQ_ALLOC_LENGTH(cmd);
2242 inq_response = kmalloc(STANDARD_INQUIRY_LENGTH, GFP_KERNEL);
2243 if (inq_response == NULL) {
2249 if (page_code == INQ_STANDARD_INQUIRY_PAGE) {
2250 res = nvme_trans_standard_inquiry_page(ns, hdr,
2251 inq_response, alloc_len);
2253 res = nvme_trans_completion(hdr,
2254 SAM_STAT_CHECK_CONDITION,
2256 SCSI_ASC_INVALID_CDB,
2257 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2260 switch (page_code) {
2261 case VPD_SUPPORTED_PAGES:
2262 res = nvme_trans_supported_vpd_pages(ns, hdr,
2263 inq_response, alloc_len);
2265 case VPD_SERIAL_NUMBER:
2266 res = nvme_trans_unit_serial_page(ns, hdr, inq_response,
2269 case VPD_DEVICE_IDENTIFIERS:
2270 res = nvme_trans_device_id_page(ns, hdr, inq_response,
2273 case VPD_EXTENDED_INQUIRY:
2274 res = nvme_trans_ext_inq_page(ns, hdr, alloc_len);
2276 case VPD_BLOCK_DEV_CHARACTERISTICS:
2277 res = nvme_trans_bdev_char_page(ns, hdr, alloc_len);
2280 res = nvme_trans_completion(hdr,
2281 SAM_STAT_CHECK_CONDITION,
2283 SCSI_ASC_INVALID_CDB,
2284 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2288 kfree(inq_response);
2293 static int nvme_trans_log_sense(struct nvme_ns *ns, struct sg_io_hdr *hdr,
2296 int res = SNTI_TRANSLATION_SUCCESS;
2302 sp = GET_U8_FROM_CDB(cmd, LOG_SENSE_CDB_SP_OFFSET);
2303 if (sp != LOG_SENSE_CDB_SP_NOT_ENABLED) {
2304 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2305 ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
2306 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2309 pc = GET_U8_FROM_CDB(cmd, LOG_SENSE_CDB_PC_OFFSET);
2310 page_code = pc & LOG_SENSE_CDB_PAGE_CODE_MASK;
2311 pc = (pc & LOG_SENSE_CDB_PC_MASK) >> LOG_SENSE_CDB_PC_SHIFT;
2312 if (pc != LOG_SENSE_CDB_PC_CUMULATIVE_VALUES) {
2313 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2314 ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
2315 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2318 alloc_len = GET_U16_FROM_CDB(cmd, LOG_SENSE_CDB_ALLOC_LENGTH_OFFSET);
2319 switch (page_code) {
2320 case LOG_PAGE_SUPPORTED_LOG_PAGES_PAGE:
2321 res = nvme_trans_log_supp_pages(ns, hdr, alloc_len);
2323 case LOG_PAGE_INFORMATIONAL_EXCEPTIONS_PAGE:
2324 res = nvme_trans_log_info_exceptions(ns, hdr, alloc_len);
2326 case LOG_PAGE_TEMPERATURE_PAGE:
2327 res = nvme_trans_log_temperature(ns, hdr, alloc_len);
2330 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2331 ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
2332 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2340 static int nvme_trans_mode_select(struct nvme_ns *ns, struct sg_io_hdr *hdr,
2343 int res = SNTI_TRANSLATION_SUCCESS;
2349 page_format = GET_U8_FROM_CDB(cmd, MODE_SELECT_CDB_PAGE_FORMAT_OFFSET);
2350 page_format &= MODE_SELECT_CDB_PAGE_FORMAT_MASK;
2352 save_pages = GET_U8_FROM_CDB(cmd, MODE_SELECT_CDB_SAVE_PAGES_OFFSET);
2353 save_pages &= MODE_SELECT_CDB_SAVE_PAGES_MASK;
2355 if (GET_OPCODE(cmd) == MODE_SELECT) {
2356 parm_list_len = GET_U8_FROM_CDB(cmd,
2357 MODE_SELECT_6_CDB_PARAM_LIST_LENGTH_OFFSET);
2359 parm_list_len = GET_U16_FROM_CDB(cmd,
2360 MODE_SELECT_10_CDB_PARAM_LIST_LENGTH_OFFSET);
2364 if (parm_list_len != 0) {
2366 * According to SPC-4 r24, a paramter list length field of 0
2367 * shall not be considered an error
2369 res = nvme_trans_modesel_data(ns, hdr, cmd, parm_list_len,
2370 page_format, save_pages, cdb10);
2376 static int nvme_trans_mode_sense(struct nvme_ns *ns, struct sg_io_hdr *hdr,
2379 int res = SNTI_TRANSLATION_SUCCESS;
2385 if (GET_OPCODE(cmd) == MODE_SENSE) {
2386 alloc_len = GET_U8_FROM_CDB(cmd, MODE_SENSE6_ALLOC_LEN_OFFSET);
2388 alloc_len = GET_U16_FROM_CDB(cmd,
2389 MODE_SENSE10_ALLOC_LEN_OFFSET);
2393 pc = GET_U8_FROM_CDB(cmd, MODE_SENSE_PAGE_CONTROL_OFFSET) &
2394 MODE_SENSE_PAGE_CONTROL_MASK;
2395 if (pc != MODE_SENSE_PC_CURRENT_VALUES) {
2396 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2397 ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
2398 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2402 page_code = GET_U8_FROM_CDB(cmd, MODE_SENSE_PAGE_CODE_OFFSET) &
2403 MODE_SENSE_PAGE_CODE_MASK;
2404 switch (page_code) {
2405 case MODE_PAGE_CACHING:
2406 res = nvme_trans_mode_page_create(ns, hdr, cmd, alloc_len,
2408 &nvme_trans_fill_caching_page,
2409 MODE_PAGE_CACHING_LEN);
2411 case MODE_PAGE_CONTROL:
2412 res = nvme_trans_mode_page_create(ns, hdr, cmd, alloc_len,
2414 &nvme_trans_fill_control_page,
2415 MODE_PAGE_CONTROL_LEN);
2417 case MODE_PAGE_POWER_CONDITION:
2418 res = nvme_trans_mode_page_create(ns, hdr, cmd, alloc_len,
2420 &nvme_trans_fill_pow_cnd_page,
2421 MODE_PAGE_POW_CND_LEN);
2423 case MODE_PAGE_INFO_EXCEP:
2424 res = nvme_trans_mode_page_create(ns, hdr, cmd, alloc_len,
2426 &nvme_trans_fill_inf_exc_page,
2427 MODE_PAGE_INF_EXC_LEN);
2429 case MODE_PAGE_RETURN_ALL:
2430 res = nvme_trans_mode_page_create(ns, hdr, cmd, alloc_len,
2432 &nvme_trans_fill_all_pages,
2436 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2437 ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
2438 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2446 static int nvme_trans_read_capacity(struct nvme_ns *ns, struct sg_io_hdr *hdr,
2449 int res = SNTI_TRANSLATION_SUCCESS;
2451 u32 alloc_len = READ_CAP_10_RESP_SIZE;
2452 u32 resp_size = READ_CAP_10_RESP_SIZE;
2455 struct nvme_dev *dev = ns->dev;
2456 dma_addr_t dma_addr;
2458 struct nvme_id_ns *id_ns;
2461 cdb16 = IS_READ_CAP_16(cmd);
2463 alloc_len = GET_READ_CAP_16_ALLOC_LENGTH(cmd);
2464 resp_size = READ_CAP_16_RESP_SIZE;
2467 mem = dma_alloc_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ns),
2468 &dma_addr, GFP_KERNEL);
2473 /* nvme ns identify */
2474 nvme_sc = nvme_identify(dev, ns->ns_id, 0, dma_addr);
2475 res = nvme_trans_status_code(hdr, nvme_sc);
2484 response = kmalloc(resp_size, GFP_KERNEL);
2485 if (response == NULL) {
2489 memset(response, 0, resp_size);
2490 nvme_trans_fill_read_cap(response, id_ns, cdb16);
2492 xfer_len = min(alloc_len, resp_size);
2493 res = nvme_trans_copy_to_user(hdr, response, xfer_len);
2497 dma_free_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ns), mem,
2503 static int nvme_trans_report_luns(struct nvme_ns *ns, struct sg_io_hdr *hdr,
2506 int res = SNTI_TRANSLATION_SUCCESS;
2508 u32 alloc_len, xfer_len, resp_size;
2511 struct nvme_dev *dev = ns->dev;
2512 dma_addr_t dma_addr;
2514 struct nvme_id_ctrl *id_ctrl;
2515 u32 ll_length, lun_id;
2516 u8 lun_id_offset = REPORT_LUNS_FIRST_LUN_OFFSET;
2519 alloc_len = GET_REPORT_LUNS_ALLOC_LENGTH(cmd);
2520 select_report = GET_U8_FROM_CDB(cmd, REPORT_LUNS_SR_OFFSET);
2522 if ((select_report != ALL_LUNS_RETURNED) &&
2523 (select_report != ALL_WELL_KNOWN_LUNS_RETURNED) &&
2524 (select_report != RESTRICTED_LUNS_RETURNED)) {
2525 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2526 ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
2527 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2530 /* NVMe Controller Identify */
2531 mem = dma_alloc_coherent(&dev->pci_dev->dev,
2532 sizeof(struct nvme_id_ctrl),
2533 &dma_addr, GFP_KERNEL);
2538 nvme_sc = nvme_identify(dev, 0, 1, dma_addr);
2539 res = nvme_trans_status_code(hdr, nvme_sc);
2547 ll_length = le32_to_cpu(id_ctrl->nn) * LUN_ENTRY_SIZE;
2548 resp_size = ll_length + LUN_DATA_HEADER_SIZE;
2550 if (alloc_len < resp_size) {
2551 res = nvme_trans_completion(hdr,
2552 SAM_STAT_CHECK_CONDITION,
2553 ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
2554 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2558 response = kmalloc(resp_size, GFP_KERNEL);
2559 if (response == NULL) {
2563 memset(response, 0, resp_size);
2565 /* The first LUN ID will always be 0 per the SAM spec */
2566 for (lun_id = 0; lun_id < le32_to_cpu(id_ctrl->nn); lun_id++) {
2568 * Set the LUN Id and then increment to the next LUN
2569 * location in the parameter data.
2571 __be64 tmp_id = cpu_to_be64(lun_id);
2572 memcpy(&response[lun_id_offset], &tmp_id, sizeof(u64));
2573 lun_id_offset += LUN_ENTRY_SIZE;
2575 tmp_len = cpu_to_be32(ll_length);
2576 memcpy(response, &tmp_len, sizeof(u32));
2579 xfer_len = min(alloc_len, resp_size);
2580 res = nvme_trans_copy_to_user(hdr, response, xfer_len);
2584 dma_free_coherent(&dev->pci_dev->dev, sizeof(struct nvme_id_ctrl), mem,
2590 static int nvme_trans_request_sense(struct nvme_ns *ns, struct sg_io_hdr *hdr,
2593 int res = SNTI_TRANSLATION_SUCCESS;
2594 u8 alloc_len, xfer_len, resp_size;
2598 alloc_len = GET_REQUEST_SENSE_ALLOC_LENGTH(cmd);
2599 desc_format = GET_U8_FROM_CDB(cmd, REQUEST_SENSE_DESC_OFFSET);
2600 desc_format &= REQUEST_SENSE_DESC_MASK;
2602 resp_size = ((desc_format) ? (DESC_FMT_SENSE_DATA_SIZE) :
2603 (FIXED_FMT_SENSE_DATA_SIZE));
2604 response = kmalloc(resp_size, GFP_KERNEL);
2605 if (response == NULL) {
2609 memset(response, 0, resp_size);
2611 if (desc_format == DESCRIPTOR_FORMAT_SENSE_DATA_TYPE) {
2612 /* Descriptor Format Sense Data */
2613 response[0] = DESC_FORMAT_SENSE_DATA;
2614 response[1] = NO_SENSE;
2615 /* TODO How is LOW POWER CONDITION ON handled? (byte 2) */
2616 response[2] = SCSI_ASC_NO_SENSE;
2617 response[3] = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
2618 /* SDAT_OVFL = 0 | Additional Sense Length = 0 */
2620 /* Fixed Format Sense Data */
2621 response[0] = FIXED_SENSE_DATA;
2622 /* Byte 1 = Obsolete */
2623 response[2] = NO_SENSE; /* FM, EOM, ILI, SDAT_OVFL = 0 */
2624 /* Bytes 3-6 - Information - set to zero */
2625 response[7] = FIXED_SENSE_DATA_ADD_LENGTH;
2626 /* Bytes 8-11 - Cmd Specific Information - set to zero */
2627 response[12] = SCSI_ASC_NO_SENSE;
2628 response[13] = SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
2629 /* Byte 14 = Field Replaceable Unit Code = 0 */
2630 /* Bytes 15-17 - SKSV=0; Sense Key Specific = 0 */
2633 xfer_len = min(alloc_len, resp_size);
2634 res = nvme_trans_copy_to_user(hdr, response, xfer_len);
2641 static int nvme_trans_security_protocol(struct nvme_ns *ns,
2642 struct sg_io_hdr *hdr,
2645 return nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2646 ILLEGAL_REQUEST, SCSI_ASC_ILLEGAL_COMMAND,
2647 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2650 static int nvme_trans_start_stop(struct nvme_ns *ns, struct sg_io_hdr *hdr,
2653 int res = SNTI_TRANSLATION_SUCCESS;
2655 struct nvme_queue *nvmeq;
2656 struct nvme_command c;
2657 u8 immed, pcmod, pc, no_flush, start;
2659 immed = GET_U8_FROM_CDB(cmd, START_STOP_UNIT_CDB_IMMED_OFFSET);
2660 pcmod = GET_U8_FROM_CDB(cmd, START_STOP_UNIT_CDB_POWER_COND_MOD_OFFSET);
2661 pc = GET_U8_FROM_CDB(cmd, START_STOP_UNIT_CDB_POWER_COND_OFFSET);
2662 no_flush = GET_U8_FROM_CDB(cmd, START_STOP_UNIT_CDB_NO_FLUSH_OFFSET);
2663 start = GET_U8_FROM_CDB(cmd, START_STOP_UNIT_CDB_START_OFFSET);
2665 immed &= START_STOP_UNIT_CDB_IMMED_MASK;
2666 pcmod &= START_STOP_UNIT_CDB_POWER_COND_MOD_MASK;
2667 pc = (pc & START_STOP_UNIT_CDB_POWER_COND_MASK) >> NIBBLE_SHIFT;
2668 no_flush &= START_STOP_UNIT_CDB_NO_FLUSH_MASK;
2669 start &= START_STOP_UNIT_CDB_START_MASK;
2672 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2673 ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
2674 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2676 if (no_flush == 0) {
2677 /* Issue NVME FLUSH command prior to START STOP UNIT */
2678 memset(&c, 0, sizeof(c));
2679 c.common.opcode = nvme_cmd_flush;
2680 c.common.nsid = cpu_to_le32(ns->ns_id);
2682 nvmeq = get_nvmeq(ns->dev);
2684 nvme_sc = nvme_submit_sync_cmd(nvmeq, &c, NULL, NVME_IO_TIMEOUT);
2686 res = nvme_trans_status_code(hdr, nvme_sc);
2694 /* Setup the expected power state transition */
2695 res = nvme_trans_power_state(ns, hdr, pc, pcmod, start);
2702 static int nvme_trans_synchronize_cache(struct nvme_ns *ns,
2703 struct sg_io_hdr *hdr, u8 *cmd)
2705 int res = SNTI_TRANSLATION_SUCCESS;
2707 struct nvme_command c;
2708 struct nvme_queue *nvmeq;
2710 memset(&c, 0, sizeof(c));
2711 c.common.opcode = nvme_cmd_flush;
2712 c.common.nsid = cpu_to_le32(ns->ns_id);
2714 nvmeq = get_nvmeq(ns->dev);
2716 nvme_sc = nvme_submit_sync_cmd(nvmeq, &c, NULL, NVME_IO_TIMEOUT);
2718 res = nvme_trans_status_code(hdr, nvme_sc);
2728 static int nvme_trans_format_unit(struct nvme_ns *ns, struct sg_io_hdr *hdr,
2731 int res = SNTI_TRANSLATION_SUCCESS;
2732 u8 parm_hdr_len = 0;
2733 u8 nvme_pf_code = 0;
2734 u8 format_prot_info, long_list, format_data;
2736 format_prot_info = GET_U8_FROM_CDB(cmd,
2737 FORMAT_UNIT_CDB_FORMAT_PROT_INFO_OFFSET);
2738 long_list = GET_U8_FROM_CDB(cmd, FORMAT_UNIT_CDB_LONG_LIST_OFFSET);
2739 format_data = GET_U8_FROM_CDB(cmd, FORMAT_UNIT_CDB_FORMAT_DATA_OFFSET);
2741 format_prot_info = (format_prot_info &
2742 FORMAT_UNIT_CDB_FORMAT_PROT_INFO_MASK) >>
2743 FORMAT_UNIT_CDB_FORMAT_PROT_INFO_SHIFT;
2744 long_list &= FORMAT_UNIT_CDB_LONG_LIST_MASK;
2745 format_data &= FORMAT_UNIT_CDB_FORMAT_DATA_MASK;
2747 if (format_data != 0) {
2748 if (format_prot_info != 0) {
2750 parm_hdr_len = FORMAT_UNIT_SHORT_PARM_LIST_LEN;
2752 parm_hdr_len = FORMAT_UNIT_LONG_PARM_LIST_LEN;
2754 } else if (format_data == 0 && format_prot_info != 0) {
2755 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2756 ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
2757 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2761 /* Get parm header from data-in/out buffer */
2763 * According to the translation spec, the only fields in the parameter
2764 * list we are concerned with are in the header. So allocate only that.
2766 if (parm_hdr_len > 0) {
2767 res = nvme_trans_fmt_get_parm_header(hdr, parm_hdr_len,
2768 format_prot_info, &nvme_pf_code);
2769 if (res != SNTI_TRANSLATION_SUCCESS)
2773 /* Attempt to activate any previously downloaded firmware image */
2774 res = nvme_trans_send_fw_cmd(ns, hdr, nvme_admin_activate_fw, 0, 0, 0);
2776 /* Determine Block size and count and send format command */
2777 res = nvme_trans_fmt_set_blk_size_count(ns, hdr);
2778 if (res != SNTI_TRANSLATION_SUCCESS)
2781 res = nvme_trans_fmt_send_cmd(ns, hdr, nvme_pf_code);
2787 static int nvme_trans_test_unit_ready(struct nvme_ns *ns,
2788 struct sg_io_hdr *hdr,
2791 int res = SNTI_TRANSLATION_SUCCESS;
2792 struct nvme_dev *dev = ns->dev;
2794 if (!(readl(&dev->bar->csts) & NVME_CSTS_RDY))
2795 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2796 NOT_READY, SCSI_ASC_LUN_NOT_READY,
2797 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2799 res = nvme_trans_completion(hdr, SAM_STAT_GOOD, NO_SENSE, 0, 0);
2804 static int nvme_trans_write_buffer(struct nvme_ns *ns, struct sg_io_hdr *hdr,
2807 int res = SNTI_TRANSLATION_SUCCESS;
2808 u32 buffer_offset, parm_list_length;
2812 GET_U24_FROM_CDB(cmd, WRITE_BUFFER_CDB_PARM_LIST_LENGTH_OFFSET);
2813 if (parm_list_length % BYTES_TO_DWORDS != 0) {
2814 /* NVMe expects Firmware file to be a whole number of DWORDS */
2815 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2816 ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
2817 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2820 buffer_id = GET_U8_FROM_CDB(cmd, WRITE_BUFFER_CDB_BUFFER_ID_OFFSET);
2821 if (buffer_id > NVME_MAX_FIRMWARE_SLOT) {
2822 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2823 ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
2824 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2827 mode = GET_U8_FROM_CDB(cmd, WRITE_BUFFER_CDB_MODE_OFFSET) &
2828 WRITE_BUFFER_CDB_MODE_MASK;
2830 GET_U24_FROM_CDB(cmd, WRITE_BUFFER_CDB_BUFFER_OFFSET_OFFSET);
2833 case DOWNLOAD_SAVE_ACTIVATE:
2834 res = nvme_trans_send_fw_cmd(ns, hdr, nvme_admin_download_fw,
2835 parm_list_length, buffer_offset,
2837 if (res != SNTI_TRANSLATION_SUCCESS)
2839 res = nvme_trans_send_fw_cmd(ns, hdr, nvme_admin_activate_fw,
2840 parm_list_length, buffer_offset,
2843 case DOWNLOAD_SAVE_DEFER_ACTIVATE:
2844 res = nvme_trans_send_fw_cmd(ns, hdr, nvme_admin_download_fw,
2845 parm_list_length, buffer_offset,
2848 case ACTIVATE_DEFERRED_MICROCODE:
2849 res = nvme_trans_send_fw_cmd(ns, hdr, nvme_admin_activate_fw,
2850 parm_list_length, buffer_offset,
2854 res = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
2855 ILLEGAL_REQUEST, SCSI_ASC_INVALID_CDB,
2856 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
2864 struct scsi_unmap_blk_desc {
2870 struct scsi_unmap_parm_list {
2871 __be16 unmap_data_len;
2872 __be16 unmap_blk_desc_data_len;
2874 struct scsi_unmap_blk_desc desc[0];
2877 static int nvme_trans_unmap(struct nvme_ns *ns, struct sg_io_hdr *hdr,
2880 struct nvme_dev *dev = ns->dev;
2881 struct scsi_unmap_parm_list *plist;
2882 struct nvme_dsm_range *range;
2883 struct nvme_queue *nvmeq;
2884 struct nvme_command c;
2885 int i, nvme_sc, res = -ENOMEM;
2886 u16 ndesc, list_len;
2887 dma_addr_t dma_addr;
2889 list_len = GET_U16_FROM_CDB(cmd, UNMAP_CDB_PARAM_LIST_LENGTH_OFFSET);
2893 plist = kmalloc(list_len, GFP_KERNEL);
2897 res = nvme_trans_copy_from_user(hdr, plist, list_len);
2898 if (res != SNTI_TRANSLATION_SUCCESS)
2901 ndesc = be16_to_cpu(plist->unmap_blk_desc_data_len) >> 4;
2902 if (!ndesc || ndesc > 256) {
2907 range = dma_alloc_coherent(&dev->pci_dev->dev, ndesc * sizeof(*range),
2908 &dma_addr, GFP_KERNEL);
2912 for (i = 0; i < ndesc; i++) {
2913 range[i].nlb = cpu_to_le32(be32_to_cpu(plist->desc[i].nlb));
2914 range[i].slba = cpu_to_le64(be64_to_cpu(plist->desc[i].slba));
2918 memset(&c, 0, sizeof(c));
2919 c.dsm.opcode = nvme_cmd_dsm;
2920 c.dsm.nsid = cpu_to_le32(ns->ns_id);
2921 c.dsm.prp1 = cpu_to_le64(dma_addr);
2922 c.dsm.nr = cpu_to_le32(ndesc - 1);
2923 c.dsm.attributes = cpu_to_le32(NVME_DSMGMT_AD);
2925 nvmeq = get_nvmeq(dev);
2928 nvme_sc = nvme_submit_sync_cmd(nvmeq, &c, NULL, NVME_IO_TIMEOUT);
2929 res = nvme_trans_status_code(hdr, nvme_sc);
2931 dma_free_coherent(&dev->pci_dev->dev, ndesc * sizeof(*range),
2938 static int nvme_scsi_translate(struct nvme_ns *ns, struct sg_io_hdr *hdr)
2940 u8 cmd[BLK_MAX_CDB];
2942 unsigned int opcode;
2944 if (hdr->cmdp == NULL)
2946 if (copy_from_user(cmd, hdr->cmdp, hdr->cmd_len))
2956 retcode = nvme_trans_io(ns, hdr, 0, cmd);
2962 retcode = nvme_trans_io(ns, hdr, 1, cmd);
2965 retcode = nvme_trans_inquiry(ns, hdr, cmd);
2968 retcode = nvme_trans_log_sense(ns, hdr, cmd);
2971 case MODE_SELECT_10:
2972 retcode = nvme_trans_mode_select(ns, hdr, cmd);
2976 retcode = nvme_trans_mode_sense(ns, hdr, cmd);
2979 retcode = nvme_trans_read_capacity(ns, hdr, cmd);
2981 case SERVICE_ACTION_IN:
2982 if (IS_READ_CAP_16(cmd))
2983 retcode = nvme_trans_read_capacity(ns, hdr, cmd);
2988 retcode = nvme_trans_report_luns(ns, hdr, cmd);
2991 retcode = nvme_trans_request_sense(ns, hdr, cmd);
2993 case SECURITY_PROTOCOL_IN:
2994 case SECURITY_PROTOCOL_OUT:
2995 retcode = nvme_trans_security_protocol(ns, hdr, cmd);
2998 retcode = nvme_trans_start_stop(ns, hdr, cmd);
3000 case SYNCHRONIZE_CACHE:
3001 retcode = nvme_trans_synchronize_cache(ns, hdr, cmd);
3004 retcode = nvme_trans_format_unit(ns, hdr, cmd);
3006 case TEST_UNIT_READY:
3007 retcode = nvme_trans_test_unit_ready(ns, hdr, cmd);
3010 retcode = nvme_trans_write_buffer(ns, hdr, cmd);
3013 retcode = nvme_trans_unmap(ns, hdr, cmd);
3017 retcode = nvme_trans_completion(hdr, SAM_STAT_CHECK_CONDITION,
3018 ILLEGAL_REQUEST, SCSI_ASC_ILLEGAL_COMMAND,
3019 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
3025 int nvme_sg_io(struct nvme_ns *ns, struct sg_io_hdr __user *u_hdr)
3027 struct sg_io_hdr hdr;
3030 if (!capable(CAP_SYS_ADMIN))
3032 if (copy_from_user(&hdr, u_hdr, sizeof(hdr)))
3034 if (hdr.interface_id != 'S')
3036 if (hdr.cmd_len > BLK_MAX_CDB)
3039 retcode = nvme_scsi_translate(ns, &hdr);
3043 retcode = SNTI_TRANSLATION_SUCCESS;
3044 if (copy_to_user(u_hdr, &hdr, sizeof(sg_io_hdr_t)) > 0)
3050 int nvme_sg_get_version_num(int __user *ip)
3052 return put_user(sg_version_num, ip);