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/compat.h>
29 #include <linux/delay.h>
30 #include <linux/errno.h>
32 #include <linux/genhd.h>
33 #include <linux/idr.h>
34 #include <linux/init.h>
35 #include <linux/interrupt.h>
37 #include <linux/kdev_t.h>
38 #include <linux/kthread.h>
39 #include <linux/kernel.h>
41 #include <linux/module.h>
42 #include <linux/moduleparam.h>
43 #include <linux/pci.h>
44 #include <linux/poison.h>
45 #include <linux/sched.h>
46 #include <linux/slab.h>
47 #include <linux/types.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
= kzalloc(EXTENDED_INQUIRY_DATA_PAGE_LENGTH
, GFP_KERNEL
);
938 if (inq_response
== NULL
) {
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
= kzalloc(LOG_PAGE_SUPPORTED_LOG_PAGES_LENGTH
, GFP_KERNEL
);
968 if (log_response
== NULL
) {
973 log_response
[0] = LOG_PAGE_SUPPORTED_LOG_PAGES_PAGE
;
974 /* Subpage=0x00, Page Length MSB=0 */
975 log_response
[3] = SUPPORTED_LOG_PAGES_PAGE_LENGTH
;
976 log_response
[4] = LOG_PAGE_SUPPORTED_LOG_PAGES_PAGE
;
977 log_response
[5] = LOG_PAGE_INFORMATIONAL_EXCEPTIONS_PAGE
;
978 log_response
[6] = LOG_PAGE_TEMPERATURE_PAGE
;
980 xfer_len
= min(alloc_len
, LOG_PAGE_SUPPORTED_LOG_PAGES_LENGTH
);
981 res
= nvme_trans_copy_to_user(hdr
, log_response
, xfer_len
);
988 static int nvme_trans_log_info_exceptions(struct nvme_ns
*ns
,
989 struct sg_io_hdr
*hdr
, int alloc_len
)
991 int res
= SNTI_TRANSLATION_SUCCESS
;
994 struct nvme_command c
;
995 struct nvme_dev
*dev
= ns
->dev
;
996 struct nvme_smart_log
*smart_log
;
1002 log_response
= kzalloc(LOG_INFO_EXCP_PAGE_LENGTH
, GFP_KERNEL
);
1003 if (log_response
== NULL
) {
1008 mem
= dma_alloc_coherent(&dev
->pci_dev
->dev
,
1009 sizeof(struct nvme_smart_log
),
1010 &dma_addr
, GFP_KERNEL
);
1016 /* Get SMART Log Page */
1017 memset(&c
, 0, sizeof(c
));
1018 c
.common
.opcode
= nvme_admin_get_log_page
;
1019 c
.common
.nsid
= cpu_to_le32(0xFFFFFFFF);
1020 c
.common
.prp1
= cpu_to_le64(dma_addr
);
1021 c
.common
.cdw10
[0] = cpu_to_le32(((sizeof(struct nvme_smart_log
) /
1022 BYTES_TO_DWORDS
) << 16) | NVME_GET_SMART_LOG_PAGE
);
1023 res
= nvme_submit_admin_cmd(dev
, &c
, NULL
);
1024 if (res
!= NVME_SC_SUCCESS
) {
1025 temp_c
= LOG_TEMP_UNKNOWN
;
1028 temp_k
= (smart_log
->temperature
[1] << 8) +
1029 (smart_log
->temperature
[0]);
1030 temp_c
= temp_k
- KELVIN_TEMP_FACTOR
;
1033 log_response
[0] = LOG_PAGE_INFORMATIONAL_EXCEPTIONS_PAGE
;
1034 /* Subpage=0x00, Page Length MSB=0 */
1035 log_response
[3] = REMAINING_INFO_EXCP_PAGE_LENGTH
;
1036 /* Informational Exceptions Log Parameter 1 Start */
1037 /* Parameter Code=0x0000 bytes 4,5 */
1038 log_response
[6] = 0x23; /* DU=0, TSD=1, ETC=0, TMC=0, FMT_AND_LNK=11b */
1039 log_response
[7] = 0x04; /* PARAMETER LENGTH */
1040 /* Add sense Code and qualifier = 0x00 each */
1041 /* Use Temperature from NVMe Get Log Page, convert to C from K */
1042 log_response
[10] = temp_c
;
1044 xfer_len
= min(alloc_len
, LOG_INFO_EXCP_PAGE_LENGTH
);
1045 res
= nvme_trans_copy_to_user(hdr
, log_response
, xfer_len
);
1047 dma_free_coherent(&dev
->pci_dev
->dev
, sizeof(struct nvme_smart_log
),
1050 kfree(log_response
);
1055 static int nvme_trans_log_temperature(struct nvme_ns
*ns
, struct sg_io_hdr
*hdr
,
1058 int res
= SNTI_TRANSLATION_SUCCESS
;
1061 struct nvme_command c
;
1062 struct nvme_dev
*dev
= ns
->dev
;
1063 struct nvme_smart_log
*smart_log
;
1064 dma_addr_t dma_addr
;
1067 u8 temp_c_cur
, temp_c_thresh
;
1070 log_response
= kzalloc(LOG_TEMP_PAGE_LENGTH
, GFP_KERNEL
);
1071 if (log_response
== NULL
) {
1076 mem
= dma_alloc_coherent(&dev
->pci_dev
->dev
,
1077 sizeof(struct nvme_smart_log
),
1078 &dma_addr
, GFP_KERNEL
);
1084 /* Get SMART Log Page */
1085 memset(&c
, 0, sizeof(c
));
1086 c
.common
.opcode
= nvme_admin_get_log_page
;
1087 c
.common
.nsid
= cpu_to_le32(0xFFFFFFFF);
1088 c
.common
.prp1
= cpu_to_le64(dma_addr
);
1089 c
.common
.cdw10
[0] = cpu_to_le32(((sizeof(struct nvme_smart_log
) /
1090 BYTES_TO_DWORDS
) << 16) | NVME_GET_SMART_LOG_PAGE
);
1091 res
= nvme_submit_admin_cmd(dev
, &c
, NULL
);
1092 if (res
!= NVME_SC_SUCCESS
) {
1093 temp_c_cur
= LOG_TEMP_UNKNOWN
;
1096 temp_k
= (smart_log
->temperature
[1] << 8) +
1097 (smart_log
->temperature
[0]);
1098 temp_c_cur
= temp_k
- KELVIN_TEMP_FACTOR
;
1101 /* Get Features for Temp Threshold */
1102 res
= nvme_get_features(dev
, NVME_FEAT_TEMP_THRESH
, 0, 0,
1104 if (res
!= NVME_SC_SUCCESS
)
1105 temp_c_thresh
= LOG_TEMP_UNKNOWN
;
1107 temp_c_thresh
= (feature_resp
& 0xFFFF) - KELVIN_TEMP_FACTOR
;
1109 log_response
[0] = LOG_PAGE_TEMPERATURE_PAGE
;
1110 /* Subpage=0x00, Page Length MSB=0 */
1111 log_response
[3] = REMAINING_TEMP_PAGE_LENGTH
;
1112 /* Temperature Log Parameter 1 (Temperature) Start */
1113 /* Parameter Code = 0x0000 */
1114 log_response
[6] = 0x01; /* Format and Linking = 01b */
1115 log_response
[7] = 0x02; /* Parameter Length */
1116 /* Use Temperature from NVMe Get Log Page, convert to C from K */
1117 log_response
[9] = temp_c_cur
;
1118 /* Temperature Log Parameter 2 (Reference Temperature) Start */
1119 log_response
[11] = 0x01; /* Parameter Code = 0x0001 */
1120 log_response
[12] = 0x01; /* Format and Linking = 01b */
1121 log_response
[13] = 0x02; /* Parameter Length */
1122 /* Use Temperature Thresh from NVMe Get Log Page, convert to C from K */
1123 log_response
[15] = temp_c_thresh
;
1125 xfer_len
= min(alloc_len
, LOG_TEMP_PAGE_LENGTH
);
1126 res
= nvme_trans_copy_to_user(hdr
, log_response
, xfer_len
);
1128 dma_free_coherent(&dev
->pci_dev
->dev
, sizeof(struct nvme_smart_log
),
1131 kfree(log_response
);
1136 /* MODE SENSE Helper Functions */
1138 static int nvme_trans_fill_mode_parm_hdr(u8
*resp
, int len
, u8 cdb10
, u8 llbaa
,
1139 u16 mode_data_length
, u16 blk_desc_len
)
1141 /* Quick check to make sure I don't stomp on my own memory... */
1142 if ((cdb10
&& len
< 8) || (!cdb10
&& len
< 4))
1143 return SNTI_INTERNAL_ERROR
;
1146 resp
[0] = (mode_data_length
& 0xFF00) >> 8;
1147 resp
[1] = (mode_data_length
& 0x00FF);
1148 /* resp[2] and [3] are zero */
1150 resp
[5] = RESERVED_FIELD
;
1151 resp
[6] = (blk_desc_len
& 0xFF00) >> 8;
1152 resp
[7] = (blk_desc_len
& 0x00FF);
1154 resp
[0] = (mode_data_length
& 0x00FF);
1155 /* resp[1] and [2] are zero */
1156 resp
[3] = (blk_desc_len
& 0x00FF);
1159 return SNTI_TRANSLATION_SUCCESS
;
1162 static int nvme_trans_fill_blk_desc(struct nvme_ns
*ns
, struct sg_io_hdr
*hdr
,
1163 u8
*resp
, int len
, u8 llbaa
)
1165 int res
= SNTI_TRANSLATION_SUCCESS
;
1167 struct nvme_dev
*dev
= ns
->dev
;
1168 dma_addr_t dma_addr
;
1170 struct nvme_id_ns
*id_ns
;
1174 if (llbaa
== 0 && len
< MODE_PAGE_BLK_DES_LEN
)
1175 return SNTI_INTERNAL_ERROR
;
1176 else if (llbaa
> 0 && len
< MODE_PAGE_LLBAA_BLK_DES_LEN
)
1177 return SNTI_INTERNAL_ERROR
;
1179 mem
= dma_alloc_coherent(&dev
->pci_dev
->dev
, sizeof(struct nvme_id_ns
),
1180 &dma_addr
, GFP_KERNEL
);
1186 /* nvme ns identify */
1187 nvme_sc
= nvme_identify(dev
, ns
->ns_id
, 0, dma_addr
);
1188 res
= nvme_trans_status_code(hdr
, nvme_sc
);
1196 flbas
= (id_ns
->flbas
) & 0x0F;
1197 lba_length
= (1 << (id_ns
->lbaf
[flbas
].ds
));
1200 __be32 tmp_cap
= cpu_to_be32(le64_to_cpu(id_ns
->ncap
));
1201 /* Byte 4 is reserved */
1202 __be32 tmp_len
= cpu_to_be32(lba_length
& 0x00FFFFFF);
1204 memcpy(resp
, &tmp_cap
, sizeof(u32
));
1205 memcpy(&resp
[4], &tmp_len
, sizeof(u32
));
1207 __be64 tmp_cap
= cpu_to_be64(le64_to_cpu(id_ns
->ncap
));
1208 __be32 tmp_len
= cpu_to_be32(lba_length
);
1210 memcpy(resp
, &tmp_cap
, sizeof(u64
));
1211 /* Bytes 8, 9, 10, 11 are reserved */
1212 memcpy(&resp
[12], &tmp_len
, sizeof(u32
));
1216 dma_free_coherent(&dev
->pci_dev
->dev
, sizeof(struct nvme_id_ns
), mem
,
1222 static int nvme_trans_fill_control_page(struct nvme_ns
*ns
,
1223 struct sg_io_hdr
*hdr
, u8
*resp
,
1226 if (len
< MODE_PAGE_CONTROL_LEN
)
1227 return SNTI_INTERNAL_ERROR
;
1229 resp
[0] = MODE_PAGE_CONTROL
;
1230 resp
[1] = MODE_PAGE_CONTROL_LEN_FIELD
;
1231 resp
[2] = 0x0E; /* TST=000b, TMF_ONLY=0, DPICZ=1,
1232 * D_SENSE=1, GLTSD=1, RLEC=0 */
1233 resp
[3] = 0x12; /* Q_ALGO_MODIFIER=1h, NUAR=0, QERR=01b */
1234 /* Byte 4: VS=0, RAC=0, UA_INT=0, SWP=0 */
1235 resp
[5] = 0x40; /* ATO=0, TAS=1, ATMPE=0, RWWP=0, AUTOLOAD=0 */
1236 /* resp[6] and [7] are obsolete, thus zero */
1237 resp
[8] = 0xFF; /* Busy timeout period = 0xffff */
1239 /* Bytes 10,11: Extended selftest completion time = 0x0000 */
1241 return SNTI_TRANSLATION_SUCCESS
;
1244 static int nvme_trans_fill_caching_page(struct nvme_ns
*ns
,
1245 struct sg_io_hdr
*hdr
,
1248 int res
= SNTI_TRANSLATION_SUCCESS
;
1250 struct nvme_dev
*dev
= ns
->dev
;
1254 if (len
< MODE_PAGE_CACHING_LEN
)
1255 return SNTI_INTERNAL_ERROR
;
1257 nvme_sc
= nvme_get_features(dev
, NVME_FEAT_VOLATILE_WC
, 0, 0,
1259 res
= nvme_trans_status_code(hdr
, nvme_sc
);
1266 vwc
= feature_resp
& 0x00000001;
1268 resp
[0] = MODE_PAGE_CACHING
;
1269 resp
[1] = MODE_PAGE_CACHING_LEN_FIELD
;
1276 static int nvme_trans_fill_pow_cnd_page(struct nvme_ns
*ns
,
1277 struct sg_io_hdr
*hdr
, u8
*resp
,
1280 int res
= SNTI_TRANSLATION_SUCCESS
;
1282 if (len
< MODE_PAGE_POW_CND_LEN
)
1283 return SNTI_INTERNAL_ERROR
;
1285 resp
[0] = MODE_PAGE_POWER_CONDITION
;
1286 resp
[1] = MODE_PAGE_POW_CND_LEN_FIELD
;
1287 /* All other bytes are zero */
1292 static int nvme_trans_fill_inf_exc_page(struct nvme_ns
*ns
,
1293 struct sg_io_hdr
*hdr
, u8
*resp
,
1296 int res
= SNTI_TRANSLATION_SUCCESS
;
1298 if (len
< MODE_PAGE_INF_EXC_LEN
)
1299 return SNTI_INTERNAL_ERROR
;
1301 resp
[0] = MODE_PAGE_INFO_EXCEP
;
1302 resp
[1] = MODE_PAGE_INF_EXC_LEN_FIELD
;
1304 /* All other bytes are zero */
1309 static int nvme_trans_fill_all_pages(struct nvme_ns
*ns
, struct sg_io_hdr
*hdr
,
1312 int res
= SNTI_TRANSLATION_SUCCESS
;
1313 u16 mode_pages_offset_1
= 0;
1314 u16 mode_pages_offset_2
, mode_pages_offset_3
, mode_pages_offset_4
;
1316 mode_pages_offset_2
= mode_pages_offset_1
+ MODE_PAGE_CACHING_LEN
;
1317 mode_pages_offset_3
= mode_pages_offset_2
+ MODE_PAGE_CONTROL_LEN
;
1318 mode_pages_offset_4
= mode_pages_offset_3
+ MODE_PAGE_POW_CND_LEN
;
1320 res
= nvme_trans_fill_caching_page(ns
, hdr
, &resp
[mode_pages_offset_1
],
1321 MODE_PAGE_CACHING_LEN
);
1322 if (res
!= SNTI_TRANSLATION_SUCCESS
)
1324 res
= nvme_trans_fill_control_page(ns
, hdr
, &resp
[mode_pages_offset_2
],
1325 MODE_PAGE_CONTROL_LEN
);
1326 if (res
!= SNTI_TRANSLATION_SUCCESS
)
1328 res
= nvme_trans_fill_pow_cnd_page(ns
, hdr
, &resp
[mode_pages_offset_3
],
1329 MODE_PAGE_POW_CND_LEN
);
1330 if (res
!= SNTI_TRANSLATION_SUCCESS
)
1332 res
= nvme_trans_fill_inf_exc_page(ns
, hdr
, &resp
[mode_pages_offset_4
],
1333 MODE_PAGE_INF_EXC_LEN
);
1334 if (res
!= SNTI_TRANSLATION_SUCCESS
)
1341 static inline int nvme_trans_get_blk_desc_len(u8 dbd
, u8 llbaa
)
1343 if (dbd
== MODE_SENSE_BLK_DESC_ENABLED
) {
1344 /* SPC-4: len = 8 x Num_of_descriptors if llbaa = 0, 16x if 1 */
1345 return 8 * (llbaa
+ 1) * MODE_SENSE_BLK_DESC_COUNT
;
1351 static int nvme_trans_mode_page_create(struct nvme_ns
*ns
,
1352 struct sg_io_hdr
*hdr
, u8
*cmd
,
1353 u16 alloc_len
, u8 cdb10
,
1354 int (*mode_page_fill_func
)
1356 struct sg_io_hdr
*hdr
, u8
*, int),
1357 u16 mode_pages_tot_len
)
1359 int res
= SNTI_TRANSLATION_SUCCESS
;
1365 u16 mode_pages_offset_1
;
1366 u16 blk_desc_len
, blk_desc_offset
, mode_data_length
;
1368 dbd
= GET_MODE_SENSE_DBD(cmd
);
1369 llbaa
= GET_MODE_SENSE_LLBAA(cmd
);
1370 mph_size
= GET_MODE_SENSE_MPH_SIZE(cdb10
);
1371 blk_desc_len
= nvme_trans_get_blk_desc_len(dbd
, llbaa
);
1373 resp_size
= mph_size
+ blk_desc_len
+ mode_pages_tot_len
;
1374 /* Refer spc4r34 Table 440 for calculation of Mode data Length field */
1375 mode_data_length
= 3 + (3 * cdb10
) + blk_desc_len
+ mode_pages_tot_len
;
1377 blk_desc_offset
= mph_size
;
1378 mode_pages_offset_1
= blk_desc_offset
+ blk_desc_len
;
1380 response
= kzalloc(resp_size
, GFP_KERNEL
);
1381 if (response
== NULL
) {
1386 res
= nvme_trans_fill_mode_parm_hdr(&response
[0], mph_size
, cdb10
,
1387 llbaa
, mode_data_length
, blk_desc_len
);
1388 if (res
!= SNTI_TRANSLATION_SUCCESS
)
1390 if (blk_desc_len
> 0) {
1391 res
= nvme_trans_fill_blk_desc(ns
, hdr
,
1392 &response
[blk_desc_offset
],
1393 blk_desc_len
, llbaa
);
1394 if (res
!= SNTI_TRANSLATION_SUCCESS
)
1397 res
= mode_page_fill_func(ns
, hdr
, &response
[mode_pages_offset_1
],
1398 mode_pages_tot_len
);
1399 if (res
!= SNTI_TRANSLATION_SUCCESS
)
1402 xfer_len
= min(alloc_len
, resp_size
);
1403 res
= nvme_trans_copy_to_user(hdr
, response
, xfer_len
);
1411 /* Read Capacity Helper Functions */
1413 static void nvme_trans_fill_read_cap(u8
*response
, struct nvme_id_ns
*id_ns
,
1420 u8 p_type_lut
[4] = {0, 0, 1, 2};
1425 flbas
= (id_ns
->flbas
) & 0x0F;
1426 lba_length
= (1 << (id_ns
->lbaf
[flbas
].ds
));
1427 rlba
= le64_to_cpup(&id_ns
->nsze
) - 1;
1428 (id_ns
->dps
) ? (prot_en
= 0x01) : (prot_en
= 0);
1431 if (rlba
> 0xFFFFFFFF)
1433 tmp_rlba_32
= cpu_to_be32(rlba
);
1434 tmp_len
= cpu_to_be32(lba_length
);
1435 memcpy(response
, &tmp_rlba_32
, sizeof(u32
));
1436 memcpy(&response
[4], &tmp_len
, sizeof(u32
));
1438 tmp_rlba
= cpu_to_be64(rlba
);
1439 tmp_len
= cpu_to_be32(lba_length
);
1440 memcpy(response
, &tmp_rlba
, sizeof(u64
));
1441 memcpy(&response
[8], &tmp_len
, sizeof(u32
));
1442 response
[12] = (p_type_lut
[id_ns
->dps
& 0x3] << 1) | prot_en
;
1443 /* P_I_Exponent = 0x0 | LBPPBE = 0x0 */
1444 /* LBPME = 0 | LBPRZ = 0 | LALBA = 0x00 */
1445 /* Bytes 16-31 - Reserved */
1449 /* Start Stop Unit Helper Functions */
1451 static int nvme_trans_power_state(struct nvme_ns
*ns
, struct sg_io_hdr
*hdr
,
1452 u8 pc
, u8 pcmod
, u8 start
)
1454 int res
= SNTI_TRANSLATION_SUCCESS
;
1456 struct nvme_dev
*dev
= ns
->dev
;
1457 dma_addr_t dma_addr
;
1459 struct nvme_id_ctrl
*id_ctrl
;
1460 int lowest_pow_st
; /* max npss = lowest power consumption */
1461 unsigned ps_desired
= 0;
1463 /* NVMe Controller Identify */
1464 mem
= dma_alloc_coherent(&dev
->pci_dev
->dev
,
1465 sizeof(struct nvme_id_ctrl
),
1466 &dma_addr
, GFP_KERNEL
);
1471 nvme_sc
= nvme_identify(dev
, 0, 1, dma_addr
);
1472 res
= nvme_trans_status_code(hdr
, nvme_sc
);
1480 lowest_pow_st
= id_ctrl
->npss
- 1;
1483 case NVME_POWER_STATE_START_VALID
:
1484 /* Action unspecified if POWER CONDITION MODIFIER != 0 */
1485 if (pcmod
== 0 && start
== 0x1)
1486 ps_desired
= POWER_STATE_0
;
1487 if (pcmod
== 0 && start
== 0x0)
1488 ps_desired
= lowest_pow_st
;
1490 case NVME_POWER_STATE_ACTIVE
:
1491 /* Action unspecified if POWER CONDITION MODIFIER != 0 */
1493 ps_desired
= POWER_STATE_0
;
1495 case NVME_POWER_STATE_IDLE
:
1496 /* Action unspecified if POWER CONDITION MODIFIER != [0,1,2] */
1497 /* min of desired state and (lps-1) because lps is STOP */
1499 ps_desired
= min(POWER_STATE_1
, (lowest_pow_st
- 1));
1500 else if (pcmod
== 0x1)
1501 ps_desired
= min(POWER_STATE_2
, (lowest_pow_st
- 1));
1502 else if (pcmod
== 0x2)
1503 ps_desired
= min(POWER_STATE_3
, (lowest_pow_st
- 1));
1505 case NVME_POWER_STATE_STANDBY
:
1506 /* Action unspecified if POWER CONDITION MODIFIER != [0,1] */
1508 ps_desired
= max(0, (lowest_pow_st
- 2));
1509 else if (pcmod
== 0x1)
1510 ps_desired
= max(0, (lowest_pow_st
- 1));
1512 case NVME_POWER_STATE_LU_CONTROL
:
1514 res
= nvme_trans_completion(hdr
, SAM_STAT_CHECK_CONDITION
,
1515 ILLEGAL_REQUEST
, SCSI_ASC_INVALID_CDB
,
1516 SCSI_ASCQ_CAUSE_NOT_REPORTABLE
);
1519 nvme_sc
= nvme_set_features(dev
, NVME_FEAT_POWER_MGMT
, ps_desired
, 0,
1521 res
= nvme_trans_status_code(hdr
, nvme_sc
);
1527 dma_free_coherent(&dev
->pci_dev
->dev
, sizeof(struct nvme_id_ctrl
), mem
,
1533 /* Write Buffer Helper Functions */
1534 /* Also using this for Format Unit with hdr passed as NULL, and buffer_id, 0 */
1536 static int nvme_trans_send_fw_cmd(struct nvme_ns
*ns
, struct sg_io_hdr
*hdr
,
1537 u8 opcode
, u32 tot_len
, u32 offset
,
1540 int res
= SNTI_TRANSLATION_SUCCESS
;
1542 struct nvme_dev
*dev
= ns
->dev
;
1543 struct nvme_command c
;
1544 struct nvme_iod
*iod
= NULL
;
1547 memset(&c
, 0, sizeof(c
));
1548 c
.common
.opcode
= opcode
;
1549 if (opcode
== nvme_admin_download_fw
) {
1550 if (hdr
->iovec_count
> 0) {
1551 /* Assuming SGL is not allowed for this command */
1552 res
= nvme_trans_completion(hdr
,
1553 SAM_STAT_CHECK_CONDITION
,
1555 SCSI_ASC_INVALID_CDB
,
1556 SCSI_ASCQ_CAUSE_NOT_REPORTABLE
);
1559 iod
= nvme_map_user_pages(dev
, DMA_TO_DEVICE
,
1560 (unsigned long)hdr
->dxferp
, tot_len
);
1565 length
= nvme_setup_prps(dev
, &c
.common
, iod
, tot_len
,
1567 if (length
!= tot_len
) {
1572 c
.dlfw
.numd
= cpu_to_le32((tot_len
/BYTES_TO_DWORDS
) - 1);
1573 c
.dlfw
.offset
= cpu_to_le32(offset
/BYTES_TO_DWORDS
);
1574 } else if (opcode
== nvme_admin_activate_fw
) {
1575 u32 cdw10
= buffer_id
| NVME_FWACT_REPL_ACTV
;
1576 c
.common
.cdw10
[0] = cpu_to_le32(cdw10
);
1579 nvme_sc
= nvme_submit_admin_cmd(dev
, &c
, NULL
);
1580 res
= nvme_trans_status_code(hdr
, nvme_sc
);
1587 if (opcode
== nvme_admin_download_fw
) {
1588 nvme_unmap_user_pages(dev
, DMA_TO_DEVICE
, iod
);
1589 nvme_free_iod(dev
, iod
);
1595 /* Mode Select Helper Functions */
1597 static inline void nvme_trans_modesel_get_bd_len(u8
*parm_list
, u8 cdb10
,
1598 u16
*bd_len
, u8
*llbaa
)
1602 *bd_len
= (parm_list
[MODE_SELECT_10_BD_OFFSET
] << 8) +
1603 parm_list
[MODE_SELECT_10_BD_OFFSET
+ 1];
1604 *llbaa
= parm_list
[MODE_SELECT_10_LLBAA_OFFSET
] &&
1605 MODE_SELECT_10_LLBAA_MASK
;
1608 *bd_len
= parm_list
[MODE_SELECT_6_BD_OFFSET
];
1612 static void nvme_trans_modesel_save_bd(struct nvme_ns
*ns
, u8
*parm_list
,
1613 u16 idx
, u16 bd_len
, u8 llbaa
)
1617 bd_num
= bd_len
/ ((llbaa
== 0) ?
1618 SHORT_DESC_BLOCK
: LONG_DESC_BLOCK
);
1619 /* Store block descriptor info if a FORMAT UNIT comes later */
1620 /* TODO Saving 1st BD info; what to do if multiple BD received? */
1622 /* Standard Block Descriptor - spc4r34 7.5.5.1 */
1623 ns
->mode_select_num_blocks
=
1624 (parm_list
[idx
+ 1] << 16) +
1625 (parm_list
[idx
+ 2] << 8) +
1626 (parm_list
[idx
+ 3]);
1628 ns
->mode_select_block_len
=
1629 (parm_list
[idx
+ 5] << 16) +
1630 (parm_list
[idx
+ 6] << 8) +
1631 (parm_list
[idx
+ 7]);
1633 /* Long LBA Block Descriptor - sbc3r27 6.4.2.3 */
1634 ns
->mode_select_num_blocks
=
1635 (((u64
)parm_list
[idx
+ 0]) << 56) +
1636 (((u64
)parm_list
[idx
+ 1]) << 48) +
1637 (((u64
)parm_list
[idx
+ 2]) << 40) +
1638 (((u64
)parm_list
[idx
+ 3]) << 32) +
1639 (((u64
)parm_list
[idx
+ 4]) << 24) +
1640 (((u64
)parm_list
[idx
+ 5]) << 16) +
1641 (((u64
)parm_list
[idx
+ 6]) << 8) +
1642 ((u64
)parm_list
[idx
+ 7]);
1644 ns
->mode_select_block_len
=
1645 (parm_list
[idx
+ 12] << 24) +
1646 (parm_list
[idx
+ 13] << 16) +
1647 (parm_list
[idx
+ 14] << 8) +
1648 (parm_list
[idx
+ 15]);
1652 static int nvme_trans_modesel_get_mp(struct nvme_ns
*ns
, struct sg_io_hdr
*hdr
,
1653 u8
*mode_page
, u8 page_code
)
1655 int res
= SNTI_TRANSLATION_SUCCESS
;
1657 struct nvme_dev
*dev
= ns
->dev
;
1660 switch (page_code
) {
1661 case MODE_PAGE_CACHING
:
1662 dword11
= ((mode_page
[2] & CACHING_MODE_PAGE_WCE_MASK
) ? 1 : 0);
1663 nvme_sc
= nvme_set_features(dev
, NVME_FEAT_VOLATILE_WC
, dword11
,
1665 res
= nvme_trans_status_code(hdr
, nvme_sc
);
1673 case MODE_PAGE_CONTROL
:
1675 case MODE_PAGE_POWER_CONDITION
:
1676 /* Verify the OS is not trying to set timers */
1677 if ((mode_page
[2] & 0x01) != 0 || (mode_page
[3] & 0x0F) != 0) {
1678 res
= nvme_trans_completion(hdr
,
1679 SAM_STAT_CHECK_CONDITION
,
1681 SCSI_ASC_INVALID_PARAMETER
,
1682 SCSI_ASCQ_CAUSE_NOT_REPORTABLE
);
1684 res
= SNTI_INTERNAL_ERROR
;
1689 res
= nvme_trans_completion(hdr
, SAM_STAT_CHECK_CONDITION
,
1690 ILLEGAL_REQUEST
, SCSI_ASC_INVALID_CDB
,
1691 SCSI_ASCQ_CAUSE_NOT_REPORTABLE
);
1693 res
= SNTI_INTERNAL_ERROR
;
1700 static int nvme_trans_modesel_data(struct nvme_ns
*ns
, struct sg_io_hdr
*hdr
,
1701 u8
*cmd
, u16 parm_list_len
, u8 pf
,
1704 int res
= SNTI_TRANSLATION_SUCCESS
;
1708 u16 index
, saved_index
;
1712 /* Get parm list from data-in/out buffer */
1713 parm_list
= kmalloc(parm_list_len
, GFP_KERNEL
);
1714 if (parm_list
== NULL
) {
1719 res
= nvme_trans_copy_from_user(hdr
, parm_list
, parm_list_len
);
1720 if (res
!= SNTI_TRANSLATION_SUCCESS
)
1723 nvme_trans_modesel_get_bd_len(parm_list
, cdb10
, &bd_len
, &llbaa
);
1724 index
= (cdb10
) ? (MODE_SELECT_10_MPH_SIZE
) : (MODE_SELECT_6_MPH_SIZE
);
1727 /* Block Descriptors present, parse */
1728 nvme_trans_modesel_save_bd(ns
, parm_list
, index
, bd_len
, llbaa
);
1731 saved_index
= index
;
1733 /* Multiple mode pages may be present; iterate through all */
1734 /* In 1st Iteration, don't do NVME Command, only check for CDB errors */
1736 page_code
= parm_list
[index
] & MODE_SELECT_PAGE_CODE_MASK
;
1737 mp_size
= parm_list
[index
+ 1] + 2;
1738 if ((page_code
!= MODE_PAGE_CACHING
) &&
1739 (page_code
!= MODE_PAGE_CONTROL
) &&
1740 (page_code
!= MODE_PAGE_POWER_CONDITION
)) {
1741 res
= nvme_trans_completion(hdr
,
1742 SAM_STAT_CHECK_CONDITION
,
1744 SCSI_ASC_INVALID_CDB
,
1745 SCSI_ASCQ_CAUSE_NOT_REPORTABLE
);
1749 } while (index
< parm_list_len
);
1751 /* In 2nd Iteration, do the NVME Commands */
1752 index
= saved_index
;
1754 page_code
= parm_list
[index
] & MODE_SELECT_PAGE_CODE_MASK
;
1755 mp_size
= parm_list
[index
+ 1] + 2;
1756 res
= nvme_trans_modesel_get_mp(ns
, hdr
, &parm_list
[index
],
1758 if (res
!= SNTI_TRANSLATION_SUCCESS
)
1761 } while (index
< parm_list_len
);
1769 /* Format Unit Helper Functions */
1771 static int nvme_trans_fmt_set_blk_size_count(struct nvme_ns
*ns
,
1772 struct sg_io_hdr
*hdr
)
1774 int res
= SNTI_TRANSLATION_SUCCESS
;
1776 struct nvme_dev
*dev
= ns
->dev
;
1777 dma_addr_t dma_addr
;
1779 struct nvme_id_ns
*id_ns
;
1783 * SCSI Expects a MODE SELECT would have been issued prior to
1784 * a FORMAT UNIT, and the block size and number would be used
1785 * from the block descriptor in it. If a MODE SELECT had not
1786 * been issued, FORMAT shall use the current values for both.
1789 if (ns
->mode_select_num_blocks
== 0 || ns
->mode_select_block_len
== 0) {
1790 mem
= dma_alloc_coherent(&dev
->pci_dev
->dev
,
1791 sizeof(struct nvme_id_ns
), &dma_addr
, GFP_KERNEL
);
1796 /* nvme ns identify */
1797 nvme_sc
= nvme_identify(dev
, ns
->ns_id
, 0, dma_addr
);
1798 res
= nvme_trans_status_code(hdr
, nvme_sc
);
1807 if (ns
->mode_select_num_blocks
== 0)
1808 ns
->mode_select_num_blocks
= le64_to_cpu(id_ns
->ncap
);
1809 if (ns
->mode_select_block_len
== 0) {
1810 flbas
= (id_ns
->flbas
) & 0x0F;
1811 ns
->mode_select_block_len
=
1812 (1 << (id_ns
->lbaf
[flbas
].ds
));
1815 dma_free_coherent(&dev
->pci_dev
->dev
, sizeof(struct nvme_id_ns
),
1822 static int nvme_trans_fmt_get_parm_header(struct sg_io_hdr
*hdr
, u8 len
,
1823 u8 format_prot_info
, u8
*nvme_pf_code
)
1825 int res
= SNTI_TRANSLATION_SUCCESS
;
1827 u8 pf_usage
, pf_code
;
1829 parm_list
= kmalloc(len
, GFP_KERNEL
);
1830 if (parm_list
== NULL
) {
1834 res
= nvme_trans_copy_from_user(hdr
, parm_list
, len
);
1835 if (res
!= SNTI_TRANSLATION_SUCCESS
)
1838 if ((parm_list
[FORMAT_UNIT_IMMED_OFFSET
] &
1839 FORMAT_UNIT_IMMED_MASK
) != 0) {
1840 res
= nvme_trans_completion(hdr
, SAM_STAT_CHECK_CONDITION
,
1841 ILLEGAL_REQUEST
, SCSI_ASC_INVALID_CDB
,
1842 SCSI_ASCQ_CAUSE_NOT_REPORTABLE
);
1846 if (len
== FORMAT_UNIT_LONG_PARM_LIST_LEN
&&
1847 (parm_list
[FORMAT_UNIT_PROT_INT_OFFSET
] & 0x0F) != 0) {
1848 res
= nvme_trans_completion(hdr
, SAM_STAT_CHECK_CONDITION
,
1849 ILLEGAL_REQUEST
, SCSI_ASC_INVALID_CDB
,
1850 SCSI_ASCQ_CAUSE_NOT_REPORTABLE
);
1853 pf_usage
= parm_list
[FORMAT_UNIT_PROT_FIELD_USAGE_OFFSET
] &
1854 FORMAT_UNIT_PROT_FIELD_USAGE_MASK
;
1855 pf_code
= (pf_usage
<< 2) | format_prot_info
;
1870 res
= nvme_trans_completion(hdr
, SAM_STAT_CHECK_CONDITION
,
1871 ILLEGAL_REQUEST
, SCSI_ASC_INVALID_CDB
,
1872 SCSI_ASCQ_CAUSE_NOT_REPORTABLE
);
1882 static int nvme_trans_fmt_send_cmd(struct nvme_ns
*ns
, struct sg_io_hdr
*hdr
,
1885 int res
= SNTI_TRANSLATION_SUCCESS
;
1887 struct nvme_dev
*dev
= ns
->dev
;
1888 dma_addr_t dma_addr
;
1890 struct nvme_id_ns
*id_ns
;
1893 u8 selected_lbaf
= 0xFF;
1895 struct nvme_command c
;
1897 /* Loop thru LBAF's in id_ns to match reqd lbaf, put in cdw10 */
1898 mem
= dma_alloc_coherent(&dev
->pci_dev
->dev
, sizeof(struct nvme_id_ns
),
1899 &dma_addr
, GFP_KERNEL
);
1904 /* nvme ns identify */
1905 nvme_sc
= nvme_identify(dev
, ns
->ns_id
, 0, dma_addr
);
1906 res
= nvme_trans_status_code(hdr
, nvme_sc
);
1914 flbas
= (id_ns
->flbas
) & 0x0F;
1915 nlbaf
= id_ns
->nlbaf
;
1917 for (i
= 0; i
< nlbaf
; i
++) {
1918 if (ns
->mode_select_block_len
== (1 << (id_ns
->lbaf
[i
].ds
))) {
1923 if (selected_lbaf
> 0x0F) {
1924 res
= nvme_trans_completion(hdr
, SAM_STAT_CHECK_CONDITION
,
1925 ILLEGAL_REQUEST
, SCSI_ASC_INVALID_PARAMETER
,
1926 SCSI_ASCQ_CAUSE_NOT_REPORTABLE
);
1928 if (ns
->mode_select_num_blocks
!= le64_to_cpu(id_ns
->ncap
)) {
1929 res
= nvme_trans_completion(hdr
, SAM_STAT_CHECK_CONDITION
,
1930 ILLEGAL_REQUEST
, SCSI_ASC_INVALID_PARAMETER
,
1931 SCSI_ASCQ_CAUSE_NOT_REPORTABLE
);
1934 cdw10
|= prot_info
<< 5;
1935 cdw10
|= selected_lbaf
& 0x0F;
1936 memset(&c
, 0, sizeof(c
));
1937 c
.format
.opcode
= nvme_admin_format_nvm
;
1938 c
.format
.nsid
= cpu_to_le32(ns
->ns_id
);
1939 c
.format
.cdw10
= cpu_to_le32(cdw10
);
1941 nvme_sc
= nvme_submit_admin_cmd(dev
, &c
, NULL
);
1942 res
= nvme_trans_status_code(hdr
, nvme_sc
);
1949 dma_free_coherent(&dev
->pci_dev
->dev
, sizeof(struct nvme_id_ns
), mem
,
1955 /* Read/Write Helper Functions */
1957 static inline void nvme_trans_get_io_cdb6(u8
*cmd
,
1958 struct nvme_trans_io_cdb
*cdb_info
)
1961 cdb_info
->prot_info
= 0;
1962 cdb_info
->lba
= GET_U32_FROM_CDB(cmd
, IO_6_CDB_LBA_OFFSET
) &
1964 cdb_info
->xfer_len
= GET_U8_FROM_CDB(cmd
, IO_6_CDB_TX_LEN_OFFSET
);
1966 /* sbc3r27 sec 5.32 - TRANSFER LEN of 0 implies a 256 Block transfer */
1967 if (cdb_info
->xfer_len
== 0)
1968 cdb_info
->xfer_len
= IO_6_DEFAULT_TX_LEN
;
1971 static inline void nvme_trans_get_io_cdb10(u8
*cmd
,
1972 struct nvme_trans_io_cdb
*cdb_info
)
1974 cdb_info
->fua
= GET_U8_FROM_CDB(cmd
, IO_10_CDB_FUA_OFFSET
) &
1976 cdb_info
->prot_info
= GET_U8_FROM_CDB(cmd
, IO_10_CDB_WP_OFFSET
) &
1977 IO_CDB_WP_MASK
>> IO_CDB_WP_SHIFT
;
1978 cdb_info
->lba
= GET_U32_FROM_CDB(cmd
, IO_10_CDB_LBA_OFFSET
);
1979 cdb_info
->xfer_len
= GET_U16_FROM_CDB(cmd
, IO_10_CDB_TX_LEN_OFFSET
);
1982 static inline void nvme_trans_get_io_cdb12(u8
*cmd
,
1983 struct nvme_trans_io_cdb
*cdb_info
)
1985 cdb_info
->fua
= GET_U8_FROM_CDB(cmd
, IO_12_CDB_FUA_OFFSET
) &
1987 cdb_info
->prot_info
= GET_U8_FROM_CDB(cmd
, IO_12_CDB_WP_OFFSET
) &
1988 IO_CDB_WP_MASK
>> IO_CDB_WP_SHIFT
;
1989 cdb_info
->lba
= GET_U32_FROM_CDB(cmd
, IO_12_CDB_LBA_OFFSET
);
1990 cdb_info
->xfer_len
= GET_U32_FROM_CDB(cmd
, IO_12_CDB_TX_LEN_OFFSET
);
1993 static inline void nvme_trans_get_io_cdb16(u8
*cmd
,
1994 struct nvme_trans_io_cdb
*cdb_info
)
1996 cdb_info
->fua
= GET_U8_FROM_CDB(cmd
, IO_16_CDB_FUA_OFFSET
) &
1998 cdb_info
->prot_info
= GET_U8_FROM_CDB(cmd
, IO_16_CDB_WP_OFFSET
) &
1999 IO_CDB_WP_MASK
>> IO_CDB_WP_SHIFT
;
2000 cdb_info
->lba
= GET_U64_FROM_CDB(cmd
, IO_16_CDB_LBA_OFFSET
);
2001 cdb_info
->xfer_len
= GET_U32_FROM_CDB(cmd
, IO_16_CDB_TX_LEN_OFFSET
);
2004 static inline u32
nvme_trans_io_get_num_cmds(struct sg_io_hdr
*hdr
,
2005 struct nvme_trans_io_cdb
*cdb_info
,
2008 /* If using iovecs, send one nvme command per vector */
2009 if (hdr
->iovec_count
> 0)
2010 return hdr
->iovec_count
;
2011 else if (cdb_info
->xfer_len
> max_blocks
)
2012 return ((cdb_info
->xfer_len
- 1) / max_blocks
) + 1;
2017 static u16
nvme_trans_io_get_control(struct nvme_ns
*ns
,
2018 struct nvme_trans_io_cdb
*cdb_info
)
2022 /* When Protection information support is added, implement here */
2024 if (cdb_info
->fua
> 0)
2025 control
|= NVME_RW_FUA
;
2030 static int nvme_trans_do_nvme_io(struct nvme_ns
*ns
, struct sg_io_hdr
*hdr
,
2031 struct nvme_trans_io_cdb
*cdb_info
, u8 is_write
)
2033 int res
= SNTI_TRANSLATION_SUCCESS
;
2035 struct nvme_dev
*dev
= ns
->dev
;
2036 struct nvme_queue
*nvmeq
;
2038 struct nvme_iod
*iod
;
2040 u64 unit_num_blocks
; /* Number of blocks to xfer in each nvme cmd */
2043 u64 nvme_offset
= 0;
2044 void __user
*next_mapping_addr
;
2045 struct nvme_command c
;
2046 u8 opcode
= (is_write
? nvme_cmd_write
: nvme_cmd_read
);
2048 u32 max_blocks
= nvme_block_nr(ns
, dev
->max_hw_sectors
);
2050 num_cmds
= nvme_trans_io_get_num_cmds(hdr
, cdb_info
, max_blocks
);
2053 * This loop handles two cases.
2054 * First, when an SGL is used in the form of an iovec list:
2055 * - Use iov_base as the next mapping address for the nvme command_id
2056 * - Use iov_len as the data transfer length for the command.
2057 * Second, when we have a single buffer
2058 * - If larger than max_blocks, split into chunks, offset
2059 * each nvme command accordingly.
2061 for (i
= 0; i
< num_cmds
; i
++) {
2062 memset(&c
, 0, sizeof(c
));
2063 if (hdr
->iovec_count
> 0) {
2064 struct sg_iovec sgl
;
2066 retcode
= copy_from_user(&sgl
, hdr
->dxferp
+
2067 i
* sizeof(struct sg_iovec
),
2068 sizeof(struct sg_iovec
));
2071 unit_len
= sgl
.iov_len
;
2072 unit_num_blocks
= unit_len
>> ns
->lba_shift
;
2073 next_mapping_addr
= sgl
.iov_base
;
2075 unit_num_blocks
= min((u64
)max_blocks
,
2076 (cdb_info
->xfer_len
- nvme_offset
));
2077 unit_len
= unit_num_blocks
<< ns
->lba_shift
;
2078 next_mapping_addr
= hdr
->dxferp
+
2079 ((1 << ns
->lba_shift
) * nvme_offset
);
2082 c
.rw
.opcode
= opcode
;
2083 c
.rw
.nsid
= cpu_to_le32(ns
->ns_id
);
2084 c
.rw
.slba
= cpu_to_le64(cdb_info
->lba
+ nvme_offset
);
2085 c
.rw
.length
= cpu_to_le16(unit_num_blocks
- 1);
2086 control
= nvme_trans_io_get_control(ns
, cdb_info
);
2087 c
.rw
.control
= cpu_to_le16(control
);
2089 iod
= nvme_map_user_pages(dev
,
2090 (is_write
) ? DMA_TO_DEVICE
: DMA_FROM_DEVICE
,
2091 (unsigned long)next_mapping_addr
, unit_len
);
2096 retcode
= nvme_setup_prps(dev
, &c
.common
, iod
, unit_len
,
2098 if (retcode
!= unit_len
) {
2099 nvme_unmap_user_pages(dev
,
2100 (is_write
) ? DMA_TO_DEVICE
: DMA_FROM_DEVICE
,
2102 nvme_free_iod(dev
, iod
);
2107 nvme_offset
+= unit_num_blocks
;
2109 nvmeq
= get_nvmeq(dev
);
2111 * Since nvme_submit_sync_cmd sleeps, we can't keep
2112 * preemption disabled. We may be preempted at any
2113 * point, and be rescheduled to a different CPU. That
2114 * will cause cacheline bouncing, but no additional
2115 * races since q_lock already protects against other
2119 nvme_sc
= nvme_submit_sync_cmd(nvmeq
, &c
, NULL
,
2121 if (nvme_sc
!= NVME_SC_SUCCESS
) {
2122 nvme_unmap_user_pages(dev
,
2123 (is_write
) ? DMA_TO_DEVICE
: DMA_FROM_DEVICE
,
2125 nvme_free_iod(dev
, iod
);
2126 res
= nvme_trans_status_code(hdr
, nvme_sc
);
2129 nvme_unmap_user_pages(dev
,
2130 (is_write
) ? DMA_TO_DEVICE
: DMA_FROM_DEVICE
,
2132 nvme_free_iod(dev
, iod
);
2134 res
= nvme_trans_status_code(hdr
, NVME_SC_SUCCESS
);
2141 /* SCSI Command Translation Functions */
2143 static int nvme_trans_io(struct nvme_ns
*ns
, struct sg_io_hdr
*hdr
, u8 is_write
,
2146 int res
= SNTI_TRANSLATION_SUCCESS
;
2147 struct nvme_trans_io_cdb cdb_info
;
2150 u64 sum_iov_len
= 0;
2151 struct sg_iovec sgl
;
2155 /* Extract Fields from CDB */
2159 nvme_trans_get_io_cdb6(cmd
, &cdb_info
);
2163 nvme_trans_get_io_cdb10(cmd
, &cdb_info
);
2167 nvme_trans_get_io_cdb12(cmd
, &cdb_info
);
2171 nvme_trans_get_io_cdb16(cmd
, &cdb_info
);
2174 /* Will never really reach here */
2175 res
= SNTI_INTERNAL_ERROR
;
2179 /* Calculate total length of transfer (in bytes) */
2180 if (hdr
->iovec_count
> 0) {
2181 for (i
= 0; i
< hdr
->iovec_count
; i
++) {
2182 not_copied
= copy_from_user(&sgl
, hdr
->dxferp
+
2183 i
* sizeof(struct sg_iovec
),
2184 sizeof(struct sg_iovec
));
2187 sum_iov_len
+= sgl
.iov_len
;
2188 /* IO vector sizes should be multiples of block size */
2189 if (sgl
.iov_len
% (1 << ns
->lba_shift
) != 0) {
2190 res
= nvme_trans_completion(hdr
,
2191 SAM_STAT_CHECK_CONDITION
,
2193 SCSI_ASC_INVALID_PARAMETER
,
2194 SCSI_ASCQ_CAUSE_NOT_REPORTABLE
);
2199 sum_iov_len
= hdr
->dxfer_len
;
2202 /* As Per sg ioctl howto, if the lengths differ, use the lower one */
2203 xfer_bytes
= min(((u64
)hdr
->dxfer_len
), sum_iov_len
);
2205 /* If block count and actual data buffer size dont match, error out */
2206 if (xfer_bytes
!= (cdb_info
.xfer_len
<< ns
->lba_shift
)) {
2211 /* Check for 0 length transfer - it is not illegal */
2212 if (cdb_info
.xfer_len
== 0)
2215 /* Send NVMe IO Command(s) */
2216 res
= nvme_trans_do_nvme_io(ns
, hdr
, &cdb_info
, is_write
);
2217 if (res
!= SNTI_TRANSLATION_SUCCESS
)
2224 static int nvme_trans_inquiry(struct nvme_ns
*ns
, struct sg_io_hdr
*hdr
,
2227 int res
= SNTI_TRANSLATION_SUCCESS
;
2233 evpd
= GET_INQ_EVPD_BIT(cmd
);
2234 page_code
= GET_INQ_PAGE_CODE(cmd
);
2235 alloc_len
= GET_INQ_ALLOC_LENGTH(cmd
);
2237 inq_response
= kmalloc(STANDARD_INQUIRY_LENGTH
, GFP_KERNEL
);
2238 if (inq_response
== NULL
) {
2244 if (page_code
== INQ_STANDARD_INQUIRY_PAGE
) {
2245 res
= nvme_trans_standard_inquiry_page(ns
, hdr
,
2246 inq_response
, alloc_len
);
2248 res
= nvme_trans_completion(hdr
,
2249 SAM_STAT_CHECK_CONDITION
,
2251 SCSI_ASC_INVALID_CDB
,
2252 SCSI_ASCQ_CAUSE_NOT_REPORTABLE
);
2255 switch (page_code
) {
2256 case VPD_SUPPORTED_PAGES
:
2257 res
= nvme_trans_supported_vpd_pages(ns
, hdr
,
2258 inq_response
, alloc_len
);
2260 case VPD_SERIAL_NUMBER
:
2261 res
= nvme_trans_unit_serial_page(ns
, hdr
, inq_response
,
2264 case VPD_DEVICE_IDENTIFIERS
:
2265 res
= nvme_trans_device_id_page(ns
, hdr
, inq_response
,
2268 case VPD_EXTENDED_INQUIRY
:
2269 res
= nvme_trans_ext_inq_page(ns
, hdr
, alloc_len
);
2271 case VPD_BLOCK_DEV_CHARACTERISTICS
:
2272 res
= nvme_trans_bdev_char_page(ns
, hdr
, alloc_len
);
2275 res
= nvme_trans_completion(hdr
,
2276 SAM_STAT_CHECK_CONDITION
,
2278 SCSI_ASC_INVALID_CDB
,
2279 SCSI_ASCQ_CAUSE_NOT_REPORTABLE
);
2283 kfree(inq_response
);
2288 static int nvme_trans_log_sense(struct nvme_ns
*ns
, struct sg_io_hdr
*hdr
,
2291 int res
= SNTI_TRANSLATION_SUCCESS
;
2297 sp
= GET_U8_FROM_CDB(cmd
, LOG_SENSE_CDB_SP_OFFSET
);
2298 if (sp
!= LOG_SENSE_CDB_SP_NOT_ENABLED
) {
2299 res
= nvme_trans_completion(hdr
, SAM_STAT_CHECK_CONDITION
,
2300 ILLEGAL_REQUEST
, SCSI_ASC_INVALID_CDB
,
2301 SCSI_ASCQ_CAUSE_NOT_REPORTABLE
);
2304 pc
= GET_U8_FROM_CDB(cmd
, LOG_SENSE_CDB_PC_OFFSET
);
2305 page_code
= pc
& LOG_SENSE_CDB_PAGE_CODE_MASK
;
2306 pc
= (pc
& LOG_SENSE_CDB_PC_MASK
) >> LOG_SENSE_CDB_PC_SHIFT
;
2307 if (pc
!= LOG_SENSE_CDB_PC_CUMULATIVE_VALUES
) {
2308 res
= nvme_trans_completion(hdr
, SAM_STAT_CHECK_CONDITION
,
2309 ILLEGAL_REQUEST
, SCSI_ASC_INVALID_CDB
,
2310 SCSI_ASCQ_CAUSE_NOT_REPORTABLE
);
2313 alloc_len
= GET_U16_FROM_CDB(cmd
, LOG_SENSE_CDB_ALLOC_LENGTH_OFFSET
);
2314 switch (page_code
) {
2315 case LOG_PAGE_SUPPORTED_LOG_PAGES_PAGE
:
2316 res
= nvme_trans_log_supp_pages(ns
, hdr
, alloc_len
);
2318 case LOG_PAGE_INFORMATIONAL_EXCEPTIONS_PAGE
:
2319 res
= nvme_trans_log_info_exceptions(ns
, hdr
, alloc_len
);
2321 case LOG_PAGE_TEMPERATURE_PAGE
:
2322 res
= nvme_trans_log_temperature(ns
, hdr
, alloc_len
);
2325 res
= nvme_trans_completion(hdr
, SAM_STAT_CHECK_CONDITION
,
2326 ILLEGAL_REQUEST
, SCSI_ASC_INVALID_CDB
,
2327 SCSI_ASCQ_CAUSE_NOT_REPORTABLE
);
2335 static int nvme_trans_mode_select(struct nvme_ns
*ns
, struct sg_io_hdr
*hdr
,
2338 int res
= SNTI_TRANSLATION_SUCCESS
;
2344 page_format
= GET_U8_FROM_CDB(cmd
, MODE_SELECT_CDB_PAGE_FORMAT_OFFSET
);
2345 page_format
&= MODE_SELECT_CDB_PAGE_FORMAT_MASK
;
2347 save_pages
= GET_U8_FROM_CDB(cmd
, MODE_SELECT_CDB_SAVE_PAGES_OFFSET
);
2348 save_pages
&= MODE_SELECT_CDB_SAVE_PAGES_MASK
;
2350 if (GET_OPCODE(cmd
) == MODE_SELECT
) {
2351 parm_list_len
= GET_U8_FROM_CDB(cmd
,
2352 MODE_SELECT_6_CDB_PARAM_LIST_LENGTH_OFFSET
);
2354 parm_list_len
= GET_U16_FROM_CDB(cmd
,
2355 MODE_SELECT_10_CDB_PARAM_LIST_LENGTH_OFFSET
);
2359 if (parm_list_len
!= 0) {
2361 * According to SPC-4 r24, a paramter list length field of 0
2362 * shall not be considered an error
2364 res
= nvme_trans_modesel_data(ns
, hdr
, cmd
, parm_list_len
,
2365 page_format
, save_pages
, cdb10
);
2371 static int nvme_trans_mode_sense(struct nvme_ns
*ns
, struct sg_io_hdr
*hdr
,
2374 int res
= SNTI_TRANSLATION_SUCCESS
;
2380 if (GET_OPCODE(cmd
) == MODE_SENSE
) {
2381 alloc_len
= GET_U8_FROM_CDB(cmd
, MODE_SENSE6_ALLOC_LEN_OFFSET
);
2383 alloc_len
= GET_U16_FROM_CDB(cmd
,
2384 MODE_SENSE10_ALLOC_LEN_OFFSET
);
2388 pc
= GET_U8_FROM_CDB(cmd
, MODE_SENSE_PAGE_CONTROL_OFFSET
) &
2389 MODE_SENSE_PAGE_CONTROL_MASK
;
2390 if (pc
!= MODE_SENSE_PC_CURRENT_VALUES
) {
2391 res
= nvme_trans_completion(hdr
, SAM_STAT_CHECK_CONDITION
,
2392 ILLEGAL_REQUEST
, SCSI_ASC_INVALID_CDB
,
2393 SCSI_ASCQ_CAUSE_NOT_REPORTABLE
);
2397 page_code
= GET_U8_FROM_CDB(cmd
, MODE_SENSE_PAGE_CODE_OFFSET
) &
2398 MODE_SENSE_PAGE_CODE_MASK
;
2399 switch (page_code
) {
2400 case MODE_PAGE_CACHING
:
2401 res
= nvme_trans_mode_page_create(ns
, hdr
, cmd
, alloc_len
,
2403 &nvme_trans_fill_caching_page
,
2404 MODE_PAGE_CACHING_LEN
);
2406 case MODE_PAGE_CONTROL
:
2407 res
= nvme_trans_mode_page_create(ns
, hdr
, cmd
, alloc_len
,
2409 &nvme_trans_fill_control_page
,
2410 MODE_PAGE_CONTROL_LEN
);
2412 case MODE_PAGE_POWER_CONDITION
:
2413 res
= nvme_trans_mode_page_create(ns
, hdr
, cmd
, alloc_len
,
2415 &nvme_trans_fill_pow_cnd_page
,
2416 MODE_PAGE_POW_CND_LEN
);
2418 case MODE_PAGE_INFO_EXCEP
:
2419 res
= nvme_trans_mode_page_create(ns
, hdr
, cmd
, alloc_len
,
2421 &nvme_trans_fill_inf_exc_page
,
2422 MODE_PAGE_INF_EXC_LEN
);
2424 case MODE_PAGE_RETURN_ALL
:
2425 res
= nvme_trans_mode_page_create(ns
, hdr
, cmd
, alloc_len
,
2427 &nvme_trans_fill_all_pages
,
2431 res
= nvme_trans_completion(hdr
, SAM_STAT_CHECK_CONDITION
,
2432 ILLEGAL_REQUEST
, SCSI_ASC_INVALID_CDB
,
2433 SCSI_ASCQ_CAUSE_NOT_REPORTABLE
);
2441 static int nvme_trans_read_capacity(struct nvme_ns
*ns
, struct sg_io_hdr
*hdr
,
2444 int res
= SNTI_TRANSLATION_SUCCESS
;
2446 u32 alloc_len
= READ_CAP_10_RESP_SIZE
;
2447 u32 resp_size
= READ_CAP_10_RESP_SIZE
;
2450 struct nvme_dev
*dev
= ns
->dev
;
2451 dma_addr_t dma_addr
;
2453 struct nvme_id_ns
*id_ns
;
2456 cdb16
= IS_READ_CAP_16(cmd
);
2458 alloc_len
= GET_READ_CAP_16_ALLOC_LENGTH(cmd
);
2459 resp_size
= READ_CAP_16_RESP_SIZE
;
2462 mem
= dma_alloc_coherent(&dev
->pci_dev
->dev
, sizeof(struct nvme_id_ns
),
2463 &dma_addr
, GFP_KERNEL
);
2468 /* nvme ns identify */
2469 nvme_sc
= nvme_identify(dev
, ns
->ns_id
, 0, dma_addr
);
2470 res
= nvme_trans_status_code(hdr
, nvme_sc
);
2479 response
= kzalloc(resp_size
, GFP_KERNEL
);
2480 if (response
== NULL
) {
2484 nvme_trans_fill_read_cap(response
, id_ns
, cdb16
);
2486 xfer_len
= min(alloc_len
, resp_size
);
2487 res
= nvme_trans_copy_to_user(hdr
, response
, xfer_len
);
2491 dma_free_coherent(&dev
->pci_dev
->dev
, sizeof(struct nvme_id_ns
), mem
,
2497 static int nvme_trans_report_luns(struct nvme_ns
*ns
, struct sg_io_hdr
*hdr
,
2500 int res
= SNTI_TRANSLATION_SUCCESS
;
2502 u32 alloc_len
, xfer_len
, resp_size
;
2505 struct nvme_dev
*dev
= ns
->dev
;
2506 dma_addr_t dma_addr
;
2508 struct nvme_id_ctrl
*id_ctrl
;
2509 u32 ll_length
, lun_id
;
2510 u8 lun_id_offset
= REPORT_LUNS_FIRST_LUN_OFFSET
;
2513 alloc_len
= GET_REPORT_LUNS_ALLOC_LENGTH(cmd
);
2514 select_report
= GET_U8_FROM_CDB(cmd
, REPORT_LUNS_SR_OFFSET
);
2516 if ((select_report
!= ALL_LUNS_RETURNED
) &&
2517 (select_report
!= ALL_WELL_KNOWN_LUNS_RETURNED
) &&
2518 (select_report
!= RESTRICTED_LUNS_RETURNED
)) {
2519 res
= nvme_trans_completion(hdr
, SAM_STAT_CHECK_CONDITION
,
2520 ILLEGAL_REQUEST
, SCSI_ASC_INVALID_CDB
,
2521 SCSI_ASCQ_CAUSE_NOT_REPORTABLE
);
2524 /* NVMe Controller Identify */
2525 mem
= dma_alloc_coherent(&dev
->pci_dev
->dev
,
2526 sizeof(struct nvme_id_ctrl
),
2527 &dma_addr
, GFP_KERNEL
);
2532 nvme_sc
= nvme_identify(dev
, 0, 1, dma_addr
);
2533 res
= nvme_trans_status_code(hdr
, nvme_sc
);
2541 ll_length
= le32_to_cpu(id_ctrl
->nn
) * LUN_ENTRY_SIZE
;
2542 resp_size
= ll_length
+ LUN_DATA_HEADER_SIZE
;
2544 if (alloc_len
< resp_size
) {
2545 res
= nvme_trans_completion(hdr
,
2546 SAM_STAT_CHECK_CONDITION
,
2547 ILLEGAL_REQUEST
, SCSI_ASC_INVALID_CDB
,
2548 SCSI_ASCQ_CAUSE_NOT_REPORTABLE
);
2552 response
= kzalloc(resp_size
, GFP_KERNEL
);
2553 if (response
== NULL
) {
2558 /* The first LUN ID will always be 0 per the SAM spec */
2559 for (lun_id
= 0; lun_id
< le32_to_cpu(id_ctrl
->nn
); lun_id
++) {
2561 * Set the LUN Id and then increment to the next LUN
2562 * location in the parameter data.
2564 __be64 tmp_id
= cpu_to_be64(lun_id
);
2565 memcpy(&response
[lun_id_offset
], &tmp_id
, sizeof(u64
));
2566 lun_id_offset
+= LUN_ENTRY_SIZE
;
2568 tmp_len
= cpu_to_be32(ll_length
);
2569 memcpy(response
, &tmp_len
, sizeof(u32
));
2572 xfer_len
= min(alloc_len
, resp_size
);
2573 res
= nvme_trans_copy_to_user(hdr
, response
, xfer_len
);
2577 dma_free_coherent(&dev
->pci_dev
->dev
, sizeof(struct nvme_id_ctrl
), mem
,
2583 static int nvme_trans_request_sense(struct nvme_ns
*ns
, struct sg_io_hdr
*hdr
,
2586 int res
= SNTI_TRANSLATION_SUCCESS
;
2587 u8 alloc_len
, xfer_len
, resp_size
;
2591 alloc_len
= GET_REQUEST_SENSE_ALLOC_LENGTH(cmd
);
2592 desc_format
= GET_U8_FROM_CDB(cmd
, REQUEST_SENSE_DESC_OFFSET
);
2593 desc_format
&= REQUEST_SENSE_DESC_MASK
;
2595 resp_size
= ((desc_format
) ? (DESC_FMT_SENSE_DATA_SIZE
) :
2596 (FIXED_FMT_SENSE_DATA_SIZE
));
2597 response
= kzalloc(resp_size
, GFP_KERNEL
);
2598 if (response
== NULL
) {
2603 if (desc_format
== DESCRIPTOR_FORMAT_SENSE_DATA_TYPE
) {
2604 /* Descriptor Format Sense Data */
2605 response
[0] = DESC_FORMAT_SENSE_DATA
;
2606 response
[1] = NO_SENSE
;
2607 /* TODO How is LOW POWER CONDITION ON handled? (byte 2) */
2608 response
[2] = SCSI_ASC_NO_SENSE
;
2609 response
[3] = SCSI_ASCQ_CAUSE_NOT_REPORTABLE
;
2610 /* SDAT_OVFL = 0 | Additional Sense Length = 0 */
2612 /* Fixed Format Sense Data */
2613 response
[0] = FIXED_SENSE_DATA
;
2614 /* Byte 1 = Obsolete */
2615 response
[2] = NO_SENSE
; /* FM, EOM, ILI, SDAT_OVFL = 0 */
2616 /* Bytes 3-6 - Information - set to zero */
2617 response
[7] = FIXED_SENSE_DATA_ADD_LENGTH
;
2618 /* Bytes 8-11 - Cmd Specific Information - set to zero */
2619 response
[12] = SCSI_ASC_NO_SENSE
;
2620 response
[13] = SCSI_ASCQ_CAUSE_NOT_REPORTABLE
;
2621 /* Byte 14 = Field Replaceable Unit Code = 0 */
2622 /* Bytes 15-17 - SKSV=0; Sense Key Specific = 0 */
2625 xfer_len
= min(alloc_len
, resp_size
);
2626 res
= nvme_trans_copy_to_user(hdr
, response
, xfer_len
);
2633 static int nvme_trans_security_protocol(struct nvme_ns
*ns
,
2634 struct sg_io_hdr
*hdr
,
2637 return nvme_trans_completion(hdr
, SAM_STAT_CHECK_CONDITION
,
2638 ILLEGAL_REQUEST
, SCSI_ASC_ILLEGAL_COMMAND
,
2639 SCSI_ASCQ_CAUSE_NOT_REPORTABLE
);
2642 static int nvme_trans_start_stop(struct nvme_ns
*ns
, struct sg_io_hdr
*hdr
,
2645 int res
= SNTI_TRANSLATION_SUCCESS
;
2647 struct nvme_queue
*nvmeq
;
2648 struct nvme_command c
;
2649 u8 immed
, pcmod
, pc
, no_flush
, start
;
2651 immed
= GET_U8_FROM_CDB(cmd
, START_STOP_UNIT_CDB_IMMED_OFFSET
);
2652 pcmod
= GET_U8_FROM_CDB(cmd
, START_STOP_UNIT_CDB_POWER_COND_MOD_OFFSET
);
2653 pc
= GET_U8_FROM_CDB(cmd
, START_STOP_UNIT_CDB_POWER_COND_OFFSET
);
2654 no_flush
= GET_U8_FROM_CDB(cmd
, START_STOP_UNIT_CDB_NO_FLUSH_OFFSET
);
2655 start
= GET_U8_FROM_CDB(cmd
, START_STOP_UNIT_CDB_START_OFFSET
);
2657 immed
&= START_STOP_UNIT_CDB_IMMED_MASK
;
2658 pcmod
&= START_STOP_UNIT_CDB_POWER_COND_MOD_MASK
;
2659 pc
= (pc
& START_STOP_UNIT_CDB_POWER_COND_MASK
) >> NIBBLE_SHIFT
;
2660 no_flush
&= START_STOP_UNIT_CDB_NO_FLUSH_MASK
;
2661 start
&= START_STOP_UNIT_CDB_START_MASK
;
2664 res
= nvme_trans_completion(hdr
, SAM_STAT_CHECK_CONDITION
,
2665 ILLEGAL_REQUEST
, SCSI_ASC_INVALID_CDB
,
2666 SCSI_ASCQ_CAUSE_NOT_REPORTABLE
);
2668 if (no_flush
== 0) {
2669 /* Issue NVME FLUSH command prior to START STOP UNIT */
2670 memset(&c
, 0, sizeof(c
));
2671 c
.common
.opcode
= nvme_cmd_flush
;
2672 c
.common
.nsid
= cpu_to_le32(ns
->ns_id
);
2674 nvmeq
= get_nvmeq(ns
->dev
);
2676 nvme_sc
= nvme_submit_sync_cmd(nvmeq
, &c
, NULL
, NVME_IO_TIMEOUT
);
2678 res
= nvme_trans_status_code(hdr
, nvme_sc
);
2686 /* Setup the expected power state transition */
2687 res
= nvme_trans_power_state(ns
, hdr
, pc
, pcmod
, start
);
2694 static int nvme_trans_synchronize_cache(struct nvme_ns
*ns
,
2695 struct sg_io_hdr
*hdr
, u8
*cmd
)
2697 int res
= SNTI_TRANSLATION_SUCCESS
;
2699 struct nvme_command c
;
2700 struct nvme_queue
*nvmeq
;
2702 memset(&c
, 0, sizeof(c
));
2703 c
.common
.opcode
= nvme_cmd_flush
;
2704 c
.common
.nsid
= cpu_to_le32(ns
->ns_id
);
2706 nvmeq
= get_nvmeq(ns
->dev
);
2708 nvme_sc
= nvme_submit_sync_cmd(nvmeq
, &c
, NULL
, NVME_IO_TIMEOUT
);
2710 res
= nvme_trans_status_code(hdr
, nvme_sc
);
2720 static int nvme_trans_format_unit(struct nvme_ns
*ns
, struct sg_io_hdr
*hdr
,
2723 int res
= SNTI_TRANSLATION_SUCCESS
;
2724 u8 parm_hdr_len
= 0;
2725 u8 nvme_pf_code
= 0;
2726 u8 format_prot_info
, long_list
, format_data
;
2728 format_prot_info
= GET_U8_FROM_CDB(cmd
,
2729 FORMAT_UNIT_CDB_FORMAT_PROT_INFO_OFFSET
);
2730 long_list
= GET_U8_FROM_CDB(cmd
, FORMAT_UNIT_CDB_LONG_LIST_OFFSET
);
2731 format_data
= GET_U8_FROM_CDB(cmd
, FORMAT_UNIT_CDB_FORMAT_DATA_OFFSET
);
2733 format_prot_info
= (format_prot_info
&
2734 FORMAT_UNIT_CDB_FORMAT_PROT_INFO_MASK
) >>
2735 FORMAT_UNIT_CDB_FORMAT_PROT_INFO_SHIFT
;
2736 long_list
&= FORMAT_UNIT_CDB_LONG_LIST_MASK
;
2737 format_data
&= FORMAT_UNIT_CDB_FORMAT_DATA_MASK
;
2739 if (format_data
!= 0) {
2740 if (format_prot_info
!= 0) {
2742 parm_hdr_len
= FORMAT_UNIT_SHORT_PARM_LIST_LEN
;
2744 parm_hdr_len
= FORMAT_UNIT_LONG_PARM_LIST_LEN
;
2746 } else if (format_data
== 0 && format_prot_info
!= 0) {
2747 res
= nvme_trans_completion(hdr
, SAM_STAT_CHECK_CONDITION
,
2748 ILLEGAL_REQUEST
, SCSI_ASC_INVALID_CDB
,
2749 SCSI_ASCQ_CAUSE_NOT_REPORTABLE
);
2753 /* Get parm header from data-in/out buffer */
2755 * According to the translation spec, the only fields in the parameter
2756 * list we are concerned with are in the header. So allocate only that.
2758 if (parm_hdr_len
> 0) {
2759 res
= nvme_trans_fmt_get_parm_header(hdr
, parm_hdr_len
,
2760 format_prot_info
, &nvme_pf_code
);
2761 if (res
!= SNTI_TRANSLATION_SUCCESS
)
2765 /* Attempt to activate any previously downloaded firmware image */
2766 res
= nvme_trans_send_fw_cmd(ns
, hdr
, nvme_admin_activate_fw
, 0, 0, 0);
2768 /* Determine Block size and count and send format command */
2769 res
= nvme_trans_fmt_set_blk_size_count(ns
, hdr
);
2770 if (res
!= SNTI_TRANSLATION_SUCCESS
)
2773 res
= nvme_trans_fmt_send_cmd(ns
, hdr
, nvme_pf_code
);
2779 static int nvme_trans_test_unit_ready(struct nvme_ns
*ns
,
2780 struct sg_io_hdr
*hdr
,
2783 int res
= SNTI_TRANSLATION_SUCCESS
;
2784 struct nvme_dev
*dev
= ns
->dev
;
2786 if (!(readl(&dev
->bar
->csts
) & NVME_CSTS_RDY
))
2787 res
= nvme_trans_completion(hdr
, SAM_STAT_CHECK_CONDITION
,
2788 NOT_READY
, SCSI_ASC_LUN_NOT_READY
,
2789 SCSI_ASCQ_CAUSE_NOT_REPORTABLE
);
2791 res
= nvme_trans_completion(hdr
, SAM_STAT_GOOD
, NO_SENSE
, 0, 0);
2796 static int nvme_trans_write_buffer(struct nvme_ns
*ns
, struct sg_io_hdr
*hdr
,
2799 int res
= SNTI_TRANSLATION_SUCCESS
;
2800 u32 buffer_offset
, parm_list_length
;
2804 GET_U24_FROM_CDB(cmd
, WRITE_BUFFER_CDB_PARM_LIST_LENGTH_OFFSET
);
2805 if (parm_list_length
% BYTES_TO_DWORDS
!= 0) {
2806 /* NVMe expects Firmware file to be a whole number of DWORDS */
2807 res
= nvme_trans_completion(hdr
, SAM_STAT_CHECK_CONDITION
,
2808 ILLEGAL_REQUEST
, SCSI_ASC_INVALID_CDB
,
2809 SCSI_ASCQ_CAUSE_NOT_REPORTABLE
);
2812 buffer_id
= GET_U8_FROM_CDB(cmd
, WRITE_BUFFER_CDB_BUFFER_ID_OFFSET
);
2813 if (buffer_id
> NVME_MAX_FIRMWARE_SLOT
) {
2814 res
= nvme_trans_completion(hdr
, SAM_STAT_CHECK_CONDITION
,
2815 ILLEGAL_REQUEST
, SCSI_ASC_INVALID_CDB
,
2816 SCSI_ASCQ_CAUSE_NOT_REPORTABLE
);
2819 mode
= GET_U8_FROM_CDB(cmd
, WRITE_BUFFER_CDB_MODE_OFFSET
) &
2820 WRITE_BUFFER_CDB_MODE_MASK
;
2822 GET_U24_FROM_CDB(cmd
, WRITE_BUFFER_CDB_BUFFER_OFFSET_OFFSET
);
2825 case DOWNLOAD_SAVE_ACTIVATE
:
2826 res
= nvme_trans_send_fw_cmd(ns
, hdr
, nvme_admin_download_fw
,
2827 parm_list_length
, buffer_offset
,
2829 if (res
!= SNTI_TRANSLATION_SUCCESS
)
2831 res
= nvme_trans_send_fw_cmd(ns
, hdr
, nvme_admin_activate_fw
,
2832 parm_list_length
, buffer_offset
,
2835 case DOWNLOAD_SAVE_DEFER_ACTIVATE
:
2836 res
= nvme_trans_send_fw_cmd(ns
, hdr
, nvme_admin_download_fw
,
2837 parm_list_length
, buffer_offset
,
2840 case ACTIVATE_DEFERRED_MICROCODE
:
2841 res
= nvme_trans_send_fw_cmd(ns
, hdr
, nvme_admin_activate_fw
,
2842 parm_list_length
, buffer_offset
,
2846 res
= nvme_trans_completion(hdr
, SAM_STAT_CHECK_CONDITION
,
2847 ILLEGAL_REQUEST
, SCSI_ASC_INVALID_CDB
,
2848 SCSI_ASCQ_CAUSE_NOT_REPORTABLE
);
2856 struct scsi_unmap_blk_desc
{
2862 struct scsi_unmap_parm_list
{
2863 __be16 unmap_data_len
;
2864 __be16 unmap_blk_desc_data_len
;
2866 struct scsi_unmap_blk_desc desc
[0];
2869 static int nvme_trans_unmap(struct nvme_ns
*ns
, struct sg_io_hdr
*hdr
,
2872 struct nvme_dev
*dev
= ns
->dev
;
2873 struct scsi_unmap_parm_list
*plist
;
2874 struct nvme_dsm_range
*range
;
2875 struct nvme_queue
*nvmeq
;
2876 struct nvme_command c
;
2877 int i
, nvme_sc
, res
= -ENOMEM
;
2878 u16 ndesc
, list_len
;
2879 dma_addr_t dma_addr
;
2881 list_len
= GET_U16_FROM_CDB(cmd
, UNMAP_CDB_PARAM_LIST_LENGTH_OFFSET
);
2885 plist
= kmalloc(list_len
, GFP_KERNEL
);
2889 res
= nvme_trans_copy_from_user(hdr
, plist
, list_len
);
2890 if (res
!= SNTI_TRANSLATION_SUCCESS
)
2893 ndesc
= be16_to_cpu(plist
->unmap_blk_desc_data_len
) >> 4;
2894 if (!ndesc
|| ndesc
> 256) {
2899 range
= dma_alloc_coherent(&dev
->pci_dev
->dev
, ndesc
* sizeof(*range
),
2900 &dma_addr
, GFP_KERNEL
);
2904 for (i
= 0; i
< ndesc
; i
++) {
2905 range
[i
].nlb
= cpu_to_le32(be32_to_cpu(plist
->desc
[i
].nlb
));
2906 range
[i
].slba
= cpu_to_le64(be64_to_cpu(plist
->desc
[i
].slba
));
2910 memset(&c
, 0, sizeof(c
));
2911 c
.dsm
.opcode
= nvme_cmd_dsm
;
2912 c
.dsm
.nsid
= cpu_to_le32(ns
->ns_id
);
2913 c
.dsm
.prp1
= cpu_to_le64(dma_addr
);
2914 c
.dsm
.nr
= cpu_to_le32(ndesc
- 1);
2915 c
.dsm
.attributes
= cpu_to_le32(NVME_DSMGMT_AD
);
2917 nvmeq
= get_nvmeq(dev
);
2920 nvme_sc
= nvme_submit_sync_cmd(nvmeq
, &c
, NULL
, NVME_IO_TIMEOUT
);
2921 res
= nvme_trans_status_code(hdr
, nvme_sc
);
2923 dma_free_coherent(&dev
->pci_dev
->dev
, ndesc
* sizeof(*range
),
2930 static int nvme_scsi_translate(struct nvme_ns
*ns
, struct sg_io_hdr
*hdr
)
2932 u8 cmd
[BLK_MAX_CDB
];
2934 unsigned int opcode
;
2936 if (hdr
->cmdp
== NULL
)
2938 if (copy_from_user(cmd
, hdr
->cmdp
, hdr
->cmd_len
))
2948 retcode
= nvme_trans_io(ns
, hdr
, 0, cmd
);
2954 retcode
= nvme_trans_io(ns
, hdr
, 1, cmd
);
2957 retcode
= nvme_trans_inquiry(ns
, hdr
, cmd
);
2960 retcode
= nvme_trans_log_sense(ns
, hdr
, cmd
);
2963 case MODE_SELECT_10
:
2964 retcode
= nvme_trans_mode_select(ns
, hdr
, cmd
);
2968 retcode
= nvme_trans_mode_sense(ns
, hdr
, cmd
);
2971 retcode
= nvme_trans_read_capacity(ns
, hdr
, cmd
);
2973 case SERVICE_ACTION_IN
:
2974 if (IS_READ_CAP_16(cmd
))
2975 retcode
= nvme_trans_read_capacity(ns
, hdr
, cmd
);
2980 retcode
= nvme_trans_report_luns(ns
, hdr
, cmd
);
2983 retcode
= nvme_trans_request_sense(ns
, hdr
, cmd
);
2985 case SECURITY_PROTOCOL_IN
:
2986 case SECURITY_PROTOCOL_OUT
:
2987 retcode
= nvme_trans_security_protocol(ns
, hdr
, cmd
);
2990 retcode
= nvme_trans_start_stop(ns
, hdr
, cmd
);
2992 case SYNCHRONIZE_CACHE
:
2993 retcode
= nvme_trans_synchronize_cache(ns
, hdr
, cmd
);
2996 retcode
= nvme_trans_format_unit(ns
, hdr
, cmd
);
2998 case TEST_UNIT_READY
:
2999 retcode
= nvme_trans_test_unit_ready(ns
, hdr
, cmd
);
3002 retcode
= nvme_trans_write_buffer(ns
, hdr
, cmd
);
3005 retcode
= nvme_trans_unmap(ns
, hdr
, cmd
);
3009 retcode
= nvme_trans_completion(hdr
, SAM_STAT_CHECK_CONDITION
,
3010 ILLEGAL_REQUEST
, SCSI_ASC_ILLEGAL_COMMAND
,
3011 SCSI_ASCQ_CAUSE_NOT_REPORTABLE
);
3017 int nvme_sg_io(struct nvme_ns
*ns
, struct sg_io_hdr __user
*u_hdr
)
3019 struct sg_io_hdr hdr
;
3022 if (!capable(CAP_SYS_ADMIN
))
3024 if (copy_from_user(&hdr
, u_hdr
, sizeof(hdr
)))
3026 if (hdr
.interface_id
!= 'S')
3028 if (hdr
.cmd_len
> BLK_MAX_CDB
)
3031 retcode
= nvme_scsi_translate(ns
, &hdr
);
3035 retcode
= SNTI_TRANSLATION_SUCCESS
;
3036 if (copy_to_user(u_hdr
, &hdr
, sizeof(sg_io_hdr_t
)) > 0)
3042 #ifdef CONFIG_COMPAT
3043 typedef struct sg_io_hdr32
{
3044 compat_int_t interface_id
; /* [i] 'S' for SCSI generic (required) */
3045 compat_int_t dxfer_direction
; /* [i] data transfer direction */
3046 unsigned char cmd_len
; /* [i] SCSI command length ( <= 16 bytes) */
3047 unsigned char mx_sb_len
; /* [i] max length to write to sbp */
3048 unsigned short iovec_count
; /* [i] 0 implies no scatter gather */
3049 compat_uint_t dxfer_len
; /* [i] byte count of data transfer */
3050 compat_uint_t dxferp
; /* [i], [*io] points to data transfer memory
3051 or scatter gather list */
3052 compat_uptr_t cmdp
; /* [i], [*i] points to command to perform */
3053 compat_uptr_t sbp
; /* [i], [*o] points to sense_buffer memory */
3054 compat_uint_t timeout
; /* [i] MAX_UINT->no timeout (unit: millisec) */
3055 compat_uint_t flags
; /* [i] 0 -> default, see SG_FLAG... */
3056 compat_int_t pack_id
; /* [i->o] unused internally (normally) */
3057 compat_uptr_t usr_ptr
; /* [i->o] unused internally */
3058 unsigned char status
; /* [o] scsi status */
3059 unsigned char masked_status
; /* [o] shifted, masked scsi status */
3060 unsigned char msg_status
; /* [o] messaging level data (optional) */
3061 unsigned char sb_len_wr
; /* [o] byte count actually written to sbp */
3062 unsigned short host_status
; /* [o] errors from host adapter */
3063 unsigned short driver_status
; /* [o] errors from software driver */
3064 compat_int_t resid
; /* [o] dxfer_len - actual_transferred */
3065 compat_uint_t duration
; /* [o] time taken by cmd (unit: millisec) */
3066 compat_uint_t info
; /* [o] auxiliary information */
3067 } sg_io_hdr32_t
; /* 64 bytes long (on sparc32) */
3069 typedef struct sg_iovec32
{
3070 compat_uint_t iov_base
;
3071 compat_uint_t iov_len
;
3074 static int sg_build_iovec(sg_io_hdr_t __user
*sgio
, void __user
*dxferp
, u16 iovec_count
)
3076 sg_iovec_t __user
*iov
= (sg_iovec_t __user
*) (sgio
+ 1);
3077 sg_iovec32_t __user
*iov32
= dxferp
;
3080 for (i
= 0; i
< iovec_count
; i
++) {
3083 if (get_user(base
, &iov32
[i
].iov_base
) ||
3084 get_user(len
, &iov32
[i
].iov_len
) ||
3085 put_user(compat_ptr(base
), &iov
[i
].iov_base
) ||
3086 put_user(len
, &iov
[i
].iov_len
))
3090 if (put_user(iov
, &sgio
->dxferp
))
3095 int nvme_sg_io32(struct nvme_ns
*ns
, unsigned long arg
)
3097 sg_io_hdr32_t __user
*sgio32
= (sg_io_hdr32_t __user
*)arg
;
3098 sg_io_hdr_t __user
*sgio
;
3101 void __user
*dxferp
;
3105 if (get_user(interface_id
, &sgio32
->interface_id
))
3107 if (interface_id
!= 'S')
3110 if (get_user(iovec_count
, &sgio32
->iovec_count
))
3114 void __user
*top
= compat_alloc_user_space(0);
3115 void __user
*new = compat_alloc_user_space(sizeof(sg_io_hdr_t
) +
3116 (iovec_count
* sizeof(sg_iovec_t
)));
3123 /* Ok, now construct. */
3124 if (copy_in_user(&sgio
->interface_id
, &sgio32
->interface_id
,
3126 (2 * sizeof(unsigned char)) +
3127 (1 * sizeof(unsigned short)) +
3128 (1 * sizeof(unsigned int))))
3131 if (get_user(data
, &sgio32
->dxferp
))
3133 dxferp
= compat_ptr(data
);
3135 if (sg_build_iovec(sgio
, dxferp
, iovec_count
))
3138 if (put_user(dxferp
, &sgio
->dxferp
))
3143 unsigned char __user
*cmdp
;
3144 unsigned char __user
*sbp
;
3146 if (get_user(data
, &sgio32
->cmdp
))
3148 cmdp
= compat_ptr(data
);
3150 if (get_user(data
, &sgio32
->sbp
))
3152 sbp
= compat_ptr(data
);
3154 if (put_user(cmdp
, &sgio
->cmdp
) ||
3155 put_user(sbp
, &sgio
->sbp
))
3159 if (copy_in_user(&sgio
->timeout
, &sgio32
->timeout
,
3163 if (get_user(data
, &sgio32
->usr_ptr
))
3165 if (put_user(compat_ptr(data
), &sgio
->usr_ptr
))
3168 err
= nvme_sg_io(ns
, sgio
);
3172 if (copy_in_user(&sgio32
->pack_id
, &sgio
->pack_id
,
3174 get_user(datap
, &sgio
->usr_ptr
) ||
3175 put_user((u32
)(unsigned long)datap
,
3176 &sgio32
->usr_ptr
) ||
3177 copy_in_user(&sgio32
->status
, &sgio
->status
,
3178 (4 * sizeof(unsigned char)) +
3179 (2 * sizeof(unsigned short)) +
3188 int nvme_sg_get_version_num(int __user
*ip
)
3190 return put_user(sg_version_num
, ip
);