1/*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (C) 2018-2019 Alexander Motin <mav@FreeBSD.org> 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25 * SUCH DAMAGE. 26 */ 27 28#include <sys/cdefs.h> 29__FBSDID("$FreeBSD$"); 30 31#include <sys/param.h> 32#include <sys/ioccom.h> 33 34#include <ctype.h> 35#include <err.h> 36#include <fcntl.h> 37#include <stdbool.h> 38#include <stddef.h> 39#include <stdio.h> 40#include <stdlib.h> 41#include <string.h> 42#include <sysexits.h> 43#include <unistd.h> 44 45#include "nvmecontrol.h" 46 47#define NONE 0xffffffffu 48#define SES_NONE 0 49#define SES_USER 1 50#define SES_CRYPTO 2 51 52/* Tables for command line parsing */ 53 54static cmd_fn_t format; 55 56static struct options { 57 uint32_t lbaf; 58 uint32_t ms; 59 uint32_t pi; 60 uint32_t pil; 61 uint32_t ses; 62 bool Eflag; 63 bool Cflag; 64 const char *dev; 65} opt = { 66 .lbaf = NONE, 67 .ms = NONE, 68 .pi = NONE, 69 .pil = NONE, 70 .ses = SES_NONE, 71 .Eflag = false, 72 .Cflag = false, 73 .dev = NULL, 74}; 75 76static const struct opts format_opts[] = { 77#define OPT(l, s, t, opt, addr, desc) { l, s, t, &opt.addr, desc } 78 OPT("crypto", 'C', arg_none, opt, Cflag, 79 "Crptographic erase"), 80 OPT("erase", 'E', arg_none, opt, Eflag, 81 "User data erase"), 82 OPT("lbaf", 'f', arg_uint32, opt, lbaf, 83 "LBA Format to apply to the media"), 84 OPT("ms", 'm', arg_uint32, opt, ms, 85 "Metadata settings"), 86 OPT("pi", 'p', arg_uint32, opt, pi, 87 "Protective information"), 88 OPT("pil", 'l', arg_uint32, opt, pil, 89 "Protective information location"), 90 OPT("ses", 's', arg_uint32, opt, ses, 91 "Secure erase settings"), 92 { NULL, 0, arg_none, NULL, NULL } 93}; 94#undef OPT 95 96static const struct args format_args[] = { 97 { arg_string, &opt.dev, "controller-id|namespace-id" }, 98 { arg_none, NULL, NULL }, 99}; 100 101static struct cmd format_cmd = { 102 .name = "format", 103 .fn = format, 104 .descr = "Format/erase one or all the namespaces", 105 .ctx_size = sizeof(opt), 106 .opts = format_opts, 107 .args = format_args, 108}; 109 110CMD_COMMAND(format_cmd); 111 112/* End of tables for command line parsing */ 113 114static void 115format(const struct cmd *f, int argc, char *argv[]) 116{ 117 struct nvme_controller_data cd; 118 struct nvme_namespace_data nsd; 119 struct nvme_pt_command pt; 120 char *path; 121 const char *target; 122 uint32_t nsid; 123 int lbaf, ms, pi, pil, ses, fd; 124 125 if (arg_parse(argc, argv, f)) 126 return; 127 128 if ((int)opt.Eflag + opt.Cflag + (opt.ses != SES_NONE) > 1) { 129 fprintf(stderr, 130 "Only one of -E, -C or -s may be specified\n"); 131 arg_help(argc, argv, f); 132 } 133 134 target = opt.dev; 135 lbaf = opt.lbaf; 136 ms = opt.ms; 137 pi = opt.pi; 138 pil = opt.pil; 139 if (opt.Eflag) 140 ses = SES_USER; 141 else if (opt.Cflag) 142 ses = SES_CRYPTO; 143 else 144 ses = opt.ses; 145 146 open_dev(target, &fd, 1, 1); 147 get_nsid(fd, &path, &nsid); 148 if (nsid == 0) { 149 nsid = NVME_GLOBAL_NAMESPACE_TAG; 150 } else { 151 /* 152 * We send FORMAT commands to the controller, not the namespace, 153 * since it is an admin cmd. The namespace ID will be specified 154 * in the command itself. So parse the namespace's device node 155 * string to get the controller substring and namespace ID. 156 */ 157 close(fd); 158 open_dev(path, &fd, 1, 1); 159 } 160 free(path); 161 162 /* Check that controller can execute this command. */ 163 if (read_controller_data(fd, &cd)) 164 errx(EX_IOERR, "Identify request failed"); 165 if (((cd.oacs >> NVME_CTRLR_DATA_OACS_FORMAT_SHIFT) & 166 NVME_CTRLR_DATA_OACS_FORMAT_MASK) == 0) 167 errx(EX_UNAVAILABLE, "controller does not support format"); 168 if (((cd.fna >> NVME_CTRLR_DATA_FNA_CRYPTO_ERASE_SHIFT) & 169 NVME_CTRLR_DATA_FNA_CRYPTO_ERASE_MASK) == 0 && ses == SES_CRYPTO) 170 errx(EX_UNAVAILABLE, "controller does not support cryptographic erase"); 171 172 if (nsid != NVME_GLOBAL_NAMESPACE_TAG) { 173 if (((cd.fna >> NVME_CTRLR_DATA_FNA_FORMAT_ALL_SHIFT) & 174 NVME_CTRLR_DATA_FNA_FORMAT_ALL_MASK) && ses == SES_NONE) 175 errx(EX_UNAVAILABLE, "controller does not support per-NS format"); 176 if (((cd.fna >> NVME_CTRLR_DATA_FNA_ERASE_ALL_SHIFT) & 177 NVME_CTRLR_DATA_FNA_ERASE_ALL_MASK) && ses != SES_NONE) 178 errx(EX_UNAVAILABLE, "controller does not support per-NS erase"); 179 180 /* Try to keep previous namespace parameters. */ 181 if (read_namespace_data(fd, nsid, &nsd)) 182 errx(EX_IOERR, "Identify request failed"); 183 if (lbaf < 0) 184 lbaf = (nsd.flbas >> NVME_NS_DATA_FLBAS_FORMAT_SHIFT) 185 & NVME_NS_DATA_FLBAS_FORMAT_MASK; 186 if (lbaf > nsd.nlbaf) 187 errx(EX_USAGE, "LBA format is out of range"); 188 if (ms < 0) 189 ms = (nsd.flbas >> NVME_NS_DATA_FLBAS_EXTENDED_SHIFT) 190 & NVME_NS_DATA_FLBAS_EXTENDED_MASK; 191 if (pi < 0) 192 pi = (nsd.dps >> NVME_NS_DATA_DPS_MD_START_SHIFT) 193 & NVME_NS_DATA_DPS_MD_START_MASK; 194 if (pil < 0) 195 pil = (nsd.dps >> NVME_NS_DATA_DPS_PIT_SHIFT) 196 & NVME_NS_DATA_DPS_PIT_MASK; 197 } else { 198 199 /* We have no previous parameters, so default to zeroes. */ 200 if (lbaf < 0) 201 lbaf = 0; 202 if (ms < 0) 203 ms = 0; 204 if (pi < 0) 205 pi = 0; 206 if (pil < 0) 207 pil = 0; 208 } 209 210 memset(&pt, 0, sizeof(pt)); 211 pt.cmd.opc = NVME_OPC_FORMAT_NVM; 212 pt.cmd.nsid = htole32(nsid); 213 pt.cmd.cdw10 = htole32((ses << 9) + (pil << 8) + (pi << 5) + 214 (ms << 4) + lbaf); 215 216 if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0) 217 err(EX_IOERR, "format request failed"); 218 219 if (nvme_completion_is_error(&pt.cpl)) 220 errx(EX_IOERR, "format request returned error"); 221 close(fd); 222 exit(0); 223} 224