1240620Sjimharris/*- 2252263Sjimharris * 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> 35253109Sjimharris#include <err.h> 36253114Sjimharris#include <errno.h> 37240620Sjimharris#include <fcntl.h> 38253459Sjimharris#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 46252265Sjimharris#include "nvmecontrol.h" 47240620Sjimharris 48252269Sjimharristypedef void (*nvme_fn_t)(int argc, char *argv[]); 49252269Sjimharris 50252302Sglebiusstatic struct nvme_function { 51252269Sjimharris const char *name; 52252269Sjimharris nvme_fn_t fn; 53252269Sjimharris const char *usage; 54252269Sjimharris} funcs[] = { 55252269Sjimharris {"devlist", devlist, DEVLIST_USAGE}, 56252269Sjimharris {"identify", identify, IDENTIFY_USAGE}, 57252269Sjimharris {"perftest", perftest, PERFTEST_USAGE}, 58252269Sjimharris {"reset", reset, RESET_USAGE}, 59252277Sjimharris {"logpage", logpage, LOGPAGE_USAGE}, 60252278Sjimharris {"firmware", firmware, FIRMWARE_USAGE}, 61252269Sjimharris {NULL, NULL, NULL}, 62252269Sjimharris}; 63252269Sjimharris 64240620Sjimharrisstatic void 65240620Sjimharrisusage(void) 66240620Sjimharris{ 67252269Sjimharris struct nvme_function *f; 68252269Sjimharris 69252269Sjimharris f = funcs; 70240620Sjimharris fprintf(stderr, "usage:\n"); 71252269Sjimharris while (f->name != NULL) { 72252269Sjimharris fprintf(stderr, "%s", f->usage); 73252269Sjimharris f++; 74252269Sjimharris } 75253109Sjimharris exit(1); 76240620Sjimharris} 77240620Sjimharris 78252275Sjimharrisstatic void 79252275Sjimharrisprint_bytes(void *data, uint32_t length) 80252275Sjimharris{ 81252275Sjimharris uint32_t i, j; 82252275Sjimharris uint8_t *p, *end; 83252275Sjimharris 84252275Sjimharris end = (uint8_t *)data + length; 85252275Sjimharris 86252275Sjimharris for (i = 0; i < length; i++) { 87252275Sjimharris p = (uint8_t *)data + (i*16); 88252275Sjimharris printf("%03x: ", i*16); 89252275Sjimharris for (j = 0; j < 16 && p < end; j++) 90252275Sjimharris printf("%02x ", *p++); 91252275Sjimharris if (p >= end) 92252275Sjimharris break; 93252275Sjimharris printf("\n"); 94252275Sjimharris } 95252275Sjimharris printf("\n"); 96252275Sjimharris} 97252275Sjimharris 98252275Sjimharrisstatic void 99252275Sjimharrisprint_dwords(void *data, uint32_t length) 100252275Sjimharris{ 101252275Sjimharris uint32_t *p; 102252275Sjimharris uint32_t i, j; 103252275Sjimharris 104252275Sjimharris p = (uint32_t *)data; 105252275Sjimharris length /= sizeof(uint32_t); 106252275Sjimharris 107252275Sjimharris for (i = 0; i < length; i+=8) { 108252275Sjimharris printf("%03x: ", i*4); 109252275Sjimharris for (j = 0; j < 8; j++) 110252275Sjimharris printf("%08x ", p[i+j]); 111252275Sjimharris printf("\n"); 112252275Sjimharris } 113252275Sjimharris 114252275Sjimharris printf("\n"); 115252275Sjimharris} 116252275Sjimharris 117252265Sjimharrisvoid 118252275Sjimharrisprint_hex(void *data, uint32_t length) 119252275Sjimharris{ 120252275Sjimharris if (length >= sizeof(uint32_t) || length % sizeof(uint32_t) == 0) 121252275Sjimharris print_dwords(data, length); 122252275Sjimharris else 123252275Sjimharris print_bytes(data, length); 124252275Sjimharris} 125252275Sjimharris 126252275Sjimharrisvoid 127249422Sjimharrisread_controller_data(int fd, struct nvme_controller_data *cdata) 128249422Sjimharris{ 129249422Sjimharris struct nvme_pt_command pt; 130240620Sjimharris 131249422Sjimharris memset(&pt, 0, sizeof(pt)); 132249422Sjimharris pt.cmd.opc = NVME_OPC_IDENTIFY; 133249422Sjimharris pt.cmd.cdw10 = 1; 134249422Sjimharris pt.buf = cdata; 135249422Sjimharris pt.len = sizeof(*cdata); 136249422Sjimharris pt.is_read = 1; 137249422Sjimharris 138253109Sjimharris if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0) 139253109Sjimharris err(1, "identify request failed"); 140249422Sjimharris 141253109Sjimharris if (nvme_completion_is_error(&pt.cpl)) 142253109Sjimharris errx(1, "identify request returned error"); 143249422Sjimharris} 144249422Sjimharris 145252265Sjimharrisvoid 146249422Sjimharrisread_namespace_data(int fd, int nsid, struct nvme_namespace_data *nsdata) 147249422Sjimharris{ 148249422Sjimharris struct nvme_pt_command pt; 149249422Sjimharris 150249422Sjimharris memset(&pt, 0, sizeof(pt)); 151249422Sjimharris pt.cmd.opc = NVME_OPC_IDENTIFY; 152249422Sjimharris pt.cmd.nsid = nsid; 153249422Sjimharris pt.buf = nsdata; 154249422Sjimharris pt.len = sizeof(*nsdata); 155249422Sjimharris pt.is_read = 1; 156249422Sjimharris 157253109Sjimharris if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0) 158253109Sjimharris err(1, "identify request failed"); 159249422Sjimharris 160253109Sjimharris if (nvme_completion_is_error(&pt.cpl)) 161253109Sjimharris errx(1, "identify request returned error"); 162249422Sjimharris} 163249422Sjimharris 164252265Sjimharrisint 165252263Sjimharrisopen_dev(const char *str, int *fd, int show_error, int exit_on_error) 166252263Sjimharris{ 167252263Sjimharris char full_path[64]; 168252263Sjimharris 169252274Sjimharris if (!strnstr(str, NVME_CTRLR_PREFIX, strlen(NVME_CTRLR_PREFIX))) { 170252274Sjimharris if (show_error) 171253109Sjimharris warnx("controller/namespace ids must begin with '%s'", 172252274Sjimharris NVME_CTRLR_PREFIX); 173252274Sjimharris if (exit_on_error) 174253109Sjimharris exit(1); 175252274Sjimharris else 176253458Sjimharris return (EINVAL); 177252274Sjimharris } 178252274Sjimharris 179253459Sjimharris snprintf(full_path, sizeof(full_path), _PATH_DEV"%s", str); 180252263Sjimharris *fd = open(full_path, O_RDWR); 181252263Sjimharris if (*fd < 0) { 182252263Sjimharris if (show_error) 183253109Sjimharris warn("could not open %s", full_path); 184252263Sjimharris if (exit_on_error) 185253109Sjimharris exit(1); 186252263Sjimharris else 187253458Sjimharris return (errno); 188252263Sjimharris } 189252263Sjimharris 190253109Sjimharris return (0); 191252263Sjimharris} 192252263Sjimharris 193253114Sjimharrisvoid 194253114Sjimharrisparse_ns_str(const char *ns_str, char *ctrlr_str, int *nsid) 195253114Sjimharris{ 196253114Sjimharris char *nsloc; 197253114Sjimharris 198253114Sjimharris /* 199253114Sjimharris * Pull the namespace id from the string. +2 skips past the "ns" part 200253114Sjimharris * of the string. Don't search past 10 characters into the string, 201253114Sjimharris * otherwise we know it is malformed. 202253114Sjimharris */ 203253114Sjimharris nsloc = strnstr(ns_str, NVME_NS_PREFIX, 10); 204253114Sjimharris if (nsloc != NULL) 205253114Sjimharris *nsid = strtol(nsloc + 2, NULL, 10); 206253114Sjimharris if (nsloc == NULL || (*nsid == 0 && errno != 0)) 207253114Sjimharris errx(1, "invalid namespace ID '%s'", ns_str); 208253114Sjimharris 209253114Sjimharris /* 210253114Sjimharris * The controller string will include only the nvmX part of the 211253114Sjimharris * nvmeXnsY string. 212253114Sjimharris */ 213253114Sjimharris snprintf(ctrlr_str, nsloc - ns_str + 1, "%s", ns_str); 214253114Sjimharris} 215253114Sjimharris 216240620Sjimharrisint 217240620Sjimharrismain(int argc, char *argv[]) 218240620Sjimharris{ 219252269Sjimharris struct nvme_function *f; 220240620Sjimharris 221240620Sjimharris if (argc < 2) 222240620Sjimharris usage(); 223240620Sjimharris 224252269Sjimharris f = funcs; 225252269Sjimharris while (f->name != NULL) { 226252269Sjimharris if (strcmp(argv[1], f->name) == 0) 227252269Sjimharris f->fn(argc-1, &argv[1]); 228252269Sjimharris f++; 229252269Sjimharris } 230240620Sjimharris 231240620Sjimharris usage(); 232240620Sjimharris 233240620Sjimharris return (0); 234240620Sjimharris} 235