1 /*- 2 * Copyright (C) 2012-2013 Intel Corporation 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 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. 13 * 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 24 * SUCH DAMAGE. 25 */ 26 27 #include <sys/cdefs.h> 28 __FBSDID("$FreeBSD$"); 29 30 #include <sys/param.h> 31 #include <sys/ioccom.h> 32 #include <sys/stat.h> 33 34 #include <ctype.h> 35 #include <err.h> 36 #include <errno.h> 37 #include <fcntl.h> 38 #include <paths.h> 39 #include <stdbool.h> 40 #include <stddef.h> 41 #include <stdio.h> 42 #include <stdlib.h> 43 #include <string.h> 44 #include <unistd.h> 45 46 #include "nvmecontrol.h" 47 48 typedef void (*nvme_fn_t)(int argc, char *argv[]); 49 50 static struct nvme_function { 51 const char *name; 52 nvme_fn_t fn; 53 const char *usage; 54 } funcs[] = { 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}, 61 {"power", power, POWER_USAGE}, 62 {NULL, NULL, NULL}, 63 }; 64 65 static void 66 usage(void) 67 { 68 struct nvme_function *f; 69 70 f = funcs; 71 fprintf(stderr, "usage:\n"); 72 while (f->name != NULL) { 73 fprintf(stderr, "%s", f->usage); 74 f++; 75 } 76 exit(1); 77 } 78 79 static void 80 print_bytes(void *data, uint32_t length) 81 { 82 uint32_t i, j; 83 uint8_t *p, *end; 84 85 end = (uint8_t *)data + length; 86 87 for (i = 0; i < length; i++) { 88 p = (uint8_t *)data + (i*16); 89 printf("%03x: ", i*16); 90 for (j = 0; j < 16 && p < end; j++) 91 printf("%02x ", *p++); 92 if (p >= end) 93 break; 94 printf("\n"); 95 } 96 printf("\n"); 97 } 98 99 static void 100 print_dwords(void *data, uint32_t length) 101 { 102 uint32_t *p; 103 uint32_t i, j; 104 105 p = (uint32_t *)data; 106 length /= sizeof(uint32_t); 107 108 for (i = 0; i < length; i+=8) { 109 printf("%03x: ", i*4); 110 for (j = 0; j < 8; j++) 111 printf("%08x ", p[i+j]); 112 printf("\n"); 113 } 114 115 printf("\n"); 116 } 117 118 void 119 print_hex(void *data, uint32_t length) 120 { 121 if (length >= sizeof(uint32_t) || length % sizeof(uint32_t) == 0) 122 print_dwords(data, length); 123 else 124 print_bytes(data, length); 125 } 126 127 void 128 read_controller_data(int fd, struct nvme_controller_data *cdata) 129 { 130 struct nvme_pt_command pt; 131 132 memset(&pt, 0, sizeof(pt)); 133 pt.cmd.opc = NVME_OPC_IDENTIFY; 134 pt.cmd.cdw10 = 1; 135 pt.buf = cdata; 136 pt.len = sizeof(*cdata); 137 pt.is_read = 1; 138 139 if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0) 140 err(1, "identify request failed"); 141 142 if (nvme_completion_is_error(&pt.cpl)) 143 errx(1, "identify request returned error"); 144 } 145 146 void 147 read_namespace_data(int fd, int nsid, struct nvme_namespace_data *nsdata) 148 { 149 struct nvme_pt_command pt; 150 151 memset(&pt, 0, sizeof(pt)); 152 pt.cmd.opc = NVME_OPC_IDENTIFY; 153 pt.cmd.nsid = nsid; 154 pt.buf = nsdata; 155 pt.len = sizeof(*nsdata); 156 pt.is_read = 1; 157 158 if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0) 159 err(1, "identify request failed"); 160 161 if (nvme_completion_is_error(&pt.cpl)) 162 errx(1, "identify request returned error"); 163 } 164 165 int 166 open_dev(const char *str, int *fd, int show_error, int exit_on_error) 167 { 168 char full_path[64]; 169 170 if (!strnstr(str, NVME_CTRLR_PREFIX, strlen(NVME_CTRLR_PREFIX))) { 171 if (show_error) 172 warnx("controller/namespace ids must begin with '%s'", 173 NVME_CTRLR_PREFIX); 174 if (exit_on_error) 175 exit(1); 176 else 177 return (EINVAL); 178 } 179 180 snprintf(full_path, sizeof(full_path), _PATH_DEV"%s", str); 181 *fd = open(full_path, O_RDWR); 182 if (*fd < 0) { 183 if (show_error) 184 warn("could not open %s", full_path); 185 if (exit_on_error) 186 exit(1); 187 else 188 return (errno); 189 } 190 191 return (0); 192 } 193 194 void 195 parse_ns_str(const char *ns_str, char *ctrlr_str, int *nsid) 196 { 197 char *nsloc; 198 199 /* 200 * Pull the namespace id from the string. +2 skips past the "ns" part 201 * of the string. Don't search past 10 characters into the string, 202 * otherwise we know it is malformed. 203 */ 204 nsloc = strnstr(ns_str, NVME_NS_PREFIX, 10); 205 if (nsloc != NULL) 206 *nsid = strtol(nsloc + 2, NULL, 10); 207 if (nsloc == NULL || (*nsid == 0 && errno != 0)) 208 errx(1, "invalid namespace ID '%s'", ns_str); 209 210 /* 211 * The controller string will include only the nvmX part of the 212 * nvmeXnsY string. 213 */ 214 snprintf(ctrlr_str, nsloc - ns_str + 1, "%s", ns_str); 215 } 216 217 int 218 main(int argc, char *argv[]) 219 { 220 struct nvme_function *f; 221 222 if (argc < 2) 223 usage(); 224 225 f = funcs; 226 while (f->name != NULL) { 227 if (strcmp(argv[1], f->name) == 0) 228 f->fn(argc-1, &argv[1]); 229 f++; 230 } 231 232 usage(); 233 234 return (0); 235 } 236