1635c517aSAlexander Motin /*- 2635c517aSAlexander Motin * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3635c517aSAlexander Motin * 4a7bf63beSAlexander Motin * Copyright (C) 2018-2019 Alexander Motin <mav@FreeBSD.org> 5635c517aSAlexander Motin * 6635c517aSAlexander Motin * Redistribution and use in source and binary forms, with or without 7635c517aSAlexander Motin * modification, are permitted provided that the following conditions 8635c517aSAlexander Motin * are met: 9635c517aSAlexander Motin * 1. Redistributions of source code must retain the above copyright 10635c517aSAlexander Motin * notice, this list of conditions and the following disclaimer. 11635c517aSAlexander Motin * 2. Redistributions in binary form must reproduce the above copyright 12635c517aSAlexander Motin * notice, this list of conditions and the following disclaimer in the 13635c517aSAlexander Motin * documentation and/or other materials provided with the distribution. 14635c517aSAlexander Motin * 15635c517aSAlexander Motin * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16635c517aSAlexander Motin * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17635c517aSAlexander Motin * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18635c517aSAlexander Motin * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19635c517aSAlexander Motin * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20635c517aSAlexander Motin * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21635c517aSAlexander Motin * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22635c517aSAlexander Motin * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23635c517aSAlexander Motin * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24635c517aSAlexander Motin * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25635c517aSAlexander Motin * SUCH DAMAGE. 26635c517aSAlexander Motin */ 27635c517aSAlexander Motin 28635c517aSAlexander Motin #include <sys/cdefs.h> 29635c517aSAlexander Motin __FBSDID("$FreeBSD$"); 30635c517aSAlexander Motin 31635c517aSAlexander Motin #include <sys/param.h> 32635c517aSAlexander Motin #include <sys/ioccom.h> 33635c517aSAlexander Motin 34635c517aSAlexander Motin #include <ctype.h> 35635c517aSAlexander Motin #include <err.h> 36635c517aSAlexander Motin #include <fcntl.h> 37f634b4c1SWarner Losh #include <stdbool.h> 38635c517aSAlexander Motin #include <stddef.h> 39635c517aSAlexander Motin #include <stdio.h> 40635c517aSAlexander Motin #include <stdlib.h> 41635c517aSAlexander Motin #include <string.h> 42635c517aSAlexander Motin #include <unistd.h> 43635c517aSAlexander Motin 44635c517aSAlexander Motin #include "nvmecontrol.h" 45635c517aSAlexander Motin 46f634b4c1SWarner Losh #define NONE 0xffffffffu 47f634b4c1SWarner Losh #define SES_NONE 0 48f634b4c1SWarner Losh #define SES_USER 1 49f634b4c1SWarner Losh #define SES_CRYPTO 2 50f634b4c1SWarner Losh 51f634b4c1SWarner Losh /* Tables for command line parsing */ 52f634b4c1SWarner Losh 53f634b4c1SWarner Losh static cmd_fn_t format; 54f634b4c1SWarner Losh 55f634b4c1SWarner Losh static struct options { 56f634b4c1SWarner Losh uint32_t lbaf; 57f634b4c1SWarner Losh uint32_t ms; 58f634b4c1SWarner Losh uint32_t pi; 59f634b4c1SWarner Losh uint32_t pil; 60f634b4c1SWarner Losh uint32_t ses; 61f634b4c1SWarner Losh bool Eflag; 62f634b4c1SWarner Losh bool Cflag; 63f634b4c1SWarner Losh const char *dev; 64f634b4c1SWarner Losh } opt = { 65f634b4c1SWarner Losh .lbaf = NONE, 66f634b4c1SWarner Losh .ms = NONE, 67f634b4c1SWarner Losh .pi = NONE, 68f634b4c1SWarner Losh .pil = NONE, 69f634b4c1SWarner Losh .ses = SES_NONE, 70f634b4c1SWarner Losh .Eflag = false, 71f634b4c1SWarner Losh .Cflag = false, 72f634b4c1SWarner Losh .dev = NULL, 73f634b4c1SWarner Losh }; 74f634b4c1SWarner Losh 75f634b4c1SWarner Losh static const struct opts format_opts[] = { 76f634b4c1SWarner Losh #define OPT(l, s, t, opt, addr, desc) { l, s, t, &opt.addr, desc } 77f634b4c1SWarner Losh OPT("crypto", 'C', arg_none, opt, Cflag, 78e843651bSAlexander Motin "Crptographic erase"), 79f634b4c1SWarner Losh OPT("erase", 'E', arg_none, opt, Eflag, 80e843651bSAlexander Motin "User data erase"), 81f634b4c1SWarner Losh OPT("lbaf", 'f', arg_uint32, opt, lbaf, 82e843651bSAlexander Motin "LBA Format to apply to the media"), 83f634b4c1SWarner Losh OPT("ms", 'm', arg_uint32, opt, ms, 84e843651bSAlexander Motin "Metadata settings"), 85f634b4c1SWarner Losh OPT("pi", 'p', arg_uint32, opt, pi, 86e843651bSAlexander Motin "Protective information"), 87f634b4c1SWarner Losh OPT("pil", 'l', arg_uint32, opt, pil, 88e843651bSAlexander Motin "Protective information location"), 89f634b4c1SWarner Losh OPT("ses", 's', arg_uint32, opt, ses, 90e843651bSAlexander Motin "Secure erase settings"), 91f634b4c1SWarner Losh { NULL, 0, arg_none, NULL, NULL } 92f634b4c1SWarner Losh }; 93f634b4c1SWarner Losh #undef OPT 94f634b4c1SWarner Losh 95f634b4c1SWarner Losh static const struct args format_args[] = { 96f634b4c1SWarner Losh { arg_string, &opt.dev, "controller-id|namespace-id" }, 97f634b4c1SWarner Losh { arg_none, NULL, NULL }, 98f634b4c1SWarner Losh }; 99f634b4c1SWarner Losh 100f634b4c1SWarner Losh static struct cmd format_cmd = { 101f634b4c1SWarner Losh .name = "format", 102f634b4c1SWarner Losh .fn = format, 103e843651bSAlexander Motin .descr = "Format/erase one or all the namespaces", 104f634b4c1SWarner Losh .ctx_size = sizeof(opt), 105f634b4c1SWarner Losh .opts = format_opts, 106f634b4c1SWarner Losh .args = format_args, 107f634b4c1SWarner Losh }; 108f634b4c1SWarner Losh 109f634b4c1SWarner Losh CMD_COMMAND(format_cmd); 110f634b4c1SWarner Losh 111f634b4c1SWarner Losh /* End of tables for command line parsing */ 112a13a291aSWarner Losh 113635c517aSAlexander Motin static void 114f634b4c1SWarner Losh format(const struct cmd *f, int argc, char *argv[]) 115635c517aSAlexander Motin { 116635c517aSAlexander Motin struct nvme_controller_data cd; 117635c517aSAlexander Motin struct nvme_namespace_data nsd; 118635c517aSAlexander Motin struct nvme_pt_command pt; 119a7bf63beSAlexander Motin char *path; 120f634b4c1SWarner Losh const char *target; 121635c517aSAlexander Motin uint32_t nsid; 122f634b4c1SWarner Losh int lbaf, ms, pi, pil, ses, fd; 123635c517aSAlexander Motin 124f634b4c1SWarner Losh if (arg_parse(argc, argv, f)) 125f634b4c1SWarner Losh return; 126635c517aSAlexander Motin 127*ea44065cSAlexander Motin if ((int)opt.Eflag + opt.Cflag + (opt.ses != SES_NONE) > 1) { 128f634b4c1SWarner Losh fprintf(stderr, 129f634b4c1SWarner Losh "Only one of -E, -C or -s may be specified\n"); 130f634b4c1SWarner Losh arg_help(argc, argv, f); 131635c517aSAlexander Motin } 132635c517aSAlexander Motin 133f634b4c1SWarner Losh target = opt.dev; 134f634b4c1SWarner Losh lbaf = opt.lbaf; 135f634b4c1SWarner Losh ms = opt.ms; 136f634b4c1SWarner Losh pi = opt.pi; 137f634b4c1SWarner Losh pil = opt.pil; 138f634b4c1SWarner Losh if (opt.Eflag) 139f634b4c1SWarner Losh ses = SES_USER; 140f634b4c1SWarner Losh else if (opt.Cflag) 141f634b4c1SWarner Losh ses = SES_CRYPTO; 142f634b4c1SWarner Losh else 143f634b4c1SWarner Losh ses = opt.ses; 144635c517aSAlexander Motin 145635c517aSAlexander Motin open_dev(target, &fd, 1, 1); 146a7bf63beSAlexander Motin get_nsid(fd, &path, &nsid); 147a7bf63beSAlexander Motin if (nsid == 0) { 148635c517aSAlexander Motin nsid = NVME_GLOBAL_NAMESPACE_TAG; 149635c517aSAlexander Motin } else { 150635c517aSAlexander Motin /* 151635c517aSAlexander Motin * We send FORMAT commands to the controller, not the namespace, 152635c517aSAlexander Motin * since it is an admin cmd. The namespace ID will be specified 153635c517aSAlexander Motin * in the command itself. So parse the namespace's device node 154635c517aSAlexander Motin * string to get the controller substring and namespace ID. 155635c517aSAlexander Motin */ 156635c517aSAlexander Motin close(fd); 157635c517aSAlexander Motin open_dev(path, &fd, 1, 1); 158011bbaa5SAlexander Motin } 159a7bf63beSAlexander Motin free(path); 160635c517aSAlexander Motin 161635c517aSAlexander Motin /* Check that controller can execute this command. */ 162635c517aSAlexander Motin read_controller_data(fd, &cd); 163011bbaa5SAlexander Motin if (((cd.oacs >> NVME_CTRLR_DATA_OACS_FORMAT_SHIFT) & 164011bbaa5SAlexander Motin NVME_CTRLR_DATA_OACS_FORMAT_MASK) == 0) 165011bbaa5SAlexander Motin errx(1, "controller does not support format"); 166011bbaa5SAlexander Motin if (((cd.fna >> NVME_CTRLR_DATA_FNA_CRYPTO_ERASE_SHIFT) & 167f634b4c1SWarner Losh NVME_CTRLR_DATA_FNA_CRYPTO_ERASE_MASK) == 0 && ses == SES_CRYPTO) 168011bbaa5SAlexander Motin errx(1, "controller does not support cryptographic erase"); 169011bbaa5SAlexander Motin 170011bbaa5SAlexander Motin if (nsid != NVME_GLOBAL_NAMESPACE_TAG) { 171011bbaa5SAlexander Motin if (((cd.fna >> NVME_CTRLR_DATA_FNA_FORMAT_ALL_SHIFT) & 172f634b4c1SWarner Losh NVME_CTRLR_DATA_FNA_FORMAT_ALL_MASK) && ses == SES_NONE) 173011bbaa5SAlexander Motin errx(1, "controller does not support per-NS format"); 174011bbaa5SAlexander Motin if (((cd.fna >> NVME_CTRLR_DATA_FNA_ERASE_ALL_SHIFT) & 175f634b4c1SWarner Losh NVME_CTRLR_DATA_FNA_ERASE_ALL_MASK) && ses != SES_NONE) 176011bbaa5SAlexander Motin errx(1, "controller does not support per-NS erase"); 177635c517aSAlexander Motin 178635c517aSAlexander Motin /* Try to keep previous namespace parameters. */ 179635c517aSAlexander Motin read_namespace_data(fd, nsid, &nsd); 180635c517aSAlexander Motin if (lbaf < 0) 181635c517aSAlexander Motin lbaf = (nsd.flbas >> NVME_NS_DATA_FLBAS_FORMAT_SHIFT) 182635c517aSAlexander Motin & NVME_NS_DATA_FLBAS_FORMAT_MASK; 183011bbaa5SAlexander Motin if (lbaf > nsd.nlbaf) 184011bbaa5SAlexander Motin errx(1, "LBA format is out of range"); 185f634b4c1SWarner Losh if (ms < 0) 186f634b4c1SWarner Losh ms = (nsd.flbas >> NVME_NS_DATA_FLBAS_EXTENDED_SHIFT) 187635c517aSAlexander Motin & NVME_NS_DATA_FLBAS_EXTENDED_MASK; 188635c517aSAlexander Motin if (pi < 0) 189635c517aSAlexander Motin pi = (nsd.dps >> NVME_NS_DATA_DPS_MD_START_SHIFT) 190635c517aSAlexander Motin & NVME_NS_DATA_DPS_MD_START_MASK; 191635c517aSAlexander Motin if (pil < 0) 192635c517aSAlexander Motin pil = (nsd.dps >> NVME_NS_DATA_DPS_PIT_SHIFT) 193635c517aSAlexander Motin & NVME_NS_DATA_DPS_PIT_MASK; 194011bbaa5SAlexander Motin } else { 195011bbaa5SAlexander Motin 196011bbaa5SAlexander Motin /* We have no previous parameters, so default to zeroes. */ 197011bbaa5SAlexander Motin if (lbaf < 0) 198011bbaa5SAlexander Motin lbaf = 0; 199f634b4c1SWarner Losh if (ms < 0) 200f634b4c1SWarner Losh ms = 0; 201011bbaa5SAlexander Motin if (pi < 0) 202011bbaa5SAlexander Motin pi = 0; 203011bbaa5SAlexander Motin if (pil < 0) 204011bbaa5SAlexander Motin pil = 0; 205635c517aSAlexander Motin } 206635c517aSAlexander Motin 207635c517aSAlexander Motin memset(&pt, 0, sizeof(pt)); 2089544e6dcSChuck Tuffli pt.cmd.opc = NVME_OPC_FORMAT_NVM; 209635c517aSAlexander Motin pt.cmd.nsid = htole32(nsid); 210635c517aSAlexander Motin pt.cmd.cdw10 = htole32((ses << 9) + (pil << 8) + (pi << 5) + 211f634b4c1SWarner Losh (ms << 4) + lbaf); 212635c517aSAlexander Motin 213635c517aSAlexander Motin if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0) 214635c517aSAlexander Motin err(1, "format request failed"); 215635c517aSAlexander Motin 216635c517aSAlexander Motin if (nvme_completion_is_error(&pt.cpl)) 217635c517aSAlexander Motin errx(1, "format request returned error"); 218635c517aSAlexander Motin close(fd); 219635c517aSAlexander Motin exit(0); 220635c517aSAlexander Motin } 221