16f0823e4SJim Harris /*- 26f0823e4SJim Harris * Copyright (C) 2012-2013 Intel Corporation 36f0823e4SJim Harris * All rights reserved. 46f0823e4SJim Harris * 56f0823e4SJim Harris * Redistribution and use in source and binary forms, with or without 66f0823e4SJim Harris * modification, are permitted provided that the following conditions 76f0823e4SJim Harris * are met: 86f0823e4SJim Harris * 1. Redistributions of source code must retain the above copyright 96f0823e4SJim Harris * notice, this list of conditions and the following disclaimer. 106f0823e4SJim Harris * 2. Redistributions in binary form must reproduce the above copyright 116f0823e4SJim Harris * notice, this list of conditions and the following disclaimer in the 126f0823e4SJim Harris * documentation and/or other materials provided with the distribution. 136f0823e4SJim Harris * 146f0823e4SJim Harris * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 156f0823e4SJim Harris * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 166f0823e4SJim Harris * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 176f0823e4SJim Harris * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 186f0823e4SJim Harris * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 196f0823e4SJim Harris * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 206f0823e4SJim Harris * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 216f0823e4SJim Harris * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 226f0823e4SJim Harris * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 236f0823e4SJim Harris * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 246f0823e4SJim Harris * SUCH DAMAGE. 256f0823e4SJim Harris */ 266f0823e4SJim Harris 276f0823e4SJim Harris #include <sys/cdefs.h> 286f0823e4SJim Harris __FBSDID("$FreeBSD$"); 296f0823e4SJim Harris 306f0823e4SJim Harris #include <sys/param.h> 316f0823e4SJim Harris 326f0823e4SJim Harris #include <ctype.h> 33821ef73cSJim Harris #include <err.h> 346f0823e4SJim Harris #include <errno.h> 356f0823e4SJim Harris #include <fcntl.h> 366f0823e4SJim Harris #include <stddef.h> 376f0823e4SJim Harris #include <stdio.h> 386f0823e4SJim Harris #include <stdlib.h> 396f0823e4SJim Harris #include <string.h> 406f0823e4SJim Harris #include <unistd.h> 416f0823e4SJim Harris 426f0823e4SJim Harris #include "nvmecontrol.h" 436f0823e4SJim Harris 446f0823e4SJim Harris static void 456f0823e4SJim Harris print_controller(struct nvme_controller_data *cdata) 466f0823e4SJim Harris { 476f0823e4SJim Harris printf("Controller Capabilities/Features\n"); 486f0823e4SJim Harris printf("================================\n"); 496f0823e4SJim Harris printf("Vendor ID: %04x\n", cdata->vid); 506f0823e4SJim Harris printf("Subsystem Vendor ID: %04x\n", cdata->ssvid); 516f0823e4SJim Harris printf("Serial Number: %s\n", cdata->sn); 526f0823e4SJim Harris printf("Model Number: %s\n", cdata->mn); 536f0823e4SJim Harris printf("Firmware Version: %s\n", cdata->fr); 546f0823e4SJim Harris printf("Recommended Arb Burst: %d\n", cdata->rab); 556f0823e4SJim Harris printf("IEEE OUI Identifier: %02x %02x %02x\n", 566f0823e4SJim Harris cdata->ieee[0], cdata->ieee[1], cdata->ieee[2]); 576f0823e4SJim Harris printf("Multi-Interface Cap: %02x\n", cdata->mic); 586f0823e4SJim Harris /* TODO: Use CAP.MPSMIN to determine true memory page size. */ 596f0823e4SJim Harris printf("Max Data Transfer Size: "); 606f0823e4SJim Harris if (cdata->mdts == 0) 616f0823e4SJim Harris printf("Unlimited\n"); 626f0823e4SJim Harris else 636f0823e4SJim Harris printf("%d\n", PAGE_SIZE * (1 << cdata->mdts)); 646f0823e4SJim Harris printf("\n"); 656f0823e4SJim Harris 666f0823e4SJim Harris printf("Admin Command Set Attributes\n"); 676f0823e4SJim Harris printf("============================\n"); 686f0823e4SJim Harris printf("Security Send/Receive: %s\n", 696f0823e4SJim Harris cdata->oacs.security ? "Supported" : "Not Supported"); 706f0823e4SJim Harris printf("Format NVM: %s\n", 716f0823e4SJim Harris cdata->oacs.format ? "Supported" : "Not Supported"); 726f0823e4SJim Harris printf("Firmware Activate/Download: %s\n", 736f0823e4SJim Harris cdata->oacs.firmware ? "Supported" : "Not Supported"); 746f0823e4SJim Harris printf("Abort Command Limit: %d\n", cdata->acl+1); 756f0823e4SJim Harris printf("Async Event Request Limit: %d\n", cdata->aerl+1); 766f0823e4SJim Harris printf("Number of Firmware Slots: "); 776f0823e4SJim Harris if (cdata->oacs.firmware != 0) 786f0823e4SJim Harris printf("%d\n", cdata->frmw.num_slots); 796f0823e4SJim Harris else 806f0823e4SJim Harris printf("N/A\n"); 816f0823e4SJim Harris printf("Firmware Slot 1 Read-Only: "); 826f0823e4SJim Harris if (cdata->oacs.firmware != 0) 836f0823e4SJim Harris printf("%s\n", cdata->frmw.slot1_ro ? "Yes" : "No"); 846f0823e4SJim Harris else 856f0823e4SJim Harris printf("N/A\n"); 866f0823e4SJim Harris printf("Per-Namespace SMART Log: %s\n", 876f0823e4SJim Harris cdata->lpa.ns_smart ? "Yes" : "No"); 886f0823e4SJim Harris printf("Error Log Page Entries: %d\n", cdata->elpe+1); 896f0823e4SJim Harris printf("Number of Power States: %d\n", cdata->npss+1); 906f0823e4SJim Harris printf("\n"); 916f0823e4SJim Harris 926f0823e4SJim Harris printf("NVM Command Set Attributes\n"); 936f0823e4SJim Harris printf("==========================\n"); 946f0823e4SJim Harris printf("Submission Queue Entry Size\n"); 956f0823e4SJim Harris printf(" Max: %d\n", 1 << cdata->sqes.max); 966f0823e4SJim Harris printf(" Min: %d\n", 1 << cdata->sqes.min); 976f0823e4SJim Harris printf("Completion Queue Entry Size\n"); 986f0823e4SJim Harris printf(" Max: %d\n", 1 << cdata->cqes.max); 996f0823e4SJim Harris printf(" Min: %d\n", 1 << cdata->cqes.min); 1006f0823e4SJim Harris printf("Number of Namespaces: %d\n", cdata->nn); 1016f0823e4SJim Harris printf("Compare Command: %s\n", 1026f0823e4SJim Harris cdata->oncs.compare ? "Supported" : "Not Supported"); 1036f0823e4SJim Harris printf("Write Uncorrectable Command: %s\n", 1046f0823e4SJim Harris cdata->oncs.write_unc ? "Supported" : "Not Supported"); 1056f0823e4SJim Harris printf("Dataset Management Command: %s\n", 1066f0823e4SJim Harris cdata->oncs.dsm ? "Supported" : "Not Supported"); 1076f0823e4SJim Harris printf("Volatile Write Cache: %s\n", 1086f0823e4SJim Harris cdata->vwc.present ? "Present" : "Not Present"); 1096f0823e4SJim Harris } 1106f0823e4SJim Harris 1116f0823e4SJim Harris static void 1126f0823e4SJim Harris print_namespace(struct nvme_namespace_data *nsdata) 1136f0823e4SJim Harris { 1146f0823e4SJim Harris uint32_t i; 1156f0823e4SJim Harris 1166f0823e4SJim Harris printf("Size (in LBAs): %lld (%lldM)\n", 1176f0823e4SJim Harris (long long)nsdata->nsze, 1186f0823e4SJim Harris (long long)nsdata->nsze / 1024 / 1024); 1196f0823e4SJim Harris printf("Capacity (in LBAs): %lld (%lldM)\n", 1206f0823e4SJim Harris (long long)nsdata->ncap, 1216f0823e4SJim Harris (long long)nsdata->ncap / 1024 / 1024); 1226f0823e4SJim Harris printf("Utilization (in LBAs): %lld (%lldM)\n", 1236f0823e4SJim Harris (long long)nsdata->nuse, 1246f0823e4SJim Harris (long long)nsdata->nuse / 1024 / 1024); 1256f0823e4SJim Harris printf("Thin Provisioning: %s\n", 1266f0823e4SJim Harris nsdata->nsfeat.thin_prov ? "Supported" : "Not Supported"); 1276f0823e4SJim Harris printf("Number of LBA Formats: %d\n", nsdata->nlbaf+1); 1286f0823e4SJim Harris printf("Current LBA Format: LBA Format #%d\n", 1296f0823e4SJim Harris nsdata->flbas.format); 1306f0823e4SJim Harris for (i = 0; i <= nsdata->nlbaf; i++) { 1316f0823e4SJim Harris printf("LBA Format #%d:\n", i); 1326f0823e4SJim Harris printf(" LBA Data Size: %d\n", 1336f0823e4SJim Harris 1 << nsdata->lbaf[i].lbads); 1346f0823e4SJim Harris } 1356f0823e4SJim Harris } 1366f0823e4SJim Harris 1376f0823e4SJim Harris static void 1386f0823e4SJim Harris identify_usage(void) 1396f0823e4SJim Harris { 1406f0823e4SJim Harris fprintf(stderr, "usage:\n"); 1416f0823e4SJim Harris fprintf(stderr, IDENTIFY_USAGE); 142821ef73cSJim Harris exit(1); 1436f0823e4SJim Harris } 1446f0823e4SJim Harris 1456f0823e4SJim Harris static void 1466f0823e4SJim Harris identify_ctrlr(int argc, char *argv[]) 1476f0823e4SJim Harris { 1486f0823e4SJim Harris struct nvme_controller_data cdata; 1496f0823e4SJim Harris int ch, fd, hexflag = 0, hexlength; 1506f0823e4SJim Harris int verboseflag = 0; 1516f0823e4SJim Harris 1526f0823e4SJim Harris while ((ch = getopt(argc, argv, "vx")) != -1) { 1536f0823e4SJim Harris switch ((char)ch) { 1546f0823e4SJim Harris case 'v': 1556f0823e4SJim Harris verboseflag = 1; 1566f0823e4SJim Harris break; 1576f0823e4SJim Harris case 'x': 1586f0823e4SJim Harris hexflag = 1; 1596f0823e4SJim Harris break; 1606f0823e4SJim Harris default: 1616f0823e4SJim Harris identify_usage(); 1626f0823e4SJim Harris } 1636f0823e4SJim Harris } 1646f0823e4SJim Harris 165d2cdb28bSJim Harris /* Check that a controller was specified. */ 166d2cdb28bSJim Harris if (optind >= argc) 167d2cdb28bSJim Harris identify_usage(); 168d2cdb28bSJim Harris 1696f0823e4SJim Harris open_dev(argv[optind], &fd, 1, 1); 1706f0823e4SJim Harris read_controller_data(fd, &cdata); 1716f0823e4SJim Harris close(fd); 1726f0823e4SJim Harris 1736f0823e4SJim Harris if (hexflag == 1) { 1746f0823e4SJim Harris if (verboseflag == 1) 1756f0823e4SJim Harris hexlength = sizeof(struct nvme_controller_data); 1766f0823e4SJim Harris else 1776f0823e4SJim Harris hexlength = offsetof(struct nvme_controller_data, 1786f0823e4SJim Harris reserved5); 179e83c9e35SJim Harris print_hex(&cdata, hexlength); 180821ef73cSJim Harris exit(0); 1816f0823e4SJim Harris } 1826f0823e4SJim Harris 1836f0823e4SJim Harris if (verboseflag == 1) { 184821ef73cSJim Harris fprintf(stderr, "-v not currently supported without -x\n"); 1856f0823e4SJim Harris identify_usage(); 1866f0823e4SJim Harris } 1876f0823e4SJim Harris 1886f0823e4SJim Harris print_controller(&cdata); 189821ef73cSJim Harris exit(0); 1906f0823e4SJim Harris } 1916f0823e4SJim Harris 1926f0823e4SJim Harris static void 1936f0823e4SJim Harris identify_ns(int argc, char *argv[]) 1946f0823e4SJim Harris { 1956f0823e4SJim Harris struct nvme_namespace_data nsdata; 1966f0823e4SJim Harris char path[64]; 1976f0823e4SJim Harris char *nsloc; 1986f0823e4SJim Harris int ch, fd, hexflag = 0, hexlength, nsid; 1996f0823e4SJim Harris int verboseflag = 0; 2006f0823e4SJim Harris 2016f0823e4SJim Harris while ((ch = getopt(argc, argv, "vx")) != -1) { 2026f0823e4SJim Harris switch ((char)ch) { 2036f0823e4SJim Harris case 'v': 2046f0823e4SJim Harris verboseflag = 1; 2056f0823e4SJim Harris break; 2066f0823e4SJim Harris case 'x': 2076f0823e4SJim Harris hexflag = 1; 2086f0823e4SJim Harris break; 2096f0823e4SJim Harris default: 2106f0823e4SJim Harris identify_usage(); 2116f0823e4SJim Harris } 2126f0823e4SJim Harris } 2136f0823e4SJim Harris 214d2cdb28bSJim Harris /* Check that a namespace was specified. */ 215d2cdb28bSJim Harris if (optind >= argc) 216d2cdb28bSJim Harris identify_usage(); 217d2cdb28bSJim Harris 2186f0823e4SJim Harris /* 2196f0823e4SJim Harris * Check if the specified device node exists before continuing. 2206f0823e4SJim Harris * This is a cleaner check for cases where the correct controller 2216f0823e4SJim Harris * is specified, but an invalid namespace on that controller. 2226f0823e4SJim Harris */ 2236f0823e4SJim Harris open_dev(argv[optind], &fd, 1, 1); 2246f0823e4SJim Harris close(fd); 2256f0823e4SJim Harris 2266f0823e4SJim Harris /* 2276f0823e4SJim Harris * Pull the namespace id from the string. +2 skips past the "ns" part 2286f0823e4SJim Harris * of the string. Don't search past 10 characters into the string, 2296f0823e4SJim Harris * otherwise we know it is malformed. 2306f0823e4SJim Harris */ 2316420873cSJim Harris nsloc = strnstr(argv[optind], NVME_NS_PREFIX, 10); 2326f0823e4SJim Harris if (nsloc != NULL) 2336f0823e4SJim Harris nsid = strtol(nsloc + 2, NULL, 10); 234821ef73cSJim Harris if (nsloc == NULL || (nsid == 0 && errno != 0)) 235821ef73cSJim Harris errx(1, "invalid namespace ID '%s'", argv[optind]); 2366f0823e4SJim Harris 2376f0823e4SJim Harris /* 2386f0823e4SJim Harris * We send IDENTIFY commands to the controller, not the namespace, 2396f0823e4SJim Harris * since it is an admin cmd. So the path should only include the 2406f0823e4SJim Harris * nvmeX part of the nvmeXnsY string. 2416f0823e4SJim Harris */ 2426f0823e4SJim Harris snprintf(path, nsloc - argv[optind] + 1, "%s", argv[optind]); 2436f0823e4SJim Harris open_dev(path, &fd, 1, 1); 2446f0823e4SJim Harris read_namespace_data(fd, nsid, &nsdata); 2456f0823e4SJim Harris close(fd); 2466f0823e4SJim Harris 2476f0823e4SJim Harris if (hexflag == 1) { 2486f0823e4SJim Harris if (verboseflag == 1) 2496f0823e4SJim Harris hexlength = sizeof(struct nvme_namespace_data); 2506f0823e4SJim Harris else 2516f0823e4SJim Harris hexlength = offsetof(struct nvme_namespace_data, 2526f0823e4SJim Harris reserved6); 253e83c9e35SJim Harris print_hex(&nsdata, hexlength); 254821ef73cSJim Harris exit(0); 2556f0823e4SJim Harris } 2566f0823e4SJim Harris 2576f0823e4SJim Harris if (verboseflag == 1) { 258821ef73cSJim Harris fprintf(stderr, "-v not currently supported without -x\n"); 2596f0823e4SJim Harris identify_usage(); 2606f0823e4SJim Harris } 2616f0823e4SJim Harris 2626f0823e4SJim Harris print_namespace(&nsdata); 263821ef73cSJim Harris exit(0); 2646f0823e4SJim Harris } 2656f0823e4SJim Harris 2666f0823e4SJim Harris void 2676f0823e4SJim Harris identify(int argc, char *argv[]) 2686f0823e4SJim Harris { 2696f0823e4SJim Harris char *target; 2706f0823e4SJim Harris 2716f0823e4SJim Harris if (argc < 2) 2726f0823e4SJim Harris identify_usage(); 2736f0823e4SJim Harris 2746f0823e4SJim Harris while (getopt(argc, argv, "vx") != -1) ; 2756f0823e4SJim Harris 2766f0823e4SJim Harris target = argv[optind]; 2776f0823e4SJim Harris 2786f0823e4SJim Harris optreset = 1; 2796f0823e4SJim Harris optind = 1; 2806f0823e4SJim Harris 2816f0823e4SJim Harris /* 2826f0823e4SJim Harris * If device node contains "ns", we consider it a namespace, 2836f0823e4SJim Harris * otherwise, consider it a controller. 2846f0823e4SJim Harris */ 2856420873cSJim Harris if (strstr(target, NVME_NS_PREFIX) == NULL) 2866f0823e4SJim Harris identify_ctrlr(argc, argv); 2876f0823e4SJim Harris else 2886f0823e4SJim Harris identify_ns(argc, argv); 2896f0823e4SJim Harris } 290