2 * Copyright (C) 2012-2013 Intel Corporation
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include <sys/param.h>
31 #include <sys/ioccom.h>
46 #include "nvmecontrol.h"
48 typedef void (*nvme_fn_t)(int argc, char *argv[]);
50 static struct nvme_function {
55 {"devlist", devlist, DEVLIST_USAGE},
56 {"identify", identify, IDENTIFY_USAGE},
57 {"perftest", perftest, PERFTEST_USAGE},
58 {"reset", reset, RESET_USAGE},
59 {"logpage", logpage, LOGPAGE_USAGE},
60 {"firmware", firmware, FIRMWARE_USAGE},
67 struct nvme_function *f;
70 fprintf(stderr, "usage:\n");
71 while (f->name != NULL) {
72 fprintf(stderr, "%s", f->usage);
79 print_bytes(void *data, uint32_t length)
84 end = (uint8_t *)data + length;
86 for (i = 0; i < length; i++) {
87 p = (uint8_t *)data + (i*16);
88 printf("%03x: ", i*16);
89 for (j = 0; j < 16 && p < end; j++)
90 printf("%02x ", *p++);
99 print_dwords(void *data, uint32_t length)
104 p = (uint32_t *)data;
105 length /= sizeof(uint32_t);
107 for (i = 0; i < length; i+=8) {
108 printf("%03x: ", i*4);
109 for (j = 0; j < 8; j++)
110 printf("%08x ", p[i+j]);
118 print_hex(void *data, uint32_t length)
120 if (length >= sizeof(uint32_t) || length % sizeof(uint32_t) == 0)
121 print_dwords(data, length);
123 print_bytes(data, length);
127 read_controller_data(int fd, struct nvme_controller_data *cdata)
129 struct nvme_pt_command pt;
131 memset(&pt, 0, sizeof(pt));
132 pt.cmd.opc = NVME_OPC_IDENTIFY;
135 pt.len = sizeof(*cdata);
138 if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0)
139 err(1, "identify request failed");
141 if (nvme_completion_is_error(&pt.cpl))
142 errx(1, "identify request returned error");
146 read_namespace_data(int fd, int nsid, struct nvme_namespace_data *nsdata)
148 struct nvme_pt_command pt;
150 memset(&pt, 0, sizeof(pt));
151 pt.cmd.opc = NVME_OPC_IDENTIFY;
154 pt.len = sizeof(*nsdata);
157 if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0)
158 err(1, "identify request failed");
160 if (nvme_completion_is_error(&pt.cpl))
161 errx(1, "identify request returned error");
165 open_dev(const char *str, int *fd, int show_error, int exit_on_error)
169 if (!strnstr(str, NVME_CTRLR_PREFIX, strlen(NVME_CTRLR_PREFIX))) {
171 warnx("controller/namespace ids must begin with '%s'",
179 snprintf(full_path, sizeof(full_path), _PATH_DEV"%s", str);
180 *fd = open(full_path, O_RDWR);
183 warn("could not open %s", full_path);
194 parse_ns_str(const char *ns_str, char *ctrlr_str, int *nsid)
199 * Pull the namespace id from the string. +2 skips past the "ns" part
200 * of the string. Don't search past 10 characters into the string,
201 * otherwise we know it is malformed.
203 nsloc = strnstr(ns_str, NVME_NS_PREFIX, 10);
205 *nsid = strtol(nsloc + 2, NULL, 10);
206 if (nsloc == NULL || (*nsid == 0 && errno != 0))
207 errx(1, "invalid namespace ID '%s'", ns_str);
210 * The controller string will include only the nvmX part of the
213 snprintf(ctrlr_str, nsloc - ns_str + 1, "%s", ns_str);
217 main(int argc, char *argv[])
219 struct nvme_function *f;
225 while (f->name != NULL) {
226 if (strcmp(argv[1], f->name) == 0)
227 f->fn(argc-1, &argv[1]);