1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 2013 EMC Corp. 5 * All rights reserved. 6 * 7 * Copyright (C) 2012-2013 Intel Corporation 8 * All rights reserved. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29 * SUCH DAMAGE. 30 */ 31 32 #include <sys/cdefs.h> 33 __FBSDID("$FreeBSD$"); 34 35 #include <sys/param.h> 36 #include <sys/ioccom.h> 37 #include <sys/stat.h> 38 #include <sys/types.h> 39 40 #include <ctype.h> 41 #include <err.h> 42 #include <fcntl.h> 43 #include <inttypes.h> 44 #include <stdbool.h> 45 #include <stddef.h> 46 #include <stdio.h> 47 #include <stdlib.h> 48 #include <string.h> 49 #include <unistd.h> 50 51 #include "nvmecontrol.h" 52 53 /* Tables for command line parsing */ 54 55 static cmd_fn_t firmware; 56 57 #define NONE 0xffffffffu 58 static struct options { 59 bool activate; 60 uint32_t slot; 61 const char *fw_img; 62 const char *dev; 63 } opt = { 64 .activate = false, 65 .slot = NONE, 66 .fw_img = NULL, 67 .dev = NULL, 68 }; 69 70 static const struct opts firmware_opts[] = { 71 #define OPT(l, s, t, opt, addr, desc) { l, s, t, &opt.addr, desc } 72 OPT("activate", 'a', arg_none, opt, activate, 73 "Attempt to activate firmware"), 74 OPT("slot", 's', arg_uint32, opt, slot, 75 "Slot to activate and/or download firmware to"), 76 OPT("firmware", 'f', arg_path, opt, fw_img, 77 "Firmware image to download"), 78 { NULL, 0, arg_none, NULL, NULL } 79 }; 80 #undef OPT 81 82 static const struct args firmware_args[] = { 83 { arg_string, &opt.dev, "controller-id|namespace-id" }, 84 { arg_none, NULL, NULL }, 85 }; 86 87 static struct cmd firmware_cmd = { 88 .name = "firmware", 89 .fn = firmware, 90 .descr = "Download firmware image to controller", 91 .ctx_size = sizeof(opt), 92 .opts = firmware_opts, 93 .args = firmware_args, 94 }; 95 96 CMD_COMMAND(firmware_cmd); 97 98 /* End of tables for command line parsing */ 99 100 static int 101 slot_has_valid_firmware(int fd, int slot) 102 { 103 struct nvme_firmware_page fw; 104 int has_fw = false; 105 106 read_logpage(fd, NVME_LOG_FIRMWARE_SLOT, 107 NVME_GLOBAL_NAMESPACE_TAG, 0, 0, 0, &fw, sizeof(fw)); 108 109 if (fw.revision[slot-1] != 0LLU) 110 has_fw = true; 111 112 return (has_fw); 113 } 114 115 static void 116 read_image_file(const char *path, void **buf, int32_t *size) 117 { 118 struct stat sb; 119 int32_t filesize; 120 int fd; 121 122 *size = 0; 123 *buf = NULL; 124 125 if ((fd = open(path, O_RDONLY)) < 0) 126 err(1, "unable to open '%s'", path); 127 if (fstat(fd, &sb) < 0) 128 err(1, "unable to stat '%s'", path); 129 130 /* 131 * The NVMe spec does not explicitly state a maximum firmware image 132 * size, although one can be inferred from the dword size limitation 133 * for the size and offset fields in the Firmware Image Download 134 * command. 135 * 136 * Technically, the max is UINT32_MAX * sizeof(uint32_t), since the 137 * size and offsets are specified in terms of dwords (not bytes), but 138 * realistically INT32_MAX is sufficient here and simplifies matters 139 * a bit. 140 */ 141 if (sb.st_size > INT32_MAX) 142 errx(1, "size of file '%s' is too large (%jd bytes)", 143 path, (intmax_t)sb.st_size); 144 filesize = (int32_t)sb.st_size; 145 if ((*buf = malloc(filesize)) == NULL) 146 errx(1, "unable to malloc %d bytes", filesize); 147 if ((*size = read(fd, *buf, filesize)) < 0) 148 err(1, "error reading '%s'", path); 149 /* XXX assuming no short reads */ 150 if (*size != filesize) 151 errx(1, 152 "error reading '%s' (read %d bytes, requested %d bytes)", 153 path, *size, filesize); 154 close(fd); 155 } 156 157 static void 158 update_firmware(int fd, uint8_t *payload, int32_t payload_size, uint8_t fwug) 159 { 160 struct nvme_pt_command pt; 161 uint64_t max_xfer_size; 162 int32_t off, resid, size; 163 void *chunk; 164 165 off = 0; 166 resid = payload_size; 167 168 if (fwug != 0 && fwug != 0xFF) 169 max_xfer_size = ((uint64_t)fwug << 12); 170 else if (ioctl(fd, NVME_GET_MAX_XFER_SIZE, &max_xfer_size) < 0) 171 err(1, "query max transfer size failed"); 172 if (max_xfer_size > NVME_MAX_XFER_SIZE) 173 max_xfer_size = NVME_MAX_XFER_SIZE; 174 175 if ((chunk = aligned_alloc(PAGE_SIZE, max_xfer_size)) == NULL) 176 errx(1, "unable to malloc %zd bytes", (size_t)max_xfer_size); 177 178 while (resid > 0) { 179 size = (resid >= (int32_t)max_xfer_size) ? 180 max_xfer_size : resid; 181 memcpy(chunk, payload + off, size); 182 183 memset(&pt, 0, sizeof(pt)); 184 pt.cmd.opc = NVME_OPC_FIRMWARE_IMAGE_DOWNLOAD; 185 pt.cmd.cdw10 = htole32((size / sizeof(uint32_t)) - 1); 186 pt.cmd.cdw11 = htole32(off / sizeof(uint32_t)); 187 pt.buf = chunk; 188 pt.len = size; 189 pt.is_read = 0; 190 191 if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0) 192 err(1, "firmware download request failed"); 193 194 if (nvme_completion_is_error(&pt.cpl)) 195 errx(1, "firmware download request returned error"); 196 197 resid -= size; 198 off += size; 199 } 200 free(chunk); 201 } 202 203 static int 204 activate_firmware(int fd, int slot, int activate_action) 205 { 206 struct nvme_pt_command pt; 207 uint16_t sct, sc; 208 209 memset(&pt, 0, sizeof(pt)); 210 pt.cmd.opc = NVME_OPC_FIRMWARE_ACTIVATE; 211 pt.cmd.cdw10 = htole32((activate_action << 3) | slot); 212 pt.is_read = 0; 213 214 if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0) 215 err(1, "firmware activate request failed"); 216 217 sct = NVME_STATUS_GET_SCT(pt.cpl.status); 218 sc = NVME_STATUS_GET_SC(pt.cpl.status); 219 220 if (sct == NVME_SCT_COMMAND_SPECIFIC && 221 sc == NVME_SC_FIRMWARE_REQUIRES_RESET) 222 return 1; 223 224 if (nvme_completion_is_error(&pt.cpl)) 225 errx(1, "firmware activate request returned error"); 226 227 return 0; 228 } 229 230 static void 231 firmware(const struct cmd *f, int argc, char *argv[]) 232 { 233 int fd = -1; 234 int activate_action, reboot_required; 235 char prompt[64]; 236 void *buf = NULL; 237 char *path; 238 int32_t size = 0, nsid; 239 uint16_t oacs_fw; 240 uint8_t fw_slot1_ro, fw_num_slots; 241 struct nvme_controller_data cdata; 242 243 if (arg_parse(argc, argv, f)) 244 return; 245 246 if (opt.slot == 0) { 247 fprintf(stderr, 248 "0 is not a valid slot number. " 249 "Slot numbers start at 1.\n"); 250 arg_help(argc, argv, f); 251 } else if (opt.slot > 7 && opt.slot != NONE) { 252 fprintf(stderr, 253 "Slot number %s specified which is " 254 "greater than max allowed slot number of " 255 "7.\n", optarg); 256 arg_help(argc, argv, f); 257 } 258 259 if (!opt.activate && opt.fw_img == NULL) { 260 fprintf(stderr, 261 "Neither a replace ([-f path_to_firmware]) nor " 262 "activate ([-a]) firmware image action\n" 263 "was specified.\n"); 264 arg_help(argc, argv, f); 265 } 266 267 if (opt.activate && opt.fw_img == NULL && opt.slot == 0) { 268 fprintf(stderr, 269 "Slot number to activate not specified.\n"); 270 arg_help(argc, argv, f); 271 } 272 273 open_dev(opt.dev, &fd, 1, 1); 274 get_nsid(fd, &path, &nsid); 275 if (nsid != 0) { 276 close(fd); 277 open_dev(path, &fd, 1, 1); 278 } 279 free(path); 280 281 read_controller_data(fd, &cdata); 282 283 oacs_fw = (cdata.oacs >> NVME_CTRLR_DATA_OACS_FIRMWARE_SHIFT) & 284 NVME_CTRLR_DATA_OACS_FIRMWARE_MASK; 285 286 if (oacs_fw == 0) 287 errx(1, 288 "controller does not support firmware activate/download"); 289 290 fw_slot1_ro = (cdata.frmw >> NVME_CTRLR_DATA_FRMW_SLOT1_RO_SHIFT) & 291 NVME_CTRLR_DATA_FRMW_SLOT1_RO_MASK; 292 293 if (opt.fw_img && opt.slot == 1 && fw_slot1_ro) 294 errx(1, "slot %d is marked as read only", opt.slot); 295 296 fw_num_slots = (cdata.frmw >> NVME_CTRLR_DATA_FRMW_NUM_SLOTS_SHIFT) & 297 NVME_CTRLR_DATA_FRMW_NUM_SLOTS_MASK; 298 299 if (opt.slot > fw_num_slots) 300 errx(1, 301 "slot %d specified but controller only supports %d slots", 302 opt.slot, fw_num_slots); 303 304 if (opt.activate && opt.fw_img == NULL && 305 !slot_has_valid_firmware(fd, opt.slot)) 306 errx(1, 307 "slot %d does not contain valid firmware,\n" 308 "try 'nvmecontrol logpage -p 3 %s' to get a list " 309 "of available images\n", 310 opt.slot, opt.dev); 311 312 if (opt.fw_img) 313 read_image_file(opt.fw_img, &buf, &size); 314 315 if (opt.fw_img != NULL&& opt.activate) 316 printf("You are about to download and activate " 317 "firmware image (%s) to controller %s.\n" 318 "This may damage your controller and/or " 319 "overwrite an existing firmware image.\n", 320 opt.fw_img, opt.dev); 321 else if (opt.activate) 322 printf("You are about to activate a new firmware " 323 "image on controller %s.\n" 324 "This may damage your controller.\n", 325 opt.dev); 326 else if (opt.fw_img != NULL) 327 printf("You are about to download firmware image " 328 "(%s) to controller %s.\n" 329 "This may damage your controller and/or " 330 "overwrite an existing firmware image.\n", 331 opt.fw_img, opt.dev); 332 333 printf("Are you sure you want to continue? (yes/no) "); 334 while (1) { 335 fgets(prompt, sizeof(prompt), stdin); 336 if (strncasecmp(prompt, "yes", 3) == 0) 337 break; 338 if (strncasecmp(prompt, "no", 2) == 0) 339 exit(1); 340 printf("Please answer \"yes\" or \"no\". "); 341 } 342 343 if (opt.fw_img != NULL) { 344 update_firmware(fd, buf, size, cdata.fwug); 345 if (opt.activate) 346 activate_action = NVME_AA_REPLACE_ACTIVATE; 347 else 348 activate_action = NVME_AA_REPLACE_NO_ACTIVATE; 349 } else { 350 activate_action = NVME_AA_ACTIVATE; 351 } 352 353 reboot_required = activate_firmware(fd, opt.slot, activate_action); 354 355 if (opt.activate) { 356 if (reboot_required) { 357 printf("New firmware image activated but requires " 358 "conventional reset (i.e. reboot) to " 359 "complete activation.\n"); 360 } else { 361 printf("New firmware image activated and will take " 362 "effect after next controller reset.\n" 363 "Controller reset can be initiated via " 364 "'nvmecontrol reset %s'\n", 365 opt.dev); 366 } 367 } 368 369 close(fd); 370 exit(0); 371 } 372