xref: /freebsd/sbin/nvmecontrol/firmware.c (revision 329327e272feedec3659a0d345b2302367dcb752)

/*-
 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
 *
 * Copyright (c) 2013 EMC Corp.
 * All rights reserved.
 *
 * Copyright (C) 2012-2013 Intel Corporation
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#include <sys/cdefs.h>
__FBSDID("$FreeBSD$");

#include <sys/param.h>
#include <sys/ioccom.h>
#include <sys/stat.h>
#include <sys/types.h>

#include <ctype.h>
#include <err.h>
#include <fcntl.h>
#include <inttypes.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sysexits.h>
#include <unistd.h>

#include "nvmecontrol.h"

/* Tables for command line parsing */

static cmd_fn_t firmware;

#define NONE 0xffffffffu
static struct options {
	bool		activate;
	uint32_t	slot;
	const char	*fw_img;
	const char	*dev;
} opt = {
	.activate = false,
	.slot = NONE,
	.fw_img = NULL,
	.dev = NULL,
};

static const struct opts firmware_opts[] = {
#define OPT(l, s, t, opt, addr, desc) { l, s, t, &opt.addr, desc }
	OPT("activate", 'a', arg_none, opt, activate,
	    "Attempt to activate firmware"),
	OPT("slot", 's', arg_uint32, opt, slot,
	    "Slot to activate and/or download firmware to"),
	OPT("firmware", 'f', arg_path, opt, fw_img,
	    "Firmware image to download"),
	{ NULL, 0, arg_none, NULL, NULL }
};
#undef OPT

static const struct args firmware_args[] = {
	{ arg_string, &opt.dev, "controller-id|namespace-id" },
	{ arg_none, NULL, NULL },
};

static struct cmd firmware_cmd = {
	.name = "firmware",
	.fn = firmware,
	.descr = "Download firmware image to controller",
	.ctx_size = sizeof(opt),
	.opts = firmware_opts,
	.args = firmware_args,
};

CMD_COMMAND(firmware_cmd);

/* End of tables for command line parsing */

static int
slot_has_valid_firmware(int fd, int slot)
{
	struct nvme_firmware_page	fw;
	int				has_fw = false;

	read_logpage(fd, NVME_LOG_FIRMWARE_SLOT,
	    NVME_GLOBAL_NAMESPACE_TAG, 0, 0, 0, &fw, sizeof(fw));

	if (fw.revision[slot-1] != 0LLU)
		has_fw = true;

	return (has_fw);
}

static void
read_image_file(const char *path, void **buf, int32_t *size)
{
	struct stat	sb;
	int32_t		filesize;
	int		fd;

	*size = 0;
	*buf = NULL;

	if ((fd = open(path, O_RDONLY)) < 0)
		err(EX_NOINPUT, "unable to open '%s'", path);
	if (fstat(fd, &sb) < 0)
		err(EX_NOINPUT, "unable to stat '%s'", path);

	/*
	 * The NVMe spec does not explicitly state a maximum firmware image
	 *  size, although one can be inferred from the dword size limitation
	 *  for the size and offset fields in the Firmware Image Download
	 *  command.
	 *
	 * Technically, the max is UINT32_MAX * sizeof(uint32_t), since the
	 *  size and offsets are specified in terms of dwords (not bytes), but
	 *  realistically INT32_MAX is sufficient here and simplifies matters
	 *  a bit.
	 */
	if (sb.st_size > INT32_MAX)
		errx(EX_USAGE, "size of file '%s' is too large (%jd bytes)",
		    path, (intmax_t)sb.st_size);
	filesize = (int32_t)sb.st_size;
	if ((*buf = malloc(filesize)) == NULL)
		errx(EX_OSERR, "unable to malloc %d bytes", filesize);
	if ((*size = read(fd, *buf, filesize)) < 0)
		err(EX_IOERR, "error reading '%s'", path);
	/* XXX assuming no short reads */
	if (*size != filesize)
		errx(EX_IOERR,
		    "error reading '%s' (read %d bytes, requested %d bytes)",
		    path, *size, filesize);
	close(fd);
}

static void
update_firmware(int fd, uint8_t *payload, int32_t payload_size, uint8_t fwug)
{
	struct nvme_pt_command	pt;
	uint64_t                max_xfer_size;
	int32_t			off, resid, size;
	void			*chunk;

	off = 0;
	resid = payload_size;

	if (ioctl(fd, NVME_GET_MAX_XFER_SIZE, &max_xfer_size) < 0)
		err(EX_IOERR, "query max transfer size failed");
	if (fwug != 0 && fwug != 0xFF)
		max_xfer_size = MIN(max_xfer_size, (uint64_t)fwug << 12);

	if ((chunk = aligned_alloc(PAGE_SIZE, max_xfer_size)) == NULL)
		errx(EX_OSERR, "unable to malloc %zd bytes", (size_t)max_xfer_size);

	while (resid > 0) {
		size = (resid >= (int32_t)max_xfer_size) ?
		    max_xfer_size : resid;
		memcpy(chunk, payload + off, size);

		memset(&pt, 0, sizeof(pt));
		pt.cmd.opc = NVME_OPC_FIRMWARE_IMAGE_DOWNLOAD;
		pt.cmd.cdw10 = htole32((size / sizeof(uint32_t)) - 1);
		pt.cmd.cdw11 = htole32(off / sizeof(uint32_t));
		pt.buf = chunk;
		pt.len = size;
		pt.is_read = 0;

		if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0)
			err(EX_IOERR, "firmware download request failed");

		if (nvme_completion_is_error(&pt.cpl))
			errx(EX_IOERR, "firmware download request returned error");

		resid -= size;
		off += size;
	}
	free(chunk);
}

static int
activate_firmware(int fd, int slot, int activate_action)
{
	struct nvme_pt_command	pt;
	uint16_t sct, sc;

	memset(&pt, 0, sizeof(pt));
	pt.cmd.opc = NVME_OPC_FIRMWARE_ACTIVATE;
	pt.cmd.cdw10 = htole32((activate_action << 3) | slot);
	pt.is_read = 0;

	if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0)
		err(EX_IOERR, "firmware activate request failed");

	sct = NVME_STATUS_GET_SCT(pt.cpl.status);
	sc = NVME_STATUS_GET_SC(pt.cpl.status);

	if (sct == NVME_SCT_COMMAND_SPECIFIC &&
	    sc == NVME_SC_FIRMWARE_REQUIRES_RESET)
		return 1;

	if (nvme_completion_is_error(&pt.cpl))
		errx(EX_IOERR, "firmware activate request returned error");

	return 0;
}

static void
firmware(const struct cmd *f, int argc, char *argv[])
{
	int				fd = -1;
	int				activate_action, reboot_required;
	char				prompt[64];
	void				*buf = NULL;
	char				*path;
	int32_t				size = 0, nsid;
	uint16_t			oacs_fw;
	uint8_t				fw_slot1_ro, fw_num_slots;
	struct nvme_controller_data	cdata;

	if (arg_parse(argc, argv, f))
		return;

	if (opt.slot == 0) {
		fprintf(stderr,
		    "0 is not a valid slot number. "
		    "Slot numbers start at 1.\n");
		arg_help(argc, argv, f);
	} else if (opt.slot > 7 && opt.slot != NONE) {
		fprintf(stderr,
		    "Slot number %s specified which is "
		    "greater than max allowed slot number of "
		    "7.\n", optarg);
		arg_help(argc, argv, f);
	}

	if (!opt.activate && opt.fw_img == NULL) {
		fprintf(stderr,
		    "Neither a replace ([-f path_to_firmware]) nor "
		    "activate ([-a]) firmware image action\n"
		    "was specified.\n");
		arg_help(argc, argv, f);
	}

	if (opt.activate && opt.fw_img == NULL && opt.slot == 0) {
		fprintf(stderr,
		    "Slot number to activate not specified.\n");
		arg_help(argc, argv, f);
	}

	open_dev(opt.dev, &fd, 1, 1);
	get_nsid(fd, &path, &nsid);
	if (nsid != 0) {
		close(fd);
		open_dev(path, &fd, 1, 1);
	}
	free(path);

	if (read_controller_data(fd, &cdata))
		errx(EX_IOERR, "Identify request failed");

	oacs_fw = (cdata.oacs >> NVME_CTRLR_DATA_OACS_FIRMWARE_SHIFT) &
		NVME_CTRLR_DATA_OACS_FIRMWARE_MASK;

	if (oacs_fw == 0)
		errx(EX_UNAVAILABLE,
		    "controller does not support firmware activate/download");

	fw_slot1_ro = (cdata.frmw >> NVME_CTRLR_DATA_FRMW_SLOT1_RO_SHIFT) &
		NVME_CTRLR_DATA_FRMW_SLOT1_RO_MASK;

	if (opt.fw_img && opt.slot == 1 && fw_slot1_ro)
		errx(EX_UNAVAILABLE, "slot %d is marked as read only", opt.slot);

	fw_num_slots = (cdata.frmw >> NVME_CTRLR_DATA_FRMW_NUM_SLOTS_SHIFT) &
		NVME_CTRLR_DATA_FRMW_NUM_SLOTS_MASK;

	if (opt.slot > fw_num_slots)
		errx(EX_UNAVAILABLE,
		    "slot %d specified but controller only supports %d slots",
		    opt.slot, fw_num_slots);

	if (opt.activate && opt.fw_img == NULL &&
	    !slot_has_valid_firmware(fd, opt.slot))
		errx(EX_UNAVAILABLE,
		    "slot %d does not contain valid firmware,\n"
		    "try 'nvmecontrol logpage -p 3 %s' to get a list "
		    "of available images\n",
		    opt.slot, opt.dev);

	if (opt.fw_img)
		read_image_file(opt.fw_img, &buf, &size);

	if (opt.fw_img != NULL&& opt.activate)
		printf("You are about to download and activate "
		       "firmware image (%s) to controller %s.\n"
		       "This may damage your controller and/or "
		       "overwrite an existing firmware image.\n",
		       opt.fw_img, opt.dev);
	else if (opt.activate)
		printf("You are about to activate a new firmware "
		       "image on controller %s.\n"
		       "This may damage your controller.\n",
		       opt.dev);
	else if (opt.fw_img != NULL)
		printf("You are about to download firmware image "
		       "(%s) to controller %s.\n"
		       "This may damage your controller and/or "
		       "overwrite an existing firmware image.\n",
		       opt.fw_img, opt.dev);

	printf("Are you sure you want to continue? (yes/no) ");
	while (1) {
		fgets(prompt, sizeof(prompt), stdin);
		if (strncasecmp(prompt, "yes", 3) == 0)
			break;
		if (strncasecmp(prompt, "no", 2) == 0)
			exit(EX_DATAERR);
		printf("Please answer \"yes\" or \"no\". ");
	}

	if (opt.fw_img != NULL) {
		update_firmware(fd, buf, size, cdata.fwug);
		if (opt.activate)
			activate_action = NVME_AA_REPLACE_ACTIVATE;
		else
			activate_action = NVME_AA_REPLACE_NO_ACTIVATE;
	} else {
		activate_action = NVME_AA_ACTIVATE;
	}

	reboot_required = activate_firmware(fd, opt.slot, activate_action);

	if (opt.activate) {
		if (reboot_required) {
			printf("New firmware image activated but requires "
			       "conventional reset (i.e. reboot) to "
			       "complete activation.\n");
		} else {
			printf("New firmware image activated and will take "
			       "effect after next controller reset.\n"
			       "Controller reset can be initiated via "
			       "'nvmecontrol reset %s'\n",
			       opt.dev);
		}
	}

	close(fd);
	exit(0);
}