-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathsg_pt_linux_nvme.c
1971 lines (1851 loc) · 66.9 KB
/
sg_pt_linux_nvme.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (c) 2017-2023 Douglas Gilbert.
* All rights reserved.
* Use of this source code is governed by a BSD-style
* license that can be found in the BSD_LICENSE file.
*
* SPDX-License-Identifier: BSD-2-Clause
*
* The code to use the NVMe Management Interface (MI) SES pass-through
* was provided by WDC in November 2017.
*/
/*
* Copyright 2017, Western Digital Corporation
*
* Written by Berck Nash
*
* Use of this source code is governed by a BSD-style
* license that can be found in the BSD_LICENSE file.
*
* Based on the NVM-Express command line utility, which bore the following
* notice:
*
* Copyright (c) 2014-2015, Intel Corporation.
*
* Written by Keith Busch <[email protected]>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
* MA 02110-1301, USA.
*/
/* sg_pt_linux_nvme version 1.21 20231123 */
/* This file contains a small "SPC-only" SNTL to support the SES pass-through
* of SEND DIAGNOSTIC and RECEIVE DIAGNOSTIC RESULTS through NVME-MI
* SES Send and SES Receive. */
/* This implementation will be gradually changed to follow the T10 23-047r1
* proposal: "Broadcom SNT Reference". This assumes that that proposal will
* be used as the basis T10's forthcoming SNT standard which as yet does
* not have any drafts. When those drafts appear, they will be followed. */
#include <stdio.h>
#include <stdlib.h>
#include <stdarg.h>
#include <stdbool.h>
#include <string.h>
#include <ctype.h>
#include <unistd.h>
#include <errno.h>
#include <fcntl.h>
#define __STDC_FORMAT_MACROS 1
#include <inttypes.h>
#include <sys/ioctl.h>
#include <sys/stat.h>
#include <sys/sysmacros.h> /* to define 'major' */
#ifndef major
#include <sys/types.h>
#endif
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#ifdef HAVE_LINUX_MAJOR_H
#include <linux/major.h>
#endif
#include "sg_pt.h"
#include "sg_lib.h"
#include "sg_linux_inc.h"
#include "sg_pt_linux.h"
#include "sg_unaligned.h"
#include "sg_pr2serr.h"
#define SCSI_INQUIRY_OPC 0x12
#define SCSI_REPORT_LUNS_OPC 0xa0
#define SCSI_TEST_UNIT_READY_OPC 0x0
#define SCSI_REQUEST_SENSE_OPC 0x3
#define SCSI_SEND_DIAGNOSTIC_OPC 0x1d
#define SCSI_RECEIVE_DIAGNOSTIC_OPC 0x1c
#define SCSI_MAINT_IN_OPC 0xa3
#define SCSI_READ10_OPC 0x28
#define SCSI_READ16_OPC 0x88
#define SCSI_REP_SUP_OPCS_OPC 0xc
#define SCSI_REP_SUP_TMFS_OPC 0xd
#define SCSI_MODE_SENSE10_OPC 0x5a
#define SCSI_MODE_SELECT10_OPC 0x55
#define SCSI_READ_CAPACITY10_OPC 0x25
#define SCSI_START_STOP_OPC 0x1b
#define SCSI_SYNC_CACHE10_OPC 0x35
#define SCSI_SYNC_CACHE16_OPC 0x91
#define SCSI_VERIFY10_OPC 0x2f
#define SCSI_VERIFY16_OPC 0x8f
#define SCSI_WRITE10_OPC 0x2a
#define SCSI_WRITE16_OPC 0x8a
#define SCSI_WRITE_SAME10_OPC 0x41
#define SCSI_WRITE_SAME16_OPC 0x93
#define SCSI_SERVICE_ACT_IN_OPC 0x9e
#define SCSI_READ_CAPACITY16_SA 0x10
#define SCSI_SA_MSK 0x1f
/* Additional Sense Code (ASC) */
#define NO_ADDITIONAL_SENSE 0x0
#define LOGICAL_UNIT_NOT_READY 0x4
#define LOGICAL_UNIT_COMMUNICATION_FAILURE 0x8
#define UNRECOVERED_READ_ERR 0x11
#define PARAMETER_LIST_LENGTH_ERR 0x1a
#define INVALID_OPCODE 0x20
#define LBA_OUT_OF_RANGE 0x21
#define INVALID_FIELD_IN_CDB 0x24
#define INVALID_FIELD_IN_PARAM_LIST 0x26
#define UA_RESET_ASC 0x29
#define UA_CHANGED_ASC 0x2a
#define TARGET_CHANGED_ASC 0x3f
#define LUNS_CHANGED_ASCQ 0x0e
#define INSUFF_RES_ASC 0x55
#define INSUFF_RES_ASCQ 0x3
#define LOW_POWER_COND_ON_ASC 0x5e /* ASCQ=0 */
#define POWER_ON_RESET_ASCQ 0x0
#define BUS_RESET_ASCQ 0x2 /* scsi bus reset occurred */
#define MODE_CHANGED_ASCQ 0x1 /* mode parameters changed */
#define CAPACITY_CHANGED_ASCQ 0x9
#define SAVING_PARAMS_UNSUP 0x39
#define TRANSPORT_PROBLEM 0x4b
#define THRESHOLD_EXCEEDED 0x5d
#define LOW_POWER_COND_ON 0x5e
#define MISCOMPARE_VERIFY_ASC 0x1d
#define MICROCODE_CHANGED_ASCQ 0x1 /* with TARGET_CHANGED_ASC */
#define MICROCODE_CHANGED_WO_RESET_ASCQ 0x16
#define PCIE_ERR_ASC 0x4b
#define PCIE_UNSUPP_REQ_ASCQ 0x13
/* NVMe Admin commands */
#define SG_NVME_AD_GET_FEATURE 0xa
#define SG_NVME_AD_SET_FEATURE 0x9
#define SG_NVME_AD_IDENTIFY 0x6 /* similar to SCSI INQUIRY */
#define SG_NVME_AD_DEV_SELT_TEST 0x14
#define SG_NVME_AD_MI_RECEIVE 0x1e /* MI: Management Interface */
#define SG_NVME_AD_MI_SEND 0x1d /* hmmm, same opcode as SEND DIAG */
/* NVMe NVM (Non-Volatile Memory) commands */
#define SG_NVME_NVM_FLUSH 0x0 /* SCSI SYNCHRONIZE CACHE */
#define SG_NVME_NVM_COMPARE 0x5 /* SCSI VERIFY(BYTCHK=1) */
#define SG_NVME_NVM_READ 0x2
#define SG_NVME_NVM_VERIFY 0xc /* SCSI VERIFY(BYTCHK=0) */
#define SG_NVME_NVM_WRITE 0x1
#define SG_NVME_NVM_WRITE_ZEROES 0x8 /* SCSI WRITE SAME */
#define SG_NVME_RW_CONTROL_FUA (1 << 14) /* Force Unit Access bit */
#if (HAVE_NVME && (! IGNORE_NVME))
/* This trims given NVMe block device name in Linux (e.g. /dev/nvme0n1p5)
* to the name of its associated char device (e.g. /dev/nvme0). If this
* occurs true is returned and the char device name is placed in 'b' (as
* long as b_len is sufficient). Otherwise false is returned. */
bool
sg_get_nvme_char_devname(const char * nvme_block_devname, uint32_t b_len,
char * b)
{
uint32_t n, tlen;
const char * cp;
char buff[8];
if ((NULL == b) || (b_len < 5))
return false; /* degenerate cases */
cp = strstr(nvme_block_devname, "nvme");
if (NULL == cp)
return false; /* expected to find "nvme" in given name */
if (1 != sscanf(cp, "nvme%u", &n))
return false; /* didn't find valid "nvme<number>" */
snprintf(buff, sizeof(buff), "%u", n);
tlen = (cp - nvme_block_devname) + 4 + strlen(buff);
if ((tlen + 1) > b_len)
return false; /* b isn't long enough to fit output */
memcpy(b, nvme_block_devname, tlen);
b[tlen] = '\0';
return true;
}
static void
mk_sense_asc_ascq(struct sg_pt_linux_scsi * ptp, int sk, int asc, int ascq,
int vb)
{
bool dsense = !! ptp->dev_stat.scsi_dsense;
int n;
uint8_t * sbp = (uint8_t *)(sg_uintptr_t)ptp->io_hdr.response;
ptp->io_hdr.device_status = SAM_STAT_CHECK_CONDITION;
n = ptp->io_hdr.max_response_len;
if ((n < 8) || ((! dsense) && (n < 14))) {
if (vb)
pr2ws("%s: max_response_len=%d too short, want 14 or more\n",
__func__, n);
return;
} else
ptp->io_hdr.response_len = dsense ? n : ((n < 18) ? n : 18);
memset(sbp, 0, n);
sg_build_sense_buffer(dsense, sbp, sk, asc, ascq);
if (vb > 3)
pr2ws("%s: [sense_key,asc,ascq]: [0x%x,0x%x,0x%x]\n", __func__, sk,
asc, ascq);
}
static void
mk_sense_from_nvme_status(struct sg_pt_linux_scsi * ptp, int vb)
{
bool ok;
bool dsense = !! ptp->dev_stat.scsi_dsense;
int n;
uint8_t sstatus, sk, asc, ascq;
uint8_t * sbp = (uint8_t *)(sg_uintptr_t)ptp->io_hdr.response;
ok = sg_nvme_status2scsi(ptp->nvme_status, &sstatus, &sk, &asc, &ascq);
if (! ok) { /* can't find a mapping to a SCSI error, so ... */
sstatus = SAM_STAT_CHECK_CONDITION;
sk = SPC_SK_ILLEGAL_REQUEST;
asc = 0xb;
ascq = 0x0; /* asc: "WARNING" purposely vague */
}
ptp->io_hdr.device_status = sstatus;
n = ptp->io_hdr.max_response_len;
if ((n < 8) || ((! dsense) && (n < 14))) {
pr2ws("%s: sense_len=%d too short, want 14 or more\n", __func__, n);
return;
} else
ptp->io_hdr.response_len = dsense ? n : ((n < 18) ? n : 18);
memset(sbp, 0, n);
sg_build_sense_buffer(dsense, sbp, sk, asc, ascq);
if (dsense && (ptp->nvme_status > 0))
sg_nvme_desc2sense(sbp, ptp->nvme_stat_dnr, ptp->nvme_stat_more,
ptp->nvme_status);
if (vb > 3)
pr2ws("%s: [status, sense_key,asc,ascq]: [0x%x, 0x%x,0x%x,0x%x]\n",
__func__, sstatus, sk, asc, ascq);
}
/* Set in_bit to -1 to indicate no bit position of invalid field */
static void
mk_sense_invalid_fld(struct sg_pt_linux_scsi * ptp, bool in_cdb, int in_byte,
int in_bit, int vb)
{
bool dsense = !! ptp->dev_stat.scsi_dsense;
int asc, n;
uint8_t * sbp = (uint8_t *)(sg_uintptr_t)ptp->io_hdr.response;
uint8_t sks[4];
ptp->io_hdr.device_status = SAM_STAT_CHECK_CONDITION;
asc = in_cdb ? INVALID_FIELD_IN_CDB : INVALID_FIELD_IN_PARAM_LIST;
n = ptp->io_hdr.max_response_len;
if ((n < 8) || ((! dsense) && (n < 14))) {
if (vb)
pr2ws("%s: max_response_len=%d too short, want 14 or more\n",
__func__, n);
return;
} else
ptp->io_hdr.response_len = dsense ? n : ((n < 18) ? n : 18);
memset(sbp, 0, n);
sg_build_sense_buffer(dsense, sbp, SPC_SK_ILLEGAL_REQUEST, asc, 0);
memset(sks, 0, sizeof(sks));
sks[0] = 0x80;
if (in_cdb)
sks[0] |= 0x40;
if (in_bit >= 0) {
sks[0] |= 0x8;
sks[0] |= (0x7 & in_bit);
}
sg_put_unaligned_be16(in_byte, sks + 1);
if (dsense) {
int sl = sbp[7] + 8;
sbp[7] = sl;
sbp[sl] = 0x2;
sbp[sl + 1] = 0x6;
memcpy(sbp + sl + 4, sks, 3);
} else
memcpy(sbp + 15, sks, 3);
if (vb > 3)
pr2ws("%s: [sense_key,asc,ascq]: [0x5,0x%x,0x0] %c byte=%d, bit=%d\n",
__func__, asc, in_cdb ? 'C' : 'D', in_byte,
((in_bit > 0) ? (0x7 & in_bit) : 0));
}
/* Returns 0 for success. Returns SG_LIB_NVME_STATUS if there is non-zero
* NVMe status (from the completion queue) with the value placed in
* ptp->nvme_status. If Unix error from ioctl then return negated value
* (equivalent -errno from basic Unix system functions like open()).
* CDW0 from the completion queue is placed in ptp->nvme_result in the
* absence of a Unix error. If time_secs is negative it is treated as
* a timeout in milliseconds (of abs(time_secs) ). */
static int
sg_nvme_admin_cmd_f(struct sg_pt_linux_scsi * ptp,
struct sg_nvme_passthru_cmd *cmdp, void * dp,
bool is_read, int time_secs, int vb)
{
const uint32_t cmd_len = sizeof(struct sg_nvme_passthru_cmd);
int res;
uint32_t n;
uint16_t sct_sc;
const uint8_t * up = ((const uint8_t *)cmdp) + SG_NVME_OPCODE;
char nam[64];
if (vb)
sg_get_nvme_opcode_name(*up, true /* ADMIN */, sizeof(nam), nam);
else
nam[0] = '\0';
cmdp->timeout_ms = (time_secs < 0) ? (-time_secs) : (1000 * time_secs);
ptp->os_err = 0;
if (vb > 2) {
pr2ws("NVMe Admin command: %s\n", nam);
hex2stderr((const uint8_t *)cmdp, cmd_len, 1);
if ((vb > 4) && (! is_read) && dp) {
uint32_t len = sg_get_unaligned_le32(up + SG_NVME_DATA_LEN);
if (len > 0) {
n = len;
if ((len < 512) || (vb > 5))
pr2ws("\nData-out buffer (%u bytes):\n", n);
else {
pr2ws("\nData-out buffer (first 512 of %u bytes):\n", n);
n = 512;
}
hex2stderr((const uint8_t *)dp, n, 0);
}
}
}
res = ioctl(ptp->dev_fd, NVME_IOCTL_ADMIN_CMD, cmdp);
if (res < 0) { /* OS error (errno negated) */
ptp->os_err = -res;
if (vb > 1) {
pr2ws("%s: ioctl for %s [0x%x] failed: %s "
"(errno=%d)\n", __func__, nam, *up, strerror(-res), -res);
}
return res;
}
/* Now res contains NVMe completion queue CDW3 31:17 (15 bits) */
ptp->nvme_result = cmdp->result;
if ((! ptp->nvme_our_snt) && ptp->io_hdr.response &&
(ptp->io_hdr.max_response_len > 3)) {
/* build 32 byte "sense" buffer */
uint8_t * sbp = (uint8_t *)(sg_uintptr_t)ptp->io_hdr.response;
uint16_t st = (uint16_t)res;
n = ptp->io_hdr.max_response_len;
n = (n < 32) ? n : 32;
memset(sbp, 0 , n);
ptp->io_hdr.response_len = n;
sg_put_unaligned_le32(cmdp->result,
sbp + SG_NVME_CQ_RESULT);
if (n > 15) /* LSBit will be 0 (Phase bit) after (st << 1) */
sg_put_unaligned_le16(st << 1, sbp + SG_NVME_CQ_STATUS_P);
}
/* clear upper bits (DNR and More) leaving ((SCT << 8) | SC) */
sct_sc = 0x7ff & res; /* 11 bits */
ptp->nvme_status = sct_sc;
ptp->nvme_stat_dnr = !!(0x4000 & res);
ptp->nvme_stat_more = !!(0x2000 & res);
if (sct_sc) { /* when non-zero, treat as command error */
if (vb > 1) {
char b[80];
pr2ws("%s: ioctl for %s [0x%x] failed, status: %s [0x%x]\n",
__func__, nam, *up,
sg_get_nvme_cmd_status_str(sct_sc, sizeof(b), b), sct_sc);
}
return SG_LIB_NVME_STATUS; /* == SCSI_PT_DO_NVME_STATUS */
}
if ((vb > 4) && is_read && dp) {
uint32_t len = sg_get_unaligned_le32(up + SG_NVME_DATA_LEN);
if (len > 0) {
n = len;
if ((len < 1024) || (vb > 5))
pr2ws("\nData-in buffer (%u bytes):\n", n);
else {
pr2ws("\nData-in buffer (first 1024 of %u bytes):\n", n);
n = 1024;
}
hex2stderr((const uint8_t *)dp, n, 0);
}
}
return 0;
}
/* see NVME MI document, NVMSR is NVM Subsystem Report */
static void
sg_snt_check_enclosure_override(struct sg_pt_linux_scsi * ptp, int vb)
{
uint8_t * up = ptp->nvme_id_ctlp;
uint8_t nvmsr;
if (NULL == up)
return;
nvmsr = up[253];
if (vb > 5)
pr2ws("%s: enter, nvmsr=%u\n", __func__, nvmsr);
ptp->dev_stat.id_ctl253 = nvmsr;
switch (ptp->dev_stat.enclosure_override) {
case 0x0: /* no override */
if (0x3 == (0x3 & nvmsr)) {
ptp->dev_stat.pdt = PDT_DISK;
ptp->dev_stat.enc_serv = 1;
} else if (0x2 & nvmsr) {
ptp->dev_stat.pdt = PDT_SES;
ptp->dev_stat.enc_serv = 1;
} else if (0x1 & nvmsr) {
ptp->dev_stat.pdt = PDT_DISK;
ptp->dev_stat.enc_serv = 0;
} else {
uint32_t nn = sg_get_unaligned_le32(up + 516);
ptp->dev_stat.pdt = nn ? PDT_DISK : PDT_UNKNOWN;
ptp->dev_stat.enc_serv = 0;
}
break;
case 0x1: /* override to SES device */
ptp->dev_stat.pdt = PDT_SES;
ptp->dev_stat.enc_serv = 1;
break;
case 0x2: /* override to disk with attached SES device */
ptp->dev_stat.pdt = PDT_DISK;
ptp->dev_stat.enc_serv = 1;
break;
case 0x3: /* override to SAFTE device (PDT_PROCESSOR) */
ptp->dev_stat.pdt = PDT_PROCESSOR;
ptp->dev_stat.enc_serv = 1;
break;
case 0xff: /* override to normal disk */
ptp->dev_stat.pdt = PDT_DISK;
ptp->dev_stat.enc_serv = 0;
break;
default:
pr2ws("%s: unknown enclosure_override value: %d\n", __func__,
ptp->dev_stat.enclosure_override);
break;
}
}
static int
sg_snt_do_identify(struct sg_pt_linux_scsi * ptp, int cns, int nsid,
int time_secs, int u_len, uint8_t * up, int vb)
{
struct sg_nvme_passthru_cmd cmd;
memset(&cmd, 0, sizeof(cmd));
cmd.opcode = SG_NVME_AD_IDENTIFY;
cmd.nsid = nsid;
cmd.cdw10 = cns;
cmd.addr = (uint64_t)(sg_uintptr_t)up;
cmd.data_len = u_len;
return sg_nvme_admin_cmd_f(ptp, &cmd, up, true, time_secs, vb);
}
/* Currently only caches associated identify controller response (4096 bytes).
* Returns 0 on success; otherwise a positive value is returned */
static int
sg_snt_cache_identify(struct sg_pt_linux_scsi * ptp, int time_secs, int vb)
{
int ret;
uint32_t pg_sz = sg_get_page_size();
uint8_t * up;
up = sg_memalign(pg_sz, pg_sz, &ptp->free_nvme_id_ctlp, false);
ptp->nvme_id_ctlp = up;
if (NULL == up) {
pr2ws("%s: sg_memalign() failed to get memory\n", __func__);
return sg_convert_errno(ENOMEM);
}
ret = sg_snt_do_identify(ptp, 0x1 /* CNS */, 0 /* nsid */, time_secs,
pg_sz, up, vb);
if (0 == ret)
sg_snt_check_enclosure_override(ptp, vb);
return (ret < 0) ? sg_convert_errno(-ret) : ret;
}
/* If nsid==0 then set cmdp->nsid to SG_NVME_BROADCAST_NSID. */
static int
sg_snt_get_features(struct sg_pt_linux_scsi * ptp, int feature_id,
int select, uint32_t nsid, uint64_t din_addr,
int time_secs, int vb)
{
int res;
struct sg_nvme_passthru_cmd cmd;
struct sg_nvme_passthru_cmd * cmdp = &cmd;
if (vb > 4)
pr2ws("%s: feature_id=0x%x, select=%d\n", __func__, feature_id,
select);
memset(cmdp, 0, sizeof(*cmdp));
cmdp->opcode = SG_NVME_AD_GET_FEATURE;
cmdp->nsid = nsid ? nsid : SG_NVME_BROADCAST_NSID;
select &= 0x7;
feature_id &= 0xff;
cmdp->cdw10 = (select << 8) | feature_id;
if (din_addr)
cmdp->addr = din_addr;
cmdp->timeout_ms = (time_secs < 0) ? 0 : (1000 * time_secs);
res = sg_nvme_admin_cmd_f(ptp, cmdp, NULL, false, time_secs, vb);
if (res)
return res;
ptp->os_err = 0;
ptp->nvme_status = 0;
return 0;
}
static int
sg_snt_set_features(struct sg_pt_linux_scsi * ptp, int feature_id,
bool save, uint32_t nsid, uint64_t dout_addr,
uint32_t cdw11, uint32_t cdw12, uint32_t cdw13,
uint32_t cdw15, int time_secs, int vb)
{
int res;
struct sg_nvme_passthru_cmd cmd;
struct sg_nvme_passthru_cmd * cmdp = &cmd;
if (vb > 4)
pr2ws("%s: feature_id=0x%x, save=%d\n", __func__, feature_id,
(int)save);
memset(cmdp, 0, sizeof(*cmdp));
cmdp->opcode = SG_NVME_AD_SET_FEATURE;
cmdp->nsid = nsid ? nsid : SG_NVME_BROADCAST_NSID;
cmdp->cdw10 = (feature_id & 0xff);
if (save)
cmdp->cdw10 |= (1 << 31); /* set bit 31 */
cmdp->cdw11 = cdw11;
cmdp->cdw12 = cdw12;
cmdp->cdw13 = cdw13;
cmdp->cdw14 = 0; /* no UUID support yet */
cmdp->cdw15 = cdw15;
if (dout_addr)
cmdp->addr = dout_addr;
cmdp->timeout_ms = (time_secs < 0) ? 0 : (1000 * time_secs);
res = sg_nvme_admin_cmd_f(ptp, cmdp, NULL, false, time_secs, vb);
if (res) {
if (SG_LIB_NVME_STATUS == res) {
mk_sense_from_nvme_status(ptp, vb);
return 0;
}
return res;
}
ptp->os_err = 0;
ptp->nvme_status = 0;
return 0;
}
static const uint16_t inq_resp_len = 74; /* want version descriptors */
static int
sg_ln_snt_inq(struct sg_pt_linux_scsi * ptp, const uint8_t * cdbp,
int time_secs, int vb)
{
bool evpd;
int res;
uint16_t n, alloc_len, pg_cd;
uint32_t pg_sz = sg_get_page_size();
uint8_t * nvme_id_ns = NULL;
uint8_t * free_nvme_id_ns = NULL;
uint8_t inq_dout[256];
if (vb > 5)
pr2ws("%s: time_secs=%d\n", __func__, time_secs);
if (0x2 & cdbp[1]) { /* Reject CmdDt=1 */
mk_sense_invalid_fld(ptp, true, 1, 1, vb);
return 0;
}
if (NULL == ptp->nvme_id_ctlp) {
res = sg_snt_cache_identify(ptp, time_secs, vb);
if (SG_LIB_NVME_STATUS == res) {
mk_sense_from_nvme_status(ptp, vb);
return 0;
} else if (res) /* should be negative errno */
return res;
}
alloc_len = sg_get_unaligned_be16(cdbp + 3);
evpd = !!(0x1 & cdbp[1]);
pg_cd = cdbp[2];
if (evpd) { /* VPD page responses */
bool cp_id_ctl = false;
memset(inq_dout, 0, sizeof(inq_dout));
switch (pg_cd) {
case 0:
/* inq_dout[0] = (PQ=0)<<5 | (PDT=0); prefer pdt=0xd --> SES */
inq_dout[1] = pg_cd;
n = 12;
sg_put_unaligned_be16(n - 4, inq_dout + 2);
inq_dout[4] = 0x0;
inq_dout[5] = 0x80;
inq_dout[6] = 0x83;
inq_dout[7] = 0x86;
inq_dout[8] = 0x87;
inq_dout[9] = 0x92;
inq_dout[10] = 0xb1;
inq_dout[n - 1] = SG_NVME_VPD_NICR; /* last VPD number */
break;
case 0x80:
/* inq_dout[0] = (PQ=0)<<5 | (PDT=0); prefer pdt=0xd --> SES */
inq_dout[1] = pg_cd;
n = 24;
sg_put_unaligned_be16(n - 4, inq_dout + 2);
memcpy(inq_dout + 4, ptp->nvme_id_ctlp + 4, 20); /* SN */
break;
case 0x83:
if ((ptp->nvme_nsid > 0) &&
(ptp->nvme_nsid < SG_NVME_BROADCAST_NSID)) {
nvme_id_ns = sg_memalign(pg_sz, pg_sz, &free_nvme_id_ns,
false);
if (nvme_id_ns) {
/* CNS=0x0 Identify namespace */
res = sg_snt_do_identify(ptp, 0x0, ptp->nvme_nsid,
time_secs, pg_sz, nvme_id_ns,
vb);
if (res) {
free(free_nvme_id_ns);
free_nvme_id_ns = NULL;
nvme_id_ns = NULL;
}
}
}
n = sg_make_vpd_devid_for_nvme(ptp->nvme_id_ctlp, nvme_id_ns,
0 /* pdt */, -1 /*tproto */,
inq_dout, sizeof(inq_dout));
if (n > 3)
sg_put_unaligned_be16(n - 4, inq_dout + 2);
if (free_nvme_id_ns) {
free(free_nvme_id_ns);
free_nvme_id_ns = NULL;
nvme_id_ns = NULL;
}
break;
case 0x86: /* Extended INQUIRY (per SFS SPC Discovery 2016) */
inq_dout[1] = pg_cd;
n = 64;
sg_put_unaligned_be16(n - 4, inq_dout + 2);
inq_dout[5] = 0x1; /* SIMPSUP=1 */
inq_dout[7] = 0x1; /* LUICLR=1 */
inq_dout[13] = 0x40; /* max supported sense data length */
break;
case 0x87: /* Mode page policy (per SFS SPC Discovery 2016) */
inq_dout[1] = pg_cd;
n = 8;
sg_put_unaligned_be16(n - 4, inq_dout + 2);
inq_dout[4] = 0x3f; /* all mode pages */
inq_dout[5] = 0xff; /* and their sub-pages */
inq_dout[6] = 0x80; /* MLUS=1, policy=shared */
break;
case 0x92: /* SCSI Feature set: only SPC Discovery 2016 */
inq_dout[1] = pg_cd;
n = 10;
sg_put_unaligned_be16(n - 4, inq_dout + 2);
inq_dout[9] = 0x1; /* SFS SPC Discovery 2016 */
break;
case 0xb1: /* Block Device Characteristics */
inq_dout[1] = pg_cd;
n = 64;
sg_put_unaligned_be16(n - 4, inq_dout + 2);
inq_dout[3] = 0x3c;
inq_dout[5] = 0x01;
break;
case SG_NVME_VPD_NICR: /* 0xde (vendor (sg3_utils) specific) */
/* 16 byte page header then NVME Identify controller response */
inq_dout[1] = pg_cd;
sg_put_unaligned_be16((16 + 4096) - 4, inq_dout + 2);
n = 16 + 4096;
cp_id_ctl = true;
break;
default: /* Point to page_code field in cdb */
mk_sense_invalid_fld(ptp, true, 2, 7, vb);
return 0;
}
if (alloc_len > 0) {
n = (alloc_len < n) ? alloc_len : n;
n = (n < ptp->io_hdr.din_xfer_len) ? n : ptp->io_hdr.din_xfer_len;
ptp->io_hdr.din_resid = ptp->io_hdr.din_xfer_len - n;
if (n > 0) {
uint8_t * dp = (uint8_t *)(sg_uintptr_t)ptp->io_hdr.din_xferp;
if (cp_id_ctl) {
memcpy(dp, inq_dout, (n < 16 ? n : 16));
if (n > 16)
memcpy(dp + 16, ptp->nvme_id_ctlp, n - 16);
} else
memcpy(dp, inq_dout, n);
}
}
} else { /* Standard INQUIRY response */
sg_snt_std_inq(ptp->nvme_id_ctlp, ptp->dev_stat.pdt,
ptp->dev_stat.enc_serv, inq_dout);
if (alloc_len > 0) {
n = (alloc_len < inq_resp_len) ? alloc_len : inq_resp_len;
n = (n < ptp->io_hdr.din_xfer_len) ? n : ptp->io_hdr.din_xfer_len;
ptp->io_hdr.din_resid = ptp->io_hdr.din_xfer_len - n;
if (n > 0)
memcpy((uint8_t *)(sg_uintptr_t)ptp->io_hdr.din_xferp,
inq_dout, n);
}
}
return 0;
}
static int
sg_snt_rluns(struct sg_pt_linux_scsi * ptp, const uint8_t * cdbp,
int time_secs, int vb)
{
int res;
uint16_t sel_report;
uint32_t alloc_len, k, n, num, max_nsid;
uint8_t * rl_doutp;
uint8_t * up;
if (vb > 5)
pr2ws("%s: time_secs=%d\n", __func__, time_secs);
sel_report = cdbp[2];
alloc_len = sg_get_unaligned_be32(cdbp + 6);
if (NULL == ptp->nvme_id_ctlp) {
res =sg_snt_cache_identify(ptp, time_secs, vb);
if (SG_LIB_NVME_STATUS == res) {
mk_sense_from_nvme_status(ptp, vb);
return 0;
} else if (res)
return res;
}
max_nsid = sg_get_unaligned_le32(ptp->nvme_id_ctlp + 516);
switch (sel_report) {
case 0:
case 2:
num = max_nsid;
break;
case 1:
case 0x10:
case 0x12:
num = 0;
break;
case 0x11:
num = (1 == ptp->nvme_nsid) ? max_nsid : 0;
break;
default:
if (vb > 1)
pr2ws("%s: bad select_report value: 0x%x\n", __func__,
sel_report);
mk_sense_invalid_fld(ptp, true, 2, 7, vb);
return 0;
}
rl_doutp = (uint8_t *)calloc(num + 1, 8);
if (NULL == rl_doutp) {
pr2ws("%s: calloc() failed to get memory\n", __func__);
return sg_convert_errno(ENOMEM);
}
for (k = 0, up = rl_doutp + 8; k < num; ++k, up += 8)
sg_put_unaligned_be16(k, up);
n = num * 8;
sg_put_unaligned_be32(n, rl_doutp);
n+= 8;
if (alloc_len > 0) {
n = (alloc_len < n) ? alloc_len : n;
n = (n < ptp->io_hdr.din_xfer_len) ? n : ptp->io_hdr.din_xfer_len;
ptp->io_hdr.din_resid = ptp->io_hdr.din_xfer_len - n;
if (n > 0)
memcpy((uint8_t *)(sg_uintptr_t)ptp->io_hdr.din_xferp, rl_doutp,
n);
}
res = 0;
free(rl_doutp);
return res;
}
static int
sg_snt_tur(struct sg_pt_linux_scsi * ptp, int time_secs, int vb)
{
int res;
uint32_t pow_state;
if (vb > 5)
pr2ws("%s: start\n", __func__);
if (NULL == ptp->nvme_id_ctlp) {
res = sg_snt_cache_identify(ptp, time_secs, vb);
if (SG_LIB_NVME_STATUS == res) {
mk_sense_from_nvme_status(ptp, vb);
return 0;
} else if (res)
return res;
}
res = sg_snt_get_features(ptp, 2 /* Power Management */, 0 /* current */,
0, 0, time_secs, vb);
if (0 != res) {
if (SG_LIB_NVME_STATUS == res) {
mk_sense_from_nvme_status(ptp, vb);
return 0;
} else
return res;
}
pow_state = (0x1f & ptp->nvme_result);
if (vb > 5)
pr2ws("%s: pow_state=%u\n", __func__, pow_state);
#if 0 /* pow_state bounces around too much on laptop */
if (pow_state)
mk_sense_asc_ascq(ptp, SPC_SK_NOT_READY, LOW_POWER_COND_ON_ASC, 0,
vb);
#endif
return 0;
}
static int
sg_snt_req_sense(struct sg_pt_linux_scsi * ptp, const uint8_t * cdbp,
int time_secs, int vb)
{
bool desc;
int res;
uint32_t pow_state, alloc_len, n;
uint8_t rs_dout[64];
if (vb > 5)
pr2ws("%s: time_secs=%d\n", __func__, time_secs);
if (NULL == ptp->nvme_id_ctlp) {
res = sg_snt_cache_identify(ptp, time_secs, vb);
if (SG_LIB_NVME_STATUS == res) {
mk_sense_from_nvme_status(ptp, vb);
return 0;
} else if (res)
return res;
}
desc = !!(0x1 & cdbp[1]);
alloc_len = cdbp[4];
res = sg_snt_get_features(ptp, 0x2 /* Power Management */,
0 /* current */, 0, 0, time_secs, vb);
if (0 != res) {
if (SG_LIB_NVME_STATUS == res) {
mk_sense_from_nvme_status(ptp, vb);
return 0;
} else
return res;
}
ptp->io_hdr.response_len = 0;
pow_state = (0x1f & ptp->nvme_result);
if (vb > 5)
pr2ws("%s: pow_state=%u\n", __func__, pow_state);
memset(rs_dout, 0, sizeof(rs_dout));
if (pow_state)
sg_build_sense_buffer(desc, rs_dout, SPC_SK_NO_SENSE,
LOW_POWER_COND_ON_ASC, 0);
else
sg_build_sense_buffer(desc, rs_dout, SPC_SK_NO_SENSE,
NO_ADDITIONAL_SENSE, 0);
n = desc ? 8 : 18;
n = (n < alloc_len) ? n : alloc_len;
n = (n < ptp->io_hdr.din_xfer_len) ? n : ptp->io_hdr.din_xfer_len;
ptp->io_hdr.din_resid = ptp->io_hdr.din_xfer_len - n;
if (n > 0)
memcpy((uint8_t *)(sg_uintptr_t)ptp->io_hdr.din_xferp, rs_dout, n);
return 0;
}
static uint8_t pc_t10_2_select[] = {0, 3, 1, 2};
/* For MODE SENSE(10) and MODE SELECT(10). 6 byte variants not supported */
static int
sg_snt_mode_ss(struct sg_pt_linux_scsi * ptp, const uint8_t * cdbp,
int time_secs, int vb)
{
bool is_msense = (SCSI_MODE_SENSE10_OPC == cdbp[0]);
int res, n, len;
uint8_t * bp;
struct sg_snt_result_t sg_snt_result;
if (vb > 5)
pr2ws("%s: mode se%s\n", __func__, (is_msense ? "nse" : "lect"));
if (NULL == ptp->nvme_id_ctlp) {
res = sg_snt_cache_identify(ptp, time_secs, vb);
if (SG_LIB_NVME_STATUS == res) {
mk_sense_from_nvme_status(ptp, vb);
return 0;
} else if (res)
return res;
}
if (is_msense) { /* MODE SENSE(10) */
uint8_t pc_t10 = (cdbp[2] >> 6) & 0x3;
int mp_t10 = (cdbp[2] & 0x3f);
if ((0x3f == mp_t10) || (0x8 /* caching mpage */ == mp_t10)) {
/* 0x6 is "Volatile write cache" feature id */
res = sg_snt_get_features(ptp, 0x6, pc_t10_2_select[pc_t10], 0,
0, time_secs, vb);
if (0 != res) {
if (SG_LIB_NVME_STATUS == res) {
mk_sense_from_nvme_status(ptp, vb);
return 0;
} else
return res;
}
ptp->dev_stat.wce = !!(0x1 & ptp->nvme_result);
}
len = ptp->io_hdr.din_xfer_len;
bp = (uint8_t *)(sg_uintptr_t)ptp->io_hdr.din_xferp;
n = sg_snt_resp_mode_sense10(&ptp->dev_stat, cdbp, bp, len,
&sg_snt_result);
ptp->io_hdr.din_resid = (n >= 0) ? len - n : len;
} else { /* MODE SELECT(10) */
bool sp = !!(0x1 & cdbp[1]); /* Save Page indication */
uint8_t pre_enc_ov = ptp->dev_stat.enclosure_override;
len = ptp->io_hdr.dout_xfer_len;
bp = (uint8_t *)(sg_uintptr_t)ptp->io_hdr.dout_xferp;
ptp->dev_stat.wce_changed = false;
n = sg_snt_resp_mode_select10(&ptp->dev_stat, cdbp, bp, len,
&sg_snt_result);
if (ptp->dev_stat.wce_changed) {
/* feature_id=0x6 for "volatile write cache" */
res = sg_snt_set_features(ptp, 0x6, sp, ptp->nvme_nsid, 0,
ptp->dev_stat.wce, 0, 0, 0, time_secs,
vb);
if (res)
return res;
}
if (pre_enc_ov != ptp->dev_stat.enclosure_override)
sg_snt_check_enclosure_override(ptp, vb);/* ENC_OV has changed */
}
if (n < 0) {
int in_bit = (255 == sg_snt_result.in_bit) ?
(int)sg_snt_result.in_bit : -1;
if ((SAM_STAT_CHECK_CONDITION == sg_snt_result.sstatus) &&
(SPC_SK_ILLEGAL_REQUEST == sg_snt_result.sk)) {
if (INVALID_FIELD_IN_CDB == sg_snt_result.asc)
mk_sense_invalid_fld(ptp, true, sg_snt_result.in_byte, in_bit,
vb);
else if (INVALID_FIELD_IN_PARAM_LIST == sg_snt_result.asc)
mk_sense_invalid_fld(ptp, false, sg_snt_result.in_byte, in_bit,
vb);
else
mk_sense_asc_ascq(ptp, sg_snt_result.sk, sg_snt_result.asc,
sg_snt_result.ascq, vb);
} else
pr2ws("%s: error but no sense?? n=%d\n", __func__, n);
}
return 0;
}
/* This is not really a SNTL. For SCSI SEND DIAGNOSTIC(PF=1) NVMe-MI
* has a special command (SES Send) to tunnel through pages to an
* enclosure. The NVMe enclosure is meant to understand the SES
* (SCSI Enclosure Services) use of diagnostics pages that are
* related to SES. */
static int
sg_snt_senddiag(struct sg_pt_linux_scsi * ptp, const uint8_t * cdbp,
int time_secs, int vb)
{
bool pf, self_test;
int res;
uint8_t st_cd, dpg_cd;
uint32_t alloc_len, n, dout_len, dpg_len;
const uint32_t pg_sz = sg_get_page_size();
uint8_t * dop;
struct sg_nvme_passthru_cmd cmd;
uint8_t * cmd_up = (uint8_t *)&cmd;
st_cd = 0x7 & (cdbp[1] >> 5);
self_test = !! (0x4 & cdbp[1]);
pf = !! (0x10 & cdbp[1]);
if (vb > 5)
pr2ws("%s: pf=%d, self_test=%d (st_code=%d)\n", __func__, (int)pf,
(int)self_test, (int)st_cd);
if (self_test || st_cd) {
uint32_t nvme_dst;
memset(cmd_up, 0, sizeof(cmd));
cmd_up[SG_NVME_OPCODE] = SG_NVME_AD_DEV_SELT_TEST;
/* just this namespace (if there is one) and controller */
sg_put_unaligned_le32(ptp->nvme_nsid, cmd_up + SG_NVME_NSID);
switch (st_cd) {
case 0: /* Here if self_test is set, do short self-test */
case 1: /* Background short */
case 5: /* Foreground short */
nvme_dst = 1;
break;
case 2: /* Background extended */
case 6: /* Foreground extended */
nvme_dst = 2;
break;
case 4: /* Abort self-test */
nvme_dst = 0xf;