* [PATCH v5 2/2] ndctl: merge firmware-update to dimm.c as one of the dimm ops
2018-03-09 18:24 [PATCH v5 0/2] ndctl: move firmware update to dimm action Dave Jiang
2018-03-09 18:24 ` [PATCH v5 1/2] ndctl: add check for update firmware supported Dave Jiang
@ 2018-03-09 18:24 ` Dave Jiang
1 sibling, 0 replies; 4+ messages in thread
From: Dave Jiang @ 2018-03-09 18:24 UTC (permalink / raw)
To: vishal.l.verma, dan.j.williams; +Cc: linux-nvdimm
Since update-firmware replicate a lot of the parsing code that dimm.c
already uses, moving update-firmware to dimm.c and utilize the already
working functionalities.
Signed-off-by: Dave Jiang <dave.jiang@intel.com>
---
ndctl/Makefile.am | 1
ndctl/dimm.c | 475 ++++++++++++++++++++++++++++++++++++++++
ndctl/firmware-update.h | 45 ++++
ndctl/update.c | 558 -----------------------------------------------
4 files changed, 518 insertions(+), 561 deletions(-)
create mode 100644 ndctl/firmware-update.h
delete mode 100644 ndctl/update.c
diff --git a/Documentation/ndctl/ndctl-update-firmware.txt b/Documentation/ndctl/ndctl-update-firmware.txt
index d742302a..121cc52d 100644
--- a/Documentation/ndctl/ndctl-update-firmware.txt
+++ b/Documentation/ndctl/ndctl-update-firmware.txt
@@ -8,11 +8,26 @@ ndctl-update-firmware - provides updating of NVDIMM firmware
SYNOPSIS
--------
[verse]
-'ndctl update-firmware' -f <firmware_file> -d <dimm name>
+'ndctl update-firmware' <dimm> [<options>]
+
+include::dimm-description.txt[]
+
+OPTIONS
+-------
+<dimm>::
+include::xable-dimm-options.txt[]
+
+-f::
+--firmware::
+ firmware file used to perform the update
+
+-v::
+--verbose::
+ Emit debug messages for the namespace check process.
COPYRIGHT
---------
-Copyright (c) 2016 - 2017, Intel Corporation. License GPLv2: GNU GPL
+Copyright (c) 2017 - 2018, Intel Corporation. License GPLv2: GNU GPL
version 2 <http://gnu.org/licenses/gpl.html>. This is free software:
you are free to change and redistribute it. There is NO WARRANTY, to
the extent permitted by law.
diff --git a/ndctl/Makefile.am b/ndctl/Makefile.am
index e0db97ba..213cabd7 100644
--- a/ndctl/Makefile.am
+++ b/ndctl/Makefile.am
@@ -15,7 +15,6 @@ ndctl_SOURCES = ndctl.c \
util/json-smart.c \
util/json-firmware.c \
inject-error.c \
- update.c \
inject-smart.c
if ENABLE_DESTRUCTIVE
diff --git a/ndctl/dimm.c b/ndctl/dimm.c
index 7259506f..36946bc5 100644
--- a/ndctl/dimm.c
+++ b/ndctl/dimm.c
@@ -13,6 +13,8 @@
#include <stdio.h>
#include <errno.h>
#include <stdlib.h>
+#include <sys/types.h>
+#include <sys/stat.h>
#include <unistd.h>
#include <limits.h>
#include <syslog.h>
@@ -28,12 +30,14 @@
#include <util/parse-options.h>
#include <ccan/minmax/minmax.h>
#include <ccan/array_size/array_size.h>
+#include <ndctl/firmware-update.h>
struct action_context {
struct json_object *jdimms;
enum ndctl_namespace_version labelversion;
FILE *f_out;
FILE *f_in;
+ struct update_context update;
};
static int action_disable(struct ndctl_dimm *dimm, struct action_context *actx)
@@ -371,6 +375,449 @@ static int action_read(struct ndctl_dimm *dimm, struct action_context *actx)
return rc;
}
+static int update_verify_input(struct action_context *actx)
+{
+ int rc;
+ struct stat st;
+
+ rc = fstat(fileno(actx->f_in), &st);
+ if (rc == -1) {
+ rc = -errno;
+ fprintf(stderr, "fstat failed: %s\n", strerror(errno));
+ return rc;
+ }
+
+ if (!S_ISREG(st.st_mode)) {
+ fprintf(stderr, "Input not a regular file.\n");
+ return -EINVAL;
+ }
+
+ if (st.st_size == 0) {
+ fprintf(stderr, "Input file size is 0.\n");
+ return -EINVAL;
+ }
+
+ actx->update.fw_size = st.st_size;
+ return 0;
+}
+
+static int verify_fw_size(struct update_context *uctx)
+{
+ struct fw_info *fw = &uctx->dimm_fw;
+
+ if (uctx->fw_size > fw->store_size) {
+ error("Firmware file size greater than DIMM store\n");
+ return -ENOSPC;
+ }
+
+ return 0;
+}
+
+static int submit_get_firmware_info(struct ndctl_dimm *dimm,
+ struct action_context *actx)
+{
+ struct update_context *uctx = &actx->update;
+ struct fw_info *fw = &uctx->dimm_fw;
+ struct ndctl_cmd *cmd;
+ int rc;
+ enum ND_FW_STATUS status;
+
+ cmd = ndctl_dimm_cmd_new_fw_get_info(dimm);
+ if (!cmd)
+ return -ENXIO;
+
+ rc = ndctl_cmd_submit(cmd);
+ if (rc < 0)
+ return rc;
+
+ status = ndctl_cmd_fw_xlat_firmware_status(cmd);
+ if (status != FW_SUCCESS) {
+ fprintf(stderr, "GET FIRMWARE INFO on DIMM %s failed: %#x\n",
+ ndctl_dimm_get_devname(dimm), status);
+ return -ENXIO;
+ }
+
+ fw->store_size = ndctl_cmd_fw_info_get_storage_size(cmd);
+ if (fw->store_size == UINT_MAX)
+ return -ENXIO;
+
+ fw->update_size = ndctl_cmd_fw_info_get_max_send_len(cmd);
+ if (fw->update_size == UINT_MAX)
+ return -ENXIO;
+
+ fw->query_interval = ndctl_cmd_fw_info_get_query_interval(cmd);
+ if (fw->query_interval == UINT_MAX)
+ return -ENXIO;
+
+ fw->max_query = ndctl_cmd_fw_info_get_max_query_time(cmd);
+ if (fw->max_query == UINT_MAX)
+ return -ENXIO;
+
+ fw->run_version = ndctl_cmd_fw_info_get_run_version(cmd);
+ if (fw->run_version == ULLONG_MAX)
+ return -ENXIO;
+
+ rc = verify_fw_size(uctx);
+ ndctl_cmd_unref(cmd);
+ return rc;
+}
+
+static int submit_start_firmware_upload(struct ndctl_dimm *dimm,
+ struct action_context *actx)
+{
+ struct update_context *uctx = &actx->update;
+ struct fw_info *fw = &uctx->dimm_fw;
+ struct ndctl_cmd *cmd;
+ int rc;
+ enum ND_FW_STATUS status;
+
+ cmd = ndctl_dimm_cmd_new_fw_start_update(dimm);
+ if (!cmd)
+ return -ENXIO;
+
+ rc = ndctl_cmd_submit(cmd);
+ if (rc < 0)
+ return rc;
+
+ status = ndctl_cmd_fw_xlat_firmware_status(cmd);
+ if (status != FW_SUCCESS) {
+ fprintf(stderr,
+ "START FIRMWARE UPDATE on DIMM %s failed: %#x\n",
+ ndctl_dimm_get_devname(dimm), status);
+ if (status == FW_EBUSY)
+ fprintf(stderr, "Another firmware upload in progress"
+ " or firmware already updated.\n");
+ return -ENXIO;
+ }
+
+ fw->context = ndctl_cmd_fw_start_get_context(cmd);
+ if (fw->context == UINT_MAX) {
+ fprintf(stderr,
+ "Retrieved firmware context invalid on DIMM %s\n",
+ ndctl_dimm_get_devname(dimm));
+ return -ENXIO;
+ }
+
+ uctx->start = cmd;
+
+ return 0;
+}
+
+static int get_fw_data_from_file(FILE *file, void *buf, uint32_t len)
+{
+ size_t rc;
+
+ rc = fread(buf, len, 1, file);
+ if (rc != 1) {
+ if (feof(file))
+ fprintf(stderr,
+ "Firmware file shorter than expected\n");
+ else if (ferror(file))
+ fprintf(stderr, "Firmware file read error\n");
+ return -EBADF;
+ }
+
+ return len;
+}
+
+static int send_firmware(struct ndctl_dimm *dimm,
+ struct action_context *actx)
+{
+ struct update_context *uctx = &actx->update;
+ struct fw_info *fw = &uctx->dimm_fw;
+ struct ndctl_cmd *cmd = NULL;
+ ssize_t read;
+ int rc = -ENXIO;
+ enum ND_FW_STATUS status;
+ uint32_t copied = 0, len, remain;
+ void *buf;
+
+ buf = malloc(fw->update_size);
+ if (!buf)
+ return -ENOMEM;
+
+ remain = uctx->fw_size;
+
+ while (remain) {
+ len = min(fw->update_size, remain);
+ read = get_fw_data_from_file(actx->f_in, buf, len);
+ if (read < 0) {
+ rc = read;
+ goto cleanup;
+ }
+
+ cmd = ndctl_dimm_cmd_new_fw_send(uctx->start, copied, read,
+ buf);
+ if (!cmd) {
+ rc = -ENXIO;
+ goto cleanup;
+ }
+
+ rc = ndctl_cmd_submit(cmd);
+ if (rc < 0)
+ goto cleanup;
+
+ status = ndctl_cmd_fw_xlat_firmware_status(cmd);
+ if (status != FW_SUCCESS) {
+ error("SEND FIRMWARE failed: %#x\n", status);
+ rc = -ENXIO;
+ goto cleanup;
+ }
+
+ copied += read;
+ remain -= read;
+
+ ndctl_cmd_unref(cmd);
+ cmd = NULL;
+ }
+
+cleanup:
+ ndctl_cmd_unref(cmd);
+ free(buf);
+ return rc;
+}
+
+static int submit_finish_firmware(struct ndctl_dimm *dimm,
+ struct action_context *actx)
+{
+ struct update_context *uctx = &actx->update;
+ struct ndctl_cmd *cmd;
+ int rc;
+ enum ND_FW_STATUS status;
+
+ cmd = ndctl_dimm_cmd_new_fw_finish(uctx->start);
+ if (!cmd)
+ return -ENXIO;
+
+ rc = ndctl_cmd_submit(cmd);
+ if (rc < 0)
+ goto out;
+
+ status = ndctl_cmd_fw_xlat_firmware_status(cmd);
+ if (status != FW_SUCCESS) {
+ fprintf(stderr,
+ "FINISH FIRMWARE UPDATE on DIMM %s failed: %#x\n",
+ ndctl_dimm_get_devname(dimm), status);
+ rc = -ENXIO;
+ goto out;
+ }
+
+out:
+ ndctl_cmd_unref(cmd);
+ return rc;
+}
+
+static int submit_abort_firmware(struct ndctl_dimm *dimm,
+ struct action_context *actx)
+{
+ struct update_context *uctx = &actx->update;
+ struct ndctl_cmd *cmd;
+ int rc;
+ enum ND_FW_STATUS status;
+
+ cmd = ndctl_dimm_cmd_new_fw_abort(uctx->start);
+ if (!cmd)
+ return -ENXIO;
+
+ rc = ndctl_cmd_submit(cmd);
+ if (rc < 0)
+ goto out;
+
+ status = ndctl_cmd_fw_xlat_firmware_status(cmd);
+ if (!(status & ND_CMD_STATUS_FIN_ABORTED)) {
+ fprintf(stderr,
+ "Firmware update abort on DIMM %s failed: %#x\n",
+ ndctl_dimm_get_devname(dimm), status);
+ rc = -ENXIO;
+ goto out;
+ }
+
+out:
+ ndctl_cmd_unref(cmd);
+ return rc;
+}
+
+static int query_fw_finish_status(struct ndctl_dimm *dimm,
+ struct action_context *actx)
+{
+ struct update_context *uctx = &actx->update;
+ struct fw_info *fw = &uctx->dimm_fw;
+ struct ndctl_cmd *cmd;
+ int rc;
+ enum ND_FW_STATUS status;
+ bool done = false;
+ struct timespec now, before, after;
+ uint64_t ver;
+
+ cmd = ndctl_dimm_cmd_new_fw_finish_query(uctx->start);
+ if (!cmd)
+ return -ENXIO;
+
+ rc = clock_gettime(CLOCK_MONOTONIC, &before);
+ if (rc < 0)
+ goto out;
+
+ now.tv_nsec = fw->query_interval / 1000;
+ now.tv_sec = 0;
+
+ do {
+ rc = ndctl_cmd_submit(cmd);
+ if (rc < 0)
+ break;
+
+ status = ndctl_cmd_fw_xlat_firmware_status(cmd);
+ switch (status) {
+ case FW_SUCCESS:
+ ver = ndctl_cmd_fw_fquery_get_fw_rev(cmd);
+ if (ver == 0) {
+ fprintf(stderr, "No firmware updated.\n");
+ rc = -ENXIO;
+ goto out;
+ }
+
+ printf("Image updated successfully to DIMM %s.\n",
+ ndctl_dimm_get_devname(dimm));
+ printf("Firmware version %#lx.\n", ver);
+ printf("Cold reboot to activate.\n");
+ done = true;
+ rc = 0;
+ break;
+ case FW_EBUSY:
+ /* Still on going, continue */
+ rc = clock_gettime(CLOCK_MONOTONIC, &after);
+ if (rc < 0) {
+ rc = -errno;
+ goto out;
+ }
+
+ /*
+ * If we expire max query time,
+ * we timed out
+ */
+ if (after.tv_sec - before.tv_sec >
+ fw->max_query / 1000000) {
+ rc = -ETIMEDOUT;
+ goto out;
+ }
+
+ /*
+ * Sleep the interval dictated by firmware
+ * before query again.
+ */
+ rc = nanosleep(&now, NULL);
+ if (rc < 0) {
+ rc = -errno;
+ goto out;
+ }
+ break;
+ case FW_EBADFW:
+ fprintf(stderr,
+ "Firmware failed to verify by DIMM %s.\n",
+ ndctl_dimm_get_devname(dimm));
+ case FW_EINVAL_CTX:
+ case FW_ESEQUENCE:
+ done = true;
+ rc = -ENXIO;
+ goto out;
+ case FW_ENORES:
+ fprintf(stderr,
+ "Firmware update sequence timed out: %s\n",
+ ndctl_dimm_get_devname(dimm));
+ rc = -ETIMEDOUT;
+ done = true;
+ goto out;
+ default:
+ fprintf(stderr,
+ "Unknown update status: %#x on DIMM %s\n",
+ status, ndctl_dimm_get_devname(dimm));
+ rc = -EINVAL;
+ done = true;
+ goto out;
+ }
+ } while (!done);
+
+out:
+ ndctl_cmd_unref(cmd);
+ return rc;
+}
+
+static int update_firmware(struct ndctl_dimm *dimm,
+ struct action_context *actx)
+{
+ int rc;
+
+ rc = submit_get_firmware_info(dimm, actx);
+ if (rc < 0)
+ return rc;
+
+ rc = submit_start_firmware_upload(dimm, actx);
+ if (rc < 0)
+ return rc;
+
+ printf("Uploading firmware to DIMM %s.\n",
+ ndctl_dimm_get_devname(dimm));
+
+ rc = send_firmware(dimm, actx);
+ if (rc < 0) {
+ fprintf(stderr, "Firmware send failed. Aborting!\n");
+ rc = submit_abort_firmware(dimm, actx);
+ if (rc < 0)
+ fprintf(stderr, "Aborting update sequence failed.\n");
+ return rc;
+ }
+
+ /*
+ * Done reading file, reset firmware file back to beginning for
+ * next update.
+ */
+ rewind(actx->f_in);
+
+ rc = submit_finish_firmware(dimm, actx);
+ if (rc < 0) {
+ fprintf(stderr, "Unable to end update sequence.\n");
+ rc = submit_abort_firmware(dimm, actx);
+ if (rc < 0)
+ fprintf(stderr, "Aborting update sequence failed.\n");
+ return rc;
+ }
+
+ rc = query_fw_finish_status(dimm, actx);
+ if (rc < 0)
+ return rc;
+
+ return 0;
+}
+
+static int action_update(struct ndctl_dimm *dimm, struct action_context *actx)
+{
+ int rc;
+
+ rc = ndctl_dimm_fw_update_supported(dimm);
+ switch (rc) {
+ case -ENOTTY:
+ error("DIMM firmware update not supported by ndctl.");
+ return rc;
+ case -EOPNOTSUPP:
+ error("DIMM firmware update not supported by the kernel");
+ return rc;
+ case -EIO:
+ error("DIMM firmware update not supported by either platform firmware or the kernel.");
+ return rc;
+ }
+
+ rc = update_verify_input(actx);
+ if (rc < 0)
+ return rc;
+
+ rc = update_firmware(dimm, actx);
+ if (rc < 0)
+ return rc;
+
+ ndctl_cmd_unref(actx->update.start);
+
+ return rc;
+}
+
static struct parameters {
const char *bus;
const char *outfile;
@@ -462,6 +909,10 @@ OPT_BOOLEAN('j', "json", ¶m.json, "parse label data into json")
OPT_STRING('i', "input", ¶m.infile, "input-file", \
"filename to read label area data")
+#define UPDATE_OPTIONS() \
+OPT_STRING('f', "firmware", ¶m.infile, "firmware-file", \
+ "firmware filename for update")
+
#define INIT_OPTIONS() \
OPT_BOOLEAN('f', "force", ¶m.force, \
"force initialization even if existing index-block present"), \
@@ -480,6 +931,12 @@ static const struct option write_options[] = {
OPT_END(),
};
+static const struct option update_options[] = {
+ BASE_OPTIONS(),
+ UPDATE_OPTIONS(),
+ OPT_END(),
+};
+
static const struct option base_options[] = {
BASE_OPTIONS(),
OPT_END(),
@@ -545,9 +1002,13 @@ static int dimm_action(int argc, const char **argv, void *ctx,
}
}
- if (!param.infile)
+ if (!param.infile) {
+ if (action == action_update) {
+ usage_with_options(u, options);
+ return -EINVAL;
+ }
actx.f_in = stdin;
- else {
+ } else {
actx.f_in = fopen(param.infile, "r");
if (!actx.f_in) {
fprintf(stderr, "failed to open: %s: (%s)\n",
@@ -707,3 +1168,13 @@ int cmd_enable_dimm(int argc, const char **argv, void *ctx)
count > 1 ? "s" : "");
return count >= 0 ? 0 : EXIT_FAILURE;
}
+
+int cmd_update_firmware(int argc, const char **argv, void *ctx)
+{
+ int count = dimm_action(argc, argv, ctx, action_update, update_options,
+ "ndctl update-firmware <nmem0> [<nmem1>..<nmemN>] [<options>]");
+
+ fprintf(stderr, "updated %d nmem%s.\n", count >= 0 ? count : 0,
+ count > 1 ? "s" : "");
+ return count >= 0 ? 0 : EXIT_FAILURE;
+}
diff --git a/ndctl/firmware-update.h b/ndctl/firmware-update.h
new file mode 100644
index 00000000..a7576889
--- /dev/null
+++ b/ndctl/firmware-update.h
@@ -0,0 +1,45 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+/* Copyright(c) 2018 Intel Corporation. All rights reserved. */
+
+#ifndef _FIRMWARE_UPDATE_H_
+#define _FIRMWARE_UPDATE_H_
+
+#define ND_CMD_STATUS_SUCCESS 0
+#define ND_CMD_STATUS_NOTSUPP 1
+#define ND_CMD_STATUS_NOTEXIST 2
+#define ND_CMD_STATUS_INVALPARM 3
+#define ND_CMD_STATUS_HWERR 4
+#define ND_CMD_STATUS_RETRY 5
+#define ND_CMD_STATUS_UNKNOWN 6
+#define ND_CMD_STATUS_EXTEND 7
+#define ND_CMD_STATUS_NORES 8
+#define ND_CMD_STATUS_NOTREADY 9
+
+/* extended status through ND_CMD_STATUS_EXTEND */
+#define ND_CMD_STATUS_START_BUSY 0x10000
+#define ND_CMD_STATUS_SEND_CTXINVAL 0x10000
+#define ND_CMD_STATUS_FIN_CTXINVAL 0x10000
+#define ND_CMD_STATUS_FIN_DONE 0x20000
+#define ND_CMD_STATUS_FIN_BAD 0x30000
+#define ND_CMD_STATUS_FIN_ABORTED 0x40000
+#define ND_CMD_STATUS_FQ_CTXINVAL 0x10000
+#define ND_CMD_STATUS_FQ_BUSY 0x20000
+#define ND_CMD_STATUS_FQ_BAD 0x30000
+#define ND_CMD_STATUS_FQ_ORDER 0x40000
+
+struct fw_info {
+ uint32_t store_size;
+ uint32_t update_size;
+ uint32_t query_interval;
+ uint32_t max_query;
+ uint64_t run_version;
+ uint32_t context;
+};
+
+struct update_context {
+ size_t fw_size;
+ struct fw_info dimm_fw;
+ struct ndctl_cmd *start;
+};
+
+#endif
diff --git a/ndctl/update.c b/ndctl/update.c
deleted file mode 100644
index b4ae1ddb..00000000
--- a/ndctl/update.c
+++ /dev/null
@@ -1,558 +0,0 @@
-/* SPDX-License-Identifier: GPL-2.0 */
-/* Copyright(c) 2018 Intel Corporation. All rights reserved. */
-
-#include <stdio.h>
-#include <errno.h>
-#include <stdlib.h>
-#include <limits.h>
-#include <sys/types.h>
-#include <sys/stat.h>
-#include <unistd.h>
-#include <fcntl.h>
-#include <syslog.h>
-#include <time.h>
-#include <sys/time.h>
-#include <sys/file.h>
-
-#include <util/log.h>
-#include <util/size.h>
-#include <util/util.h>
-#include <uuid/uuid.h>
-#include <util/json.h>
-#include <util/filter.h>
-#include <json-c/json.h>
-#include <util/fletcher.h>
-#include <ndctl/libndctl.h>
-#include <ndctl/namespace.h>
-#include <util/parse-options.h>
-#include <ccan/minmax/minmax.h>
-#include <ccan/array_size/array_size.h>
-#ifdef HAVE_NDCTL_H
-#include <linux/ndctl.h>
-#else
-#include <ndctl.h>
-#endif
-
-#include <libndctl-nfit.h>
-#include "private.h"
-#include <builtin.h>
-#include <test.h>
-
-#define ND_CMD_STATUS_SUCCESS 0
-#define ND_CMD_STATUS_NOTSUPP 1
-#define ND_CMD_STATUS_NOTEXIST 2
-#define ND_CMD_STATUS_INVALPARM 3
-#define ND_CMD_STATUS_HWERR 4
-#define ND_CMD_STATUS_RETRY 5
-#define ND_CMD_STATUS_UNKNOWN 6
-#define ND_CMD_STATUS_EXTEND 7
-#define ND_CMD_STATUS_NORES 8
-#define ND_CMD_STATUS_NOTREADY 9
-
-#define ND_CMD_STATUS_START_BUSY 0x10000
-#define ND_CMD_STATUS_SEND_CTXINVAL 0x10000
-#define ND_CMD_STATUS_FIN_CTXINVAL 0x10000
-#define ND_CMD_STATUS_FIN_DONE 0x20000
-#define ND_CMD_STATUS_FIN_BAD 0x30000
-#define ND_CMD_STATUS_FIN_ABORTED 0x40000
-#define ND_CMD_STATUS_FQ_CTXINVAL 0x10000
-#define ND_CMD_STATUS_FQ_BUSY 0x20000
-#define ND_CMD_STATUS_FQ_BAD 0x30000
-#define ND_CMD_STATUS_FQ_ORDER 0x40000
-
-struct fw_info {
- uint32_t store_size;
- uint32_t update_size;
- uint32_t query_interval;
- uint32_t max_query;
- uint64_t run_version;
- uint32_t context;
-};
-
-struct update_context {
- int fw_fd;
- size_t fw_size;
- const char *fw_path;
- const char *dimm_id;
- struct ndctl_dimm *dimm;
- struct fw_info dimm_fw;
- struct ndctl_cmd *start;
-};
-
-/*
- * updating firmware consists of performing the following steps:
- * 1. Call GET_FIMRWARE_INFO DSM. The return results provide:
- * A. Size of the firmware storage area
- * B. Max size per send command
- * C. Polling interval for check finish status
- * D. Max time for finish update poll
- * E. Update capabilities
- * F. Running FIS version
- * G. Running FW revision
- * H. Updated FW revision. Only valid after firmware update done.
- * 2. Call START_FW_UPDATE. The return results provide:
- * A. Ready to start status
- * B. Valid FW update context
- * 3. Call SEND_FW_UPDATE_DATA with valid payload
- * Repeat until done.
- * 4. Call FINISH_FW_UPDATE
- * 5. Poll with QUERY_FINISH_UPDATE success or failure
- */
-
-static int verify_fw_size(struct update_context *uctx)
-{
- struct fw_info *fw = &uctx->dimm_fw;
-
- if (uctx->fw_size > fw->store_size) {
- error("Firmware file size greater than DIMM store\n");
- return -ENOSPC;
- }
-
- return 0;
-}
-
-static int submit_get_firmware_info(struct update_context *uctx)
-{
- struct ndctl_cmd *cmd;
- int rc;
- enum ND_FW_STATUS status;
- struct fw_info *fw = &uctx->dimm_fw;
-
- cmd = ndctl_dimm_cmd_new_fw_get_info(uctx->dimm);
- if (!cmd)
- return -ENXIO;
-
- rc = ndctl_cmd_submit(cmd);
- if (rc < 0)
- return rc;
-
- status = ndctl_cmd_fw_xlat_firmware_status(cmd);
- if (status != FW_SUCCESS) {
- error("GET FIRMWARE INFO failed: %#x\n", status);
- return -ENXIO;
- }
-
- fw->store_size = ndctl_cmd_fw_info_get_storage_size(cmd);
- if (fw->store_size == UINT_MAX)
- return -ENXIO;
-
- fw->update_size = ndctl_cmd_fw_info_get_max_send_len(cmd);
- if (fw->update_size == UINT_MAX)
- return -ENXIO;
-
- fw->query_interval = ndctl_cmd_fw_info_get_query_interval(cmd);
- if (fw->query_interval == UINT_MAX)
- return -ENXIO;
-
- fw->max_query = ndctl_cmd_fw_info_get_max_query_time(cmd);
- if (fw->max_query == UINT_MAX)
- return -ENXIO;
-
- fw->run_version = ndctl_cmd_fw_info_get_run_version(cmd);
- if (fw->run_version == ULLONG_MAX)
- return -ENXIO;
-
- rc = verify_fw_size(uctx);
- ndctl_cmd_unref(cmd);
- return rc;
-}
-
-static int submit_start_firmware_upload(struct update_context *uctx)
-{
- struct ndctl_cmd *cmd;
- int rc;
- enum ND_FW_STATUS status;
- struct fw_info *fw = &uctx->dimm_fw;
-
- cmd = ndctl_dimm_cmd_new_fw_start_update(uctx->dimm);
- if (!cmd)
- return -ENXIO;
-
- rc = ndctl_cmd_submit(cmd);
- if (rc < 0)
- return rc;
-
- status = ndctl_cmd_fw_xlat_firmware_status(cmd);
- if (status != FW_SUCCESS) {
- error("START FIRMWARE UPDATE failed: %#x\n", status);
- if (status == FW_EBUSY)
- error("Another firmware upload in progress or finished.\n");
- return -ENXIO;
- }
-
- fw->context = ndctl_cmd_fw_start_get_context(cmd);
- if (fw->context == UINT_MAX)
- return -ENXIO;
-
- uctx->start = cmd;
-
- return 0;
-}
-
-static int get_fw_data_from_file(int fd, void *buf, uint32_t len,
- uint32_t offset)
-{
- ssize_t rc, total = len;
-
- while (len) {
- rc = pread(fd, buf, len, offset);
- if (rc < 0)
- return -errno;
- len -= rc;
- }
-
- return total;
-}
-
-static int send_firmware(struct update_context *uctx)
-{
- struct ndctl_cmd *cmd = NULL;
- ssize_t read;
- int rc = -ENXIO;
- enum ND_FW_STATUS status;
- struct fw_info *fw = &uctx->dimm_fw;
- uint32_t copied = 0, len, remain;
- void *buf;
-
- buf = malloc(fw->update_size);
- if (!buf)
- return -ENOMEM;
-
- remain = uctx->fw_size;
-
- while (remain) {
- len = min(fw->update_size, remain);
- read = get_fw_data_from_file(uctx->fw_fd, buf, len, copied);
- if (read < 0) {
- rc = read;
- goto cleanup;
- }
-
- cmd = ndctl_dimm_cmd_new_fw_send(uctx->start, copied, read,
- buf);
- if (!cmd) {
- rc = -ENXIO;
- goto cleanup;
- }
-
- rc = ndctl_cmd_submit(cmd);
- if (rc < 0)
- goto cleanup;
-
- status = ndctl_cmd_fw_xlat_firmware_status(cmd);
- if (status != FW_SUCCESS) {
- error("SEND FIRMWARE failed: %#x\n", status);
- rc = -ENXIO;
- goto cleanup;
- }
-
- copied += read;
- remain -= read;
-
- ndctl_cmd_unref(cmd);
- cmd = NULL;
- }
-
-cleanup:
- ndctl_cmd_unref(cmd);
- free(buf);
- return rc;
-}
-
-static int submit_finish_firmware(struct update_context *uctx)
-{
- struct ndctl_cmd *cmd;
- int rc;
- enum ND_FW_STATUS status;
-
- cmd = ndctl_dimm_cmd_new_fw_finish(uctx->start);
- if (!cmd)
- return -ENXIO;
-
- rc = ndctl_cmd_submit(cmd);
- if (rc < 0)
- goto out;
-
- status = ndctl_cmd_fw_xlat_firmware_status(cmd);
- if (status != FW_SUCCESS) {
- error("FINISH FIRMWARE UPDATE failed: %#x\n", status);
- rc = -ENXIO;
- goto out;
- }
-
-out:
- ndctl_cmd_unref(cmd);
- return rc;
-}
-
-static int submit_abort_firmware(struct update_context *uctx)
-{
- struct ndctl_cmd *cmd;
- int rc;
- enum ND_FW_STATUS status;
-
- cmd = ndctl_dimm_cmd_new_fw_abort(uctx->start);
- if (!cmd)
- return -ENXIO;
-
- rc = ndctl_cmd_submit(cmd);
- if (rc < 0)
- goto out;
-
- status = ndctl_cmd_fw_xlat_firmware_status(cmd);
- if (!(status & ND_CMD_STATUS_FIN_ABORTED)) {
- error("FW update abort failed: %#x\n", status);
- rc = -ENXIO;
- goto out;
- }
-
-out:
- ndctl_cmd_unref(cmd);
- return rc;
-}
-
-static int query_fw_finish_status(struct update_context *uctx)
-{
- struct ndctl_cmd *cmd;
- int rc;
- enum ND_FW_STATUS status;
- struct fw_info *fw = &uctx->dimm_fw;
- bool done = false;
- struct timespec now, before, after;
- uint64_t ver;
-
- cmd = ndctl_dimm_cmd_new_fw_finish_query(uctx->start);
- if (!cmd)
- return -ENXIO;
-
- rc = clock_gettime(CLOCK_MONOTONIC, &before);
- if (rc < 0)
- goto out;
-
- now.tv_nsec = fw->query_interval / 1000;
- now.tv_sec = 0;
-
- do {
- rc = ndctl_cmd_submit(cmd);
- if (rc < 0)
- break;
-
- status = ndctl_cmd_fw_xlat_firmware_status(cmd);
- switch (status) {
- case FW_SUCCESS:
- ver = ndctl_cmd_fw_fquery_get_fw_rev(cmd);
- if (ver == 0) {
- printf("No firmware updated\n");
- rc = -ENXIO;
- goto out;
- }
-
- printf("Image %s updated successfully to DIMM %s\n",
- uctx->fw_path, uctx->dimm_id);
- printf("Firmware version %#lx.\n", ver);
- printf("Reboot to activate.\n");
- done = true;
- rc = 0;
- break;
- case FW_EBUSY:
- /* Still on going, continue */
- rc = clock_gettime(CLOCK_MONOTONIC, &after);
- if (rc < 0) {
- rc = -errno;
- goto out;
- }
-
- /*
- * If we expire max query time,
- * we timed out
- */
- if (after.tv_sec - before.tv_sec >
- fw->max_query / 1000000) {
- rc = -ETIMEDOUT;
- goto out;
- }
-
- /*
- * Sleep the interval dictated by firmware
- * before query again.
- */
- rc = nanosleep(&now, NULL);
- if (rc < 0) {
- rc = -errno;
- goto out;
- }
- break;
- case FW_EBADFW:
- printf("Image failed to verify by DIMM\n");
- case FW_EINVAL_CTX:
- case FW_ESEQUENCE:
- done = true;
- rc = -ENXIO;
- goto out;
- case FW_ENORES:
- printf("Firmware update sequence timed out\n");
- rc = -ETIMEDOUT;
- done = true;
- goto out;
- default:
- rc = -EINVAL;
- done = true;
- goto out;
- }
- } while (!done);
-
-out:
- ndctl_cmd_unref(cmd);
- return rc;
-}
-
-static int update_firmware(struct update_context *uctx)
-{
- int rc;
-
- rc = submit_get_firmware_info(uctx);
- if (rc < 0)
- return rc;
-
- rc = submit_start_firmware_upload(uctx);
- if (rc < 0)
- return rc;
-
- printf("Uploading %s to DIMM %s\n", uctx->fw_path, uctx->dimm_id);
-
- rc = send_firmware(uctx);
- if (rc < 0) {
- error("Firmware send failed. Aborting...\n");
- rc = submit_abort_firmware(uctx);
- if (rc < 0)
- error("Aborting update sequence failed\n");
- return rc;
- }
-
- rc = submit_finish_firmware(uctx);
- if (rc < 0) {
- error("Unable to end update sequence\n");
- rc = submit_abort_firmware(uctx);
- if (rc < 0)
- error("Aborting update sequence failed\n");
- return rc;
- }
-
- rc = query_fw_finish_status(uctx);
- if (rc < 0)
- return rc;
-
- return 0;
-}
-
-static int get_ndctl_dimm(struct update_context *uctx, void *ctx)
-{
- struct ndctl_dimm *dimm;
- struct ndctl_bus *bus;
- int rc;
-
- ndctl_bus_foreach(ctx, bus)
- ndctl_dimm_foreach(bus, dimm) {
- if (!util_dimm_filter(dimm, uctx->dimm_id))
- continue;
- rc = ndctl_dimm_fw_update_supported(dimm);
- switch (rc) {
- case -ENOTTY:
- error("DIMM firmware update not supported by ndctl.");
- return rc;
- case -EOPNOTSUPP:
- error("DIMM firmware update not supported by the kernel");
- return rc;
- case -EIO:
- error("DIMM firmware update not supported by platform firmware.");
- return rc;
- }
- uctx->dimm = dimm;
- return 0;
- }
-
- return -ENODEV;
-}
-
-static int verify_fw_file(struct update_context *uctx)
-{
- struct stat st;
- int rc;
-
- uctx->fw_fd = open(uctx->fw_path, O_RDONLY);
- if (uctx->fw_fd < 0)
- return -errno;
-
- if (fstat(uctx->fw_fd, &st) < 0) {
- rc = -errno;
- goto cleanup;
- }
-
- if (!S_ISREG(st.st_mode)) {
- rc = -EINVAL;
- goto cleanup;
- }
-
- uctx->fw_size = st.st_size;
- if (uctx->fw_size == 0) {
- rc = -EINVAL;
- goto cleanup;
- }
-
- return 0;
-
-cleanup:
- close(uctx->fw_fd);
- return rc;
-}
-
-int cmd_update_firmware(int argc, const char **argv, void *ctx)
-{
- struct update_context uctx = { 0 };
- const struct option options[] = {
- OPT_STRING('f', "firmware", &uctx.fw_path,
- "file-name", "name of firmware"),
- OPT_STRING('d', "dimm", &uctx.dimm_id, "dimm-id",
- "dimm to be updated"),
- OPT_END(),
- };
- const char * const u[] = {
- "ndctl update_firmware [<options>]",
- NULL
- };
- int i, rc;
-
- argc = parse_options(argc, argv, options, u, 0);
- for (i = 0; i < argc; i++)
- error("unknown parameter \"%s\"\n", argv[i]);
- if (argc)
- usage_with_options(u, options);
-
- if (!uctx.fw_path) {
- error("No firmware file provided\n");
- usage_with_options(u, options);
- return -EINVAL;
- }
-
- if (!uctx.dimm_id) {
- error("No DIMM ID provided\n");
- usage_with_options(u, options);
- return -EINVAL;
- }
-
- rc = verify_fw_file(&uctx);
- if (rc < 0)
- return rc;
-
- rc = get_ndctl_dimm(&uctx, ctx);
- if (rc < 0)
- return rc;
-
- rc = update_firmware(&uctx);
- if (rc < 0)
- return rc;
-
- ndctl_cmd_unref(uctx.start);
-
- return 0;
-}
_______________________________________________
Linux-nvdimm mailing list
Linux-nvdimm@lists.01.org
https://lists.01.org/mailman/listinfo/linux-nvdimm
^ permalink raw reply related [flat|nested] 4+ messages in thread