1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (C) 2012-2013 Intel Corporation 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 */ 28 29 #include <sys/cdefs.h> 30 __FBSDID("$FreeBSD$"); 31 32 #include <sys/param.h> 33 #include <sys/ioccom.h> 34 #include <sys/stat.h> 35 36 #include <ctype.h> 37 #include <err.h> 38 #include <errno.h> 39 #include <fcntl.h> 40 #include <paths.h> 41 #include <stdbool.h> 42 #include <stddef.h> 43 #include <stdio.h> 44 #include <stdlib.h> 45 #include <string.h> 46 #include <unistd.h> 47 48 #include "nvmecontrol.h" 49 50 51 static struct nvme_function funcs[] = { 52 {"devlist", devlist, DEVLIST_USAGE}, 53 {"identify", identify, IDENTIFY_USAGE}, 54 {"perftest", perftest, PERFTEST_USAGE}, 55 {"reset", reset, RESET_USAGE}, 56 {"logpage", logpage, LOGPAGE_USAGE}, 57 {"firmware", firmware, FIRMWARE_USAGE}, 58 {"format", format, FORMAT_USAGE}, 59 {"power", power, POWER_USAGE}, 60 {"wdc", wdc, WDC_USAGE}, 61 {NULL, NULL, NULL}, 62 }; 63 64 void 65 gen_usage(struct nvme_function *f) 66 { 67 68 fprintf(stderr, "usage:\n"); 69 while (f->name != NULL) { 70 fprintf(stderr, "%s", f->usage); 71 f++; 72 } 73 exit(1); 74 } 75 76 void 77 dispatch(int argc, char *argv[], struct nvme_function *tbl) 78 { 79 struct nvme_function *f = tbl; 80 81 if (argv[1] == NULL) { 82 gen_usage(tbl); 83 return; 84 } 85 86 while (f->name != NULL) { 87 if (strcmp(argv[1], f->name) == 0) 88 f->fn(argc-1, &argv[1]); 89 f++; 90 } 91 92 fprintf(stderr, "Unknown command: %s\n", argv[1]); 93 gen_usage(tbl); 94 } 95 96 static void 97 print_bytes(void *data, uint32_t length) 98 { 99 uint32_t i, j; 100 uint8_t *p, *end; 101 102 end = (uint8_t *)data + length; 103 104 for (i = 0; i < length; i++) { 105 p = (uint8_t *)data + (i*16); 106 printf("%03x: ", i*16); 107 for (j = 0; j < 16 && p < end; j++) 108 printf("%02x ", *p++); 109 if (p >= end) 110 break; 111 printf("\n"); 112 } 113 printf("\n"); 114 } 115 116 static void 117 print_dwords(void *data, uint32_t length) 118 { 119 uint32_t *p; 120 uint32_t i, j; 121 122 p = (uint32_t *)data; 123 length /= sizeof(uint32_t); 124 125 for (i = 0; i < length; i+=8) { 126 printf("%03x: ", i*4); 127 for (j = 0; j < 8; j++) 128 printf("%08x ", p[i+j]); 129 printf("\n"); 130 } 131 132 printf("\n"); 133 } 134 135 void 136 print_hex(void *data, uint32_t length) 137 { 138 if (length >= sizeof(uint32_t) || length % sizeof(uint32_t) == 0) 139 print_dwords(data, length); 140 else 141 print_bytes(data, length); 142 } 143 144 void 145 read_controller_data(int fd, struct nvme_controller_data *cdata) 146 { 147 struct nvme_pt_command pt; 148 149 memset(&pt, 0, sizeof(pt)); 150 pt.cmd.opc_fuse = NVME_CMD_SET_OPC(NVME_OPC_IDENTIFY); 151 pt.cmd.cdw10 = htole32(1); 152 pt.buf = cdata; 153 pt.len = sizeof(*cdata); 154 pt.is_read = 1; 155 156 if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0) 157 err(1, "identify request failed"); 158 159 /* Convert data to host endian */ 160 nvme_controller_data_swapbytes(cdata); 161 162 if (nvme_completion_is_error(&pt.cpl)) 163 errx(1, "identify request returned error"); 164 } 165 166 void 167 read_namespace_data(int fd, uint32_t nsid, struct nvme_namespace_data *nsdata) 168 { 169 struct nvme_pt_command pt; 170 171 memset(&pt, 0, sizeof(pt)); 172 pt.cmd.opc_fuse = NVME_CMD_SET_OPC(NVME_OPC_IDENTIFY); 173 pt.cmd.nsid = htole32(nsid); 174 pt.buf = nsdata; 175 pt.len = sizeof(*nsdata); 176 pt.is_read = 1; 177 178 if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0) 179 err(1, "identify request failed"); 180 181 /* Convert data to host endian */ 182 nvme_namespace_data_swapbytes(nsdata); 183 184 if (nvme_completion_is_error(&pt.cpl)) 185 errx(1, "identify request returned error"); 186 } 187 188 int 189 open_dev(const char *str, int *fd, int show_error, int exit_on_error) 190 { 191 char full_path[64]; 192 193 if (!strnstr(str, NVME_CTRLR_PREFIX, strlen(NVME_CTRLR_PREFIX))) { 194 if (show_error) 195 warnx("controller/namespace ids must begin with '%s'", 196 NVME_CTRLR_PREFIX); 197 if (exit_on_error) 198 exit(1); 199 else 200 return (EINVAL); 201 } 202 203 snprintf(full_path, sizeof(full_path), _PATH_DEV"%s", str); 204 *fd = open(full_path, O_RDWR); 205 if (*fd < 0) { 206 if (show_error) 207 warn("could not open %s", full_path); 208 if (exit_on_error) 209 exit(1); 210 else 211 return (errno); 212 } 213 214 return (0); 215 } 216 217 void 218 parse_ns_str(const char *ns_str, char *ctrlr_str, uint32_t *nsid) 219 { 220 char *nsloc; 221 222 /* 223 * Pull the namespace id from the string. +2 skips past the "ns" part 224 * of the string. Don't search past 10 characters into the string, 225 * otherwise we know it is malformed. 226 */ 227 nsloc = strnstr(ns_str, NVME_NS_PREFIX, 10); 228 if (nsloc != NULL) 229 *nsid = strtol(nsloc + 2, NULL, 10); 230 if (nsloc == NULL || (*nsid == 0 && errno != 0)) 231 errx(1, "invalid namespace ID '%s'", ns_str); 232 233 /* 234 * The controller string will include only the nvmX part of the 235 * nvmeXnsY string. 236 */ 237 snprintf(ctrlr_str, nsloc - ns_str + 1, "%s", ns_str); 238 } 239 240 int 241 main(int argc, char *argv[]) 242 { 243 244 if (argc < 2) 245 gen_usage(funcs); 246 247 dispatch(argc, argv, funcs); 248 249 return (0); 250 } 251