1240620Sjimharris/*- 2252654Sjimharris * Copyright (C) 2012-2013 Intel Corporation 3240620Sjimharris * All rights reserved. 4240620Sjimharris * 5240620Sjimharris * Redistribution and use in source and binary forms, with or without 6240620Sjimharris * modification, are permitted provided that the following conditions 7240620Sjimharris * are met: 8240620Sjimharris * 1. Redistributions of source code must retain the above copyright 9240620Sjimharris * notice, this list of conditions and the following disclaimer. 10240620Sjimharris * 2. Redistributions in binary form must reproduce the above copyright 11240620Sjimharris * notice, this list of conditions and the following disclaimer in the 12240620Sjimharris * documentation and/or other materials provided with the distribution. 13240620Sjimharris * 14240620Sjimharris * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15240620Sjimharris * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16240620Sjimharris * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17240620Sjimharris * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18240620Sjimharris * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19240620Sjimharris * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20240620Sjimharris * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21240620Sjimharris * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22240620Sjimharris * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23240620Sjimharris * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24240620Sjimharris * SUCH DAMAGE. 25240620Sjimharris */ 26240620Sjimharris 27240620Sjimharris#include <sys/cdefs.h> 28240620Sjimharris__FBSDID("$FreeBSD$"); 29240620Sjimharris 30240620Sjimharris#include <sys/param.h> 31240620Sjimharris#include <sys/ioccom.h> 32240620Sjimharris#include <sys/stat.h> 33240620Sjimharris 34240620Sjimharris#include <ctype.h> 35253298Sjimharris#include <err.h> 36253300Sjimharris#include <errno.h> 37240620Sjimharris#include <fcntl.h> 38253628Sjimharris#include <paths.h> 39240620Sjimharris#include <stdbool.h> 40240620Sjimharris#include <stddef.h> 41240620Sjimharris#include <stdio.h> 42240620Sjimharris#include <stdlib.h> 43240620Sjimharris#include <string.h> 44240620Sjimharris#include <unistd.h> 45240620Sjimharris 46252656Sjimharris#include "nvmecontrol.h" 47240620Sjimharris 48252662Sjimharristypedef void (*nvme_fn_t)(int argc, char *argv[]); 49252662Sjimharris 50252662Sjimharrisstatic struct nvme_function { 51252662Sjimharris const char *name; 52252662Sjimharris nvme_fn_t fn; 53252662Sjimharris const char *usage; 54252662Sjimharris} funcs[] = { 55252662Sjimharris {"devlist", devlist, DEVLIST_USAGE}, 56252662Sjimharris {"identify", identify, IDENTIFY_USAGE}, 57252662Sjimharris {"perftest", perftest, PERFTEST_USAGE}, 58252662Sjimharris {"reset", reset, RESET_USAGE}, 59252670Sjimharris {"logpage", logpage, LOGPAGE_USAGE}, 60252671Sjimharris {"firmware", firmware, FIRMWARE_USAGE}, 61252662Sjimharris {NULL, NULL, NULL}, 62252662Sjimharris}; 63252662Sjimharris 64240620Sjimharrisstatic void 65240620Sjimharrisusage(void) 66240620Sjimharris{ 67252662Sjimharris struct nvme_function *f; 68252662Sjimharris 69252662Sjimharris f = funcs; 70240620Sjimharris fprintf(stderr, "usage:\n"); 71252662Sjimharris while (f->name != NULL) { 72252662Sjimharris fprintf(stderr, "%s", f->usage); 73252662Sjimharris f++; 74252662Sjimharris } 75253298Sjimharris exit(1); 76240620Sjimharris} 77240620Sjimharris 78252669Sjimharrisstatic void 79252669Sjimharrisprint_bytes(void *data, uint32_t length) 80252669Sjimharris{ 81252669Sjimharris uint32_t i, j; 82252669Sjimharris uint8_t *p, *end; 83252669Sjimharris 84252669Sjimharris end = (uint8_t *)data + length; 85252669Sjimharris 86252669Sjimharris for (i = 0; i < length; i++) { 87252669Sjimharris p = (uint8_t *)data + (i*16); 88252669Sjimharris printf("%03x: ", i*16); 89252669Sjimharris for (j = 0; j < 16 && p < end; j++) 90252669Sjimharris printf("%02x ", *p++); 91252669Sjimharris if (p >= end) 92252669Sjimharris break; 93252669Sjimharris printf("\n"); 94252669Sjimharris } 95252669Sjimharris printf("\n"); 96252669Sjimharris} 97252669Sjimharris 98252669Sjimharrisstatic void 99252669Sjimharrisprint_dwords(void *data, uint32_t length) 100252669Sjimharris{ 101252669Sjimharris uint32_t *p; 102252669Sjimharris uint32_t i, j; 103252669Sjimharris 104252669Sjimharris p = (uint32_t *)data; 105252669Sjimharris length /= sizeof(uint32_t); 106252669Sjimharris 107252669Sjimharris for (i = 0; i < length; i+=8) { 108252669Sjimharris printf("%03x: ", i*4); 109252669Sjimharris for (j = 0; j < 8; j++) 110252669Sjimharris printf("%08x ", p[i+j]); 111252669Sjimharris printf("\n"); 112252669Sjimharris } 113252669Sjimharris 114252669Sjimharris printf("\n"); 115252669Sjimharris} 116252669Sjimharris 117252656Sjimharrisvoid 118252669Sjimharrisprint_hex(void *data, uint32_t length) 119252669Sjimharris{ 120252669Sjimharris if (length >= sizeof(uint32_t) || length % sizeof(uint32_t) == 0) 121252669Sjimharris print_dwords(data, length); 122252669Sjimharris else 123252669Sjimharris print_bytes(data, length); 124252669Sjimharris} 125252669Sjimharris 126252669Sjimharrisvoid 127252222Sjimharrisread_controller_data(int fd, struct nvme_controller_data *cdata) 128252222Sjimharris{ 129252222Sjimharris struct nvme_pt_command pt; 130240620Sjimharris 131252222Sjimharris memset(&pt, 0, sizeof(pt)); 132252222Sjimharris pt.cmd.opc = NVME_OPC_IDENTIFY; 133252222Sjimharris pt.cmd.cdw10 = 1; 134252222Sjimharris pt.buf = cdata; 135252222Sjimharris pt.len = sizeof(*cdata); 136252222Sjimharris pt.is_read = 1; 137252222Sjimharris 138253298Sjimharris if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0) 139253298Sjimharris err(1, "identify request failed"); 140252222Sjimharris 141253298Sjimharris if (nvme_completion_is_error(&pt.cpl)) 142253298Sjimharris errx(1, "identify request returned error"); 143252222Sjimharris} 144252222Sjimharris 145252656Sjimharrisvoid 146252222Sjimharrisread_namespace_data(int fd, int nsid, struct nvme_namespace_data *nsdata) 147252222Sjimharris{ 148252222Sjimharris struct nvme_pt_command pt; 149252222Sjimharris 150252222Sjimharris memset(&pt, 0, sizeof(pt)); 151252222Sjimharris pt.cmd.opc = NVME_OPC_IDENTIFY; 152252222Sjimharris pt.cmd.nsid = nsid; 153252222Sjimharris pt.buf = nsdata; 154252222Sjimharris pt.len = sizeof(*nsdata); 155252222Sjimharris pt.is_read = 1; 156252222Sjimharris 157253298Sjimharris if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0) 158253298Sjimharris err(1, "identify request failed"); 159252222Sjimharris 160253298Sjimharris if (nvme_completion_is_error(&pt.cpl)) 161253298Sjimharris errx(1, "identify request returned error"); 162252222Sjimharris} 163252222Sjimharris 164252656Sjimharrisint 165252654Sjimharrisopen_dev(const char *str, int *fd, int show_error, int exit_on_error) 166252654Sjimharris{ 167252654Sjimharris char full_path[64]; 168252654Sjimharris 169252667Sjimharris if (!strnstr(str, NVME_CTRLR_PREFIX, strlen(NVME_CTRLR_PREFIX))) { 170252667Sjimharris if (show_error) 171253298Sjimharris warnx("controller/namespace ids must begin with '%s'", 172252667Sjimharris NVME_CTRLR_PREFIX); 173252667Sjimharris if (exit_on_error) 174253298Sjimharris exit(1); 175252667Sjimharris else 176253625Sjimharris return (EINVAL); 177252667Sjimharris } 178252667Sjimharris 179253628Sjimharris snprintf(full_path, sizeof(full_path), _PATH_DEV"%s", str); 180252654Sjimharris *fd = open(full_path, O_RDWR); 181252654Sjimharris if (*fd < 0) { 182252654Sjimharris if (show_error) 183253298Sjimharris warn("could not open %s", full_path); 184252654Sjimharris if (exit_on_error) 185253298Sjimharris exit(1); 186252654Sjimharris else 187253625Sjimharris return (errno); 188252654Sjimharris } 189252654Sjimharris 190253298Sjimharris return (0); 191252654Sjimharris} 192252654Sjimharris 193253300Sjimharrisvoid 194253300Sjimharrisparse_ns_str(const char *ns_str, char *ctrlr_str, int *nsid) 195253300Sjimharris{ 196253300Sjimharris char *nsloc; 197253300Sjimharris 198253300Sjimharris /* 199253300Sjimharris * Pull the namespace id from the string. +2 skips past the "ns" part 200253300Sjimharris * of the string. Don't search past 10 characters into the string, 201253300Sjimharris * otherwise we know it is malformed. 202253300Sjimharris */ 203253300Sjimharris nsloc = strnstr(ns_str, NVME_NS_PREFIX, 10); 204253300Sjimharris if (nsloc != NULL) 205253300Sjimharris *nsid = strtol(nsloc + 2, NULL, 10); 206253300Sjimharris if (nsloc == NULL || (*nsid == 0 && errno != 0)) 207253300Sjimharris errx(1, "invalid namespace ID '%s'", ns_str); 208253300Sjimharris 209253300Sjimharris /* 210253300Sjimharris * The controller string will include only the nvmX part of the 211253300Sjimharris * nvmeXnsY string. 212253300Sjimharris */ 213253300Sjimharris snprintf(ctrlr_str, nsloc - ns_str + 1, "%s", ns_str); 214253300Sjimharris} 215253300Sjimharris 216240620Sjimharrisint 217240620Sjimharrismain(int argc, char *argv[]) 218240620Sjimharris{ 219252662Sjimharris struct nvme_function *f; 220240620Sjimharris 221240620Sjimharris if (argc < 2) 222240620Sjimharris usage(); 223240620Sjimharris 224252662Sjimharris f = funcs; 225252662Sjimharris while (f->name != NULL) { 226252662Sjimharris if (strcmp(argv[1], f->name) == 0) 227252662Sjimharris f->fn(argc-1, &argv[1]); 228252662Sjimharris f++; 229252662Sjimharris } 230240620Sjimharris 231240620Sjimharris usage(); 232240620Sjimharris 233240620Sjimharris return (0); 234240620Sjimharris} 235252223Sjimharris 236