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
|
#include <machine/rtems-bsd-user-space.h>
/*-
* Copyright (c) 2017 Netflix, Inc
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
#include <sys/cdefs.h>
__FBSDID("$FreeBSD$");
#include <sys/param.h>
#include <sys/ioccom.h>
#include <sys/endian.h>
#include <ctype.h>
#include <err.h>
#include <fcntl.h>
#include <stddef.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include "nvmecontrol.h"
#define WDC_NVME_TOC_SIZE 8
#define WDC_NVME_CAP_DIAG_OPCODE 0xe6
#define WDC_NVME_CAP_DIAG_CMD 0x0000
static void wdc_cap_diag(int argc, char *argv[]);
#define WDC_CAP_DIAG_USAGE "\tnvmecontrol wdc cap-diag [-o path-template]\n"
static struct nvme_function wdc_funcs[] = {
{"cap-diag", wdc_cap_diag, WDC_CAP_DIAG_USAGE},
{NULL, NULL, NULL},
};
static void
wdc_append_serial_name(int fd, char *buf, size_t len, const char *suffix)
{
struct nvme_controller_data cdata;
char sn[NVME_SERIAL_NUMBER_LENGTH + 1];
char *walker;
len -= strlen(buf);
buf += strlen(buf);
read_controller_data(fd, &cdata);
memcpy(sn, cdata.sn, NVME_SERIAL_NUMBER_LENGTH);
walker = sn + NVME_SERIAL_NUMBER_LENGTH - 1;
while (walker > sn && *walker == ' ')
walker--;
*++walker = '\0';
snprintf(buf, len, "%s%s.bin", sn, suffix);
}
static void
wdc_get_data(int fd, uint32_t opcode, uint32_t len, uint32_t off, uint32_t cmd,
uint8_t *buffer, size_t buflen)
{
struct nvme_pt_command pt;
memset(&pt, 0, sizeof(pt));
pt.cmd.opc = opcode;
pt.cmd.cdw10 = htole32(len / sizeof(uint32_t)); /* - 1 like all the others ??? */
pt.cmd.cdw11 = htole32(off / sizeof(uint32_t));
pt.cmd.cdw12 = htole32(cmd);
pt.buf = buffer;
pt.len = buflen;
pt.is_read = 1;
// printf("opcode %#x cdw10(len) %#x cdw11(offset?) %#x cdw12(cmd/sub) %#x buflen %zd\n",
// (int)opcode, (int)cdw10, (int)cdw11, (int)cdw12, buflen);
if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0)
err(1, "wdc_get_data request failed");
if (nvme_completion_is_error(&pt.cpl))
errx(1, "wdc_get_data request returned error");
}
static void
wdc_do_dump(int fd, char *tmpl, const char *suffix, uint32_t opcode,
uint32_t cmd, int len_off)
{
int first;
int fd2;
uint8_t *buf;
uint32_t len, offset;
size_t resid;
wdc_append_serial_name(fd, tmpl, MAXPATHLEN, suffix);
/* XXX overwrite protection? */
fd2 = open(tmpl, O_WRONLY | O_CREAT | O_TRUNC, 0644);
if (fd2 < 0)
err(1, "open %s", tmpl);
buf = aligned_alloc(PAGE_SIZE, NVME_MAX_XFER_SIZE);
if (buf == NULL)
errx(1, "Can't get buffer to read dump");
offset = 0;
len = NVME_MAX_XFER_SIZE;
first = 1;
do {
resid = len > NVME_MAX_XFER_SIZE ? NVME_MAX_XFER_SIZE : len;
wdc_get_data(fd, opcode, resid, offset, cmd, buf, resid);
if (first) {
len = be32dec(buf + len_off);
if (len == 0)
errx(1, "No data for %s", suffix);
if (memcmp("E6LG", buf, 4) != 0)
printf("Expected header of E6LG, found '%4.4s' instead\n",
buf);
printf("Dumping %d bytes of version %d.%d log to %s\n", len,
buf[8], buf[9], tmpl);
/*
* Adjust amount to dump if total dump < 1MB,
* though it likely doesn't matter to the WDC
* analysis tools.
*/
if (resid > len)
resid = len;
first = 0;
}
if (write(fd2, buf, resid) != (ssize_t)resid)
err(1, "write");
offset += resid;
len -= resid;
} while (len > 0);
free(buf);
close(fd2);
}
static void
wdc_cap_diag_usage(void)
{
fprintf(stderr, "usage:\n");
fprintf(stderr, WDC_CAP_DIAG_USAGE);
exit(1);
}
static void
wdc_cap_diag(int argc, char *argv[])
{
char path_tmpl[MAXPATHLEN];
int ch, fd;
path_tmpl[0] = '\0';
while ((ch = getopt(argc, argv, "o:")) != -1) {
switch ((char)ch) {
case 'o':
strlcpy(path_tmpl, optarg, MAXPATHLEN);
break;
default:
wdc_cap_diag_usage();
}
}
/* Check that a controller was specified. */
if (optind >= argc)
wdc_cap_diag_usage();
open_dev(argv[optind], &fd, 1, 1);
wdc_do_dump(fd, path_tmpl, "cap_diag", WDC_NVME_CAP_DIAG_OPCODE,
WDC_NVME_CAP_DIAG_CMD, 4);
close(fd);
exit(1);
}
void
wdc(int argc, char *argv[])
{
dispatch(argc, argv, wdc_funcs);
}
|
