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 49 static struct nvme_function funcs[] = { 50 {"devlist", devlist, DEVLIST_USAGE}, 51 {"identify", identify, IDENTIFY_USAGE}, 52 {"perftest", perftest, PERFTEST_USAGE}, 53 {"reset", reset, RESET_USAGE}, 54 {"logpage", logpage, LOGPAGE_USAGE}, 55 {"firmware", firmware, FIRMWARE_USAGE}, 56 {"power", power, POWER_USAGE}, 57 {"wdc", wdc, WDC_USAGE}, 58 {NULL, NULL, NULL}, 59 }; 60 61 void 62 gen_usage(struct nvme_function *f) 63 { 64 65 fprintf(stderr, "usage:\n"); 66 while (f->name != NULL) { 67 fprintf(stderr, "%s", f->usage); 68 f++; 69 } 70 exit(1); 71 } 72 73 void 74 dispatch(int argc, char *argv[], struct nvme_function *tbl) 75 { 76 struct nvme_function *f = tbl; 77 78 while (f->name != NULL) { 79 if (strcmp(argv[1], f->name) == 0) 80 f->fn(argc-1, &argv[1]); 81 f++; 82 } 83 84 fprintf(stderr, "Unknown command: %s\n", argv[1]); 85 gen_usage(tbl); 86 } 87 88 static void 89 print_bytes(void *data, uint32_t length) 90 { 91 uint32_t i, j; 92 uint8_t *p, *end; 93 94 end = (uint8_t *)data + length; 95 96 for (i = 0; i < length; i++) { 97 p = (uint8_t *)data + (i*16); 98 printf("%03x: ", i*16); 99 for (j = 0; j < 16 && p < end; j++) 100 printf("%02x ", *p++); 101 if (p >= end) 102 break; 103 printf("\n"); 104 } 105 printf("\n"); 106 } 107 108 static void 109 print_dwords(void *data, uint32_t length) 110 { 111 uint32_t *p; 112 uint32_t i, j; 113 114 p = (uint32_t *)data; 115 length /= sizeof(uint32_t); 116 117 for (i = 0; i < length; i+=8) { 118 printf("%03x: ", i*4); 119 for (j = 0; j < 8; j++) 120 printf("%08x ", p[i+j]); 121 printf("\n"); 122 } 123 124 printf("\n"); 125 } 126 127 void 128 print_hex(void *data, uint32_t length) 129 { 130 if (length >= sizeof(uint32_t) || length % sizeof(uint32_t) == 0) 131 print_dwords(data, length); 132 else 133 print_bytes(data, length); 134 } 135 136 void 137 read_controller_data(int fd, struct nvme_controller_data *cdata) 138 { 139 struct nvme_pt_command pt; 140 141 memset(&pt, 0, sizeof(pt)); 142 pt.cmd.opc = NVME_OPC_IDENTIFY; 143 pt.cmd.cdw10 = 1; 144 pt.buf = cdata; 145 pt.len = sizeof(*cdata); 146 pt.is_read = 1; 147 148 if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0) 149 err(1, "identify request failed"); 150 151 if (nvme_completion_is_error(&pt.cpl)) 152 errx(1, "identify request returned error"); 153 } 154 155 void 156 read_namespace_data(int fd, int nsid, struct nvme_namespace_data *nsdata) 157 { 158 struct nvme_pt_command pt; 159 160 memset(&pt, 0, sizeof(pt)); 161 pt.cmd.opc = NVME_OPC_IDENTIFY; 162 pt.cmd.nsid = nsid; 163 pt.buf = nsdata; 164 pt.len = sizeof(*nsdata); 165 pt.is_read = 1; 166 167 if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0) 168 err(1, "identify request failed"); 169 170 if (nvme_completion_is_error(&pt.cpl)) 171 errx(1, "identify request returned error"); 172 } 173 174 int 175 open_dev(const char *str, int *fd, int show_error, int exit_on_error) 176 { 177 char full_path[64]; 178 179 if (!strnstr(str, NVME_CTRLR_PREFIX, strlen(NVME_CTRLR_PREFIX))) { 180 if (show_error) 181 warnx("controller/namespace ids must begin with '%s'", 182 NVME_CTRLR_PREFIX); 183 if (exit_on_error) 184 exit(1); 185 else 186 return (EINVAL); 187 } 188 189 snprintf(full_path, sizeof(full_path), _PATH_DEV"%s", str); 190 *fd = open(full_path, O_RDWR); 191 if (*fd < 0) { 192 if (show_error) 193 warn("could not open %s", full_path); 194 if (exit_on_error) 195 exit(1); 196 else 197 return (errno); 198 } 199 200 return (0); 201 } 202 203 void 204 parse_ns_str(const char *ns_str, char *ctrlr_str, int *nsid) 205 { 206 char *nsloc; 207 208 /* 209 * Pull the namespace id from the string. +2 skips past the "ns" part 210 * of the string. Don't search past 10 characters into the string, 211 * otherwise we know it is malformed. 212 */ 213 nsloc = strnstr(ns_str, NVME_NS_PREFIX, 10); 214 if (nsloc != NULL) 215 *nsid = strtol(nsloc + 2, NULL, 10); 216 if (nsloc == NULL || (*nsid == 0 && errno != 0)) 217 errx(1, "invalid namespace ID '%s'", ns_str); 218 219 /* 220 * The controller string will include only the nvmX part of the 221 * nvmeXnsY string. 222 */ 223 snprintf(ctrlr_str, nsloc - ns_str + 1, "%s", ns_str); 224 } 225 226 int 227 main(int argc, char *argv[]) 228 { 229 230 if (argc < 2) 231 gen_usage(funcs); 232 233 dispatch(argc, argv, funcs); 234 235 return (0); 236 } 237