From: "Alastair D'Silva" <alastair@au1.ibm.com> To: alastair@d-silva.org Cc: "Benjamin Herrenschmidt" <benh@kernel.crashing.org>, "Paul Mackerras" <paulus@samba.org>, "Michael Ellerman" <mpe@ellerman.id.au>, "Frederic Barrat" <fbarrat@linux.ibm.com>, "Andrew Donnellan" <ajd@linux.ibm.com>, "Arnd Bergmann" <arnd@arndb.de>, "Greg Kroah-Hartman" <gregkh@linuxfoundation.org>, "Andrew Morton" <akpm@linux-foundation.org>, "Mauro Carvalho Chehab" <mchehab+samsung@kernel.org>, "David S. Miller" <davem@davemloft.net>, "Rob Herring" <robh@kernel.org>, "Anton Blanchard" <anton@ozlabs.org>, "Krzysztof Kozlowski" <krzk@kernel.org>, "Mahesh Salgaonkar" <mahesh@linux.vnet.ibm.com>, "Madhavan Srinivasan" <maddy@linux.vnet.ibm.com>, "Cédric Le Goater" <clg@kaod.org>, "Anju T Sudhakar" <anju@linux.vnet.ibm.com>, "Hari Bathini" <hbathini@linux.ibm.com>, "Thomas Gleixner" <tglx@linutronix.de>, "Greg Kurz" <groug@kaod.org>, "Nicholas Piggin" <npiggin@gmail.com>, "Masahiro Yamada" <yamada.masahiro@socionext.com>, "Alexey Kardashevskiy" <aik@ozlabs.ru>, linux-kernel@vger.kernel.org, linuxppc-dev@list Subject: [PATCH v2 21/27] nvdimm/ocxl: Support firmware update via sysfs Date: Tue, 3 Dec 2019 14:46:49 +1100 Message-ID: <20191203034655.51561-22-alastair@au1.ibm.com> (raw) In-Reply-To: <20191203034655.51561-1-alastair@au1.ibm.com> From: Alastair D'Silva <alastair@d-silva.org> This patch allows the firmware of an OpenCAPI SCM card to be update by writing a firmware file to a file in sysfs. Signed-off-by: Alastair D'Silva <alastair@d-silva.org> --- drivers/nvdimm/ocxl/Makefile | 2 +- drivers/nvdimm/ocxl/scm.c | 5 + drivers/nvdimm/ocxl/scm_internal.c | 25 +++++ drivers/nvdimm/ocxl/scm_internal.h | 14 +++ drivers/nvdimm/ocxl/scm_sysfs.c | 163 +++++++++++++++++++++++++++++ 5 files changed, 208 insertions(+), 1 deletion(-) create mode 100644 drivers/nvdimm/ocxl/scm_sysfs.c diff --git a/drivers/nvdimm/ocxl/Makefile b/drivers/nvdimm/ocxl/Makefile index 9b6e31f0eb3e..b172cef39de4 100644 --- a/drivers/nvdimm/ocxl/Makefile +++ b/drivers/nvdimm/ocxl/Makefile @@ -4,4 +4,4 @@ ccflags-$(CONFIG_PPC_WERROR) += -Werror obj-$(CONFIG_OCXL_SCM) += ocxlscm.o -ocxlscm-y := scm.o scm_internal.o +ocxlscm-y := scm.o scm_internal.o scm_sysfs.o diff --git a/drivers/nvdimm/ocxl/scm.c b/drivers/nvdimm/ocxl/scm.c index d482b3213a02..8a30c887b5ed 100644 --- a/drivers/nvdimm/ocxl/scm.c +++ b/drivers/nvdimm/ocxl/scm.c @@ -1503,6 +1503,11 @@ static int scm_probe(struct pci_dev *pdev, const struct pci_device_id *ent) goto err; } + if (scm_sysfs_add(scm_data)) { + dev_err(&pdev->dev, "Could not create SCM sysfs entries\n"); + goto err; + } + elapsed = 0; timeout = scm_data->readiness_timeout + scm_data->memory_available_timeout; while (!scm_is_usable(scm_data)) { diff --git a/drivers/nvdimm/ocxl/scm_internal.c b/drivers/nvdimm/ocxl/scm_internal.c index c405f1d8afb8..8fc849610eaa 100644 --- a/drivers/nvdimm/ocxl/scm_internal.c +++ b/drivers/nvdimm/ocxl/scm_internal.c @@ -210,3 +210,28 @@ void scm_warn_status(const struct scm_data *scm_data, const char *message, dev_warn(&scm_data->dev, "%s: %s (%x)\n", message, text, status); } + +void scm_warn_status_fw_update(const struct scm_data *scm_data, + const char *message, u8 status) +{ + const char *text; + + switch (status) { + case STATUS_FW_UPDATE_BLOCKED: + text = "Firmware update is blocked, please try again later"; + break; + + case STATUS_FW_ARG_INVALID: + text = "Internal error in SCM firmware update mechanism"; + break; + + case STATUS_FW_INVALID: + text = "Firmware content is invalid, please verify firmware update file"; + break; + + default: + return scm_warn_status(scm_data, message, status); + } + + dev_warn(&scm_data->dev, "%s: %s (%x)\n", message, text, status); +} diff --git a/drivers/nvdimm/ocxl/scm_internal.h b/drivers/nvdimm/ocxl/scm_internal.h index 693fd59f8bde..af19813a7f75 100644 --- a/drivers/nvdimm/ocxl/scm_internal.h +++ b/drivers/nvdimm/ocxl/scm_internal.h @@ -137,6 +137,12 @@ struct scm_data { */ }; +/** + * Create sysfs entries for an SCM device + * scm_data: The SCM metadata + */ +int scm_sysfs_add(struct scm_data *scm_data); + /** * scm_chi() - Get the value of the CHI register * @scm_data: The SCM metadata @@ -230,3 +236,11 @@ int scm_ns_response_handled(const struct scm_data *scm_data); void scm_warn_status(const struct scm_data *scm_data, const char *message, u8 status); +/** + * scm_warn_status_fw_update() - Emit a kernel warning showing a command status. + * @scm_data: a pointer to the SCM device data + * @message: A message to accompany the warning + * @status: The command status + */ +void scm_warn_status_fw_update(const struct scm_data *scm_data, + const char *message, u8 status); diff --git a/drivers/nvdimm/ocxl/scm_sysfs.c b/drivers/nvdimm/ocxl/scm_sysfs.c new file mode 100644 index 000000000000..a04e8a74d0c5 --- /dev/null +++ b/drivers/nvdimm/ocxl/scm_sysfs.c @@ -0,0 +1,163 @@ +// SPDX-License-Identifier: GPL-2.0+ +// Copyright 2018 IBM Corp. + +#include <linux/sysfs.h> +#include <linux/capability.h> +#include <linux/limits.h> +#include <linux/firmware.h> +#include "scm_internal.h" + +static ssize_t fw_version_show(struct device *device, + struct device_attribute *attr, char *buf) +{ + struct scm_data *scm_data = container_of(device, struct scm_data, dev); + + return scnprintf(buf, PAGE_SIZE, "%s\n", scm_data->fw_version); +} + +#define SCM_FWUPDATE_BLOCK_SIZE 32768 + +/** + * scm_update_firmware() - Write a 32kB block of data to firmware + * The block may be less than 32kB if it is the last one + * + * scm_data the SCM device metadata + * offset: the offset of the start of the block + * buf: the block data + * size: the size of the block + */ +static ssize_t scm_update_firmware(struct scm_data *scm_data, size_t offset, + const char *buf, size_t size) +{ + int rc; + size_t i; + u64 val; + + if (size > SCM_FWUPDATE_BLOCK_SIZE) + return -EINVAL; + + rc = scm_admin_command_request(scm_data, ADMIN_COMMAND_FW_UPDATE); + if (rc) + return rc; + + val = (((u64)offset) << 32) | size; + rc = ocxl_global_mmio_write64(scm_data->ocxl_afu, + scm_data->admin_command.request_offset + 8, + OCXL_LITTLE_ENDIAN, val); + if (rc) + return rc; + + for (i = 0; i < size; i += 8) { + val = *(u64 *)(buf + i); + rc = ocxl_global_mmio_write64(scm_data->ocxl_afu, + scm_data->admin_command.data_offset + i, + OCXL_HOST_ENDIAN, val); + if (rc) + return rc; + } + + rc = scm_admin_command_execute(scm_data); + if (rc) + return rc; + + rc = scm_admin_command_complete_timeout(scm_data, + ADMIN_COMMAND_FW_UPDATE); + if (rc < 0) { + dev_err(&scm_data->dev, "Firmware update timeout\n"); + return rc; + } + + rc = scm_admin_response(scm_data); + if (rc < 0) + return rc; + if (rc != STATUS_SUCCESS) { + scm_warn_status_fw_update(scm_data, "FW Update", rc); + return rc; + } + + return 0; +} + +/* + * Parse out a firmware filename from sysfs, retrieve it's contents and write it + * to the SCM device firmware storage + */ +static ssize_t fw_update_filename_store(struct device *device, + struct device_attribute *attr, + const char *buf, size_t size) +{ + char path[NAME_MAX+1]; + const char *end; + const struct firmware *firmware = NULL; + size_t offset; + int rc; + struct scm_data *scm_data = container_of(device, struct scm_data, dev); + + if (!capable(CAP_SYS_ADMIN)) + return -EACCES; + + end = strnchr(buf, size, '\n'); + if (end == NULL) + end = buf + strnlen(buf, size); + + if ((end - buf) > NAME_MAX) { + dev_err(device, "Firmware filename '%-.*s' too long\n", + (int)(end - buf), buf); + return -EIO; + } + + memcpy(path, buf, end - buf); + path[end - buf] = '\0'; + + if (request_firmware(&firmware, path, device)) { + dev_err(device, "Firmware file %s not found\n", path); + return -EIO; + } + + if (firmware->size % 8) { + release_firmware(firmware); + dev_err(device, "Firmware '%s' should be a multiple of 8 bytes", path); + return -EINVAL; + } + + mutex_lock(&scm_data->admin_command.lock); + + for (offset = 0; offset < firmware->size; offset += SCM_FWUPDATE_BLOCK_SIZE) { + size_t remainder = firmware->size - offset; + size_t block_size; + + block_size = (remainder > SCM_FWUPDATE_BLOCK_SIZE) ? + SCM_FWUPDATE_BLOCK_SIZE : remainder; + rc = scm_update_firmware(scm_data, offset, + firmware->data + offset, block_size); + if (rc) { + mutex_unlock(&scm_data->admin_command.lock); + return -EFAULT; + } + } + + mutex_unlock(&scm_data->admin_command.lock); + + return size; +} + +static struct device_attribute scm_attrs[] = { + __ATTR_RO(fw_version), + __ATTR_WO(fw_update_filename), +}; + +int scm_sysfs_add(struct scm_data *scm_data) +{ + int i, rc; + + for (i = 0; i < ARRAY_SIZE(scm_attrs); i++) { + rc = device_create_file(&scm_data->dev, &scm_attrs[i]); + if (rc) { + for (; --i >= 0;) + device_remove_file(&scm_data->dev, &scm_attrs[i]); + + return rc; + } + } + return 0; +} -- 2.23.0 _______________________________________________ Linux-nvdimm mailing list -- linux-nvdimm@lists.01.org To unsubscribe send an email to linux-nvdimm-leave@lists.01.org
next prev parent reply index Thread overview: 67+ messages / expand[flat|nested] mbox.gz Atom feed top 2019-12-03 3:46 [PATCH v2 00/27] Add support for OpenCAPI SCM devices Alastair D'Silva 2019-12-03 3:46 ` [PATCH v2 01/27] memory_hotplug: Add a bounds check to __add_pages Alastair D'Silva 2019-12-03 3:46 ` [PATCH v2 02/27] nvdimm: remove prototypes for nonexistent functions Alastair D'Silva 2019-12-03 4:47 ` Andrew Donnellan 2019-12-04 0:10 ` Dan Williams 2020-01-23 21:49 ` Dan Williams 2019-12-03 3:46 ` [PATCH v2 03/27] powerpc: Add OPAL calls for LPC memory alloc/release Alastair D'Silva 2019-12-03 3:46 ` [PATCH v2 04/27] mm/memory_hotplug: Allow check_hotplug_memory_addressable to be called from drivers Alastair D'Silva 2019-12-03 3:46 ` [PATCH v2 05/27] powerpc: Map & release OpenCAPI LPC memory Alastair D'Silva 2020-01-09 14:41 ` Frederic Barrat 2020-01-21 6:46 ` Andrew Donnellan 2020-01-21 7:11 ` Greg Kurz 2020-02-14 11:09 ` Frederic Barrat 2020-02-18 23:44 ` Alastair D'Silva 2019-12-03 3:46 ` [PATCH v2 06/27] ocxl: Tally up the LPC memory on a link & allow it to be mapped Alastair D'Silva 2020-01-09 14:48 ` Frederic Barrat 2020-02-03 12:37 ` Jonathan Cameron 2020-02-19 0:01 ` Alastair D'Silva 2019-12-03 3:46 ` [PATCH v2 07/27] ocxl: Add functions to map/unmap LPC memory Alastair D'Silva 2020-01-09 14:49 ` Frederic Barrat 2020-02-03 12:49 ` Jonathan Cameron 2020-02-19 2:39 ` Alastair D'Silva 2019-12-03 3:46 ` [PATCH v2 08/27] ocxl: Save the device serial number in ocxl_fn Alastair D'Silva 2020-02-03 12:53 ` Jonathan Cameron 2020-02-19 4:03 ` Alastair D'Silva 2019-12-03 3:46 ` [PATCH v2 09/27] ocxl: Free detached contexts in ocxl_context_detach_all() Alastair D'Silva 2020-01-09 14:54 ` Frederic Barrat 2019-12-03 3:46 ` [PATCH v2 10/27] nvdimm: Add driver for OpenCAPI Storage Class Memory Alastair D'Silva 2019-12-03 5:05 ` Alastair D'Silva 2020-02-03 13:20 ` Jonathan Cameron 2020-02-19 4:40 ` Alastair D'Silva 2019-12-03 3:46 ` [PATCH v2 11/27] nvdimm/ocxl: Add register addresses & status values to header Alastair D'Silva 2019-12-03 3:46 ` [PATCH v2 12/27] nvdimm/ocxl: Read the capability registers & wait for device ready Alastair D'Silva 2020-02-03 13:23 ` Jonathan Cameron 2020-02-19 4:46 ` Alastair D'Silva 2019-12-03 3:46 ` [PATCH v2 13/27] nvdimm/ocxl: Add support for Admin commands Alastair D'Silva 2020-02-03 14:18 ` Jonathan Cameron 2020-02-19 5:00 ` Alastair D'Silva 2019-12-03 3:46 ` [PATCH v2 14/27] nvdimm/ocxl: Add support for near storage commands Alastair D'Silva 2020-02-03 14:22 ` Jonathan Cameron 2020-02-19 4:54 ` Alastair D'Silva 2019-12-03 3:46 ` [PATCH v2 15/27] nvdimm/ocxl: Register a character device for userspace to interact with Alastair D'Silva 2019-12-03 3:46 ` [PATCH v2 16/27] nvdimm/ocxl: Implement the Read Error Log command Alastair D'Silva 2019-12-05 3:42 ` Alastair D'Silva 2019-12-05 19:34 ` kbuild test robot 2019-12-03 3:46 ` [PATCH v2 17/27] nvdimm/ocxl: Add controller dump IOCTLs Alastair D'Silva 2019-12-03 3:46 ` [PATCH v2 18/27] nvdimm/ocxl: Add an IOCTL to report controller statistics Alastair D'Silva 2019-12-03 3:46 ` [PATCH v2 19/27] nvdimm/ocxl: Forward events to userspace Alastair D'Silva 2019-12-03 3:46 ` [PATCH v2 20/27] nvdimm/ocxl: Add an IOCTL to request controller health & perf data Alastair D'Silva 2019-12-03 3:46 ` Alastair D'Silva [this message] 2019-12-03 3:46 ` [PATCH v2 22/27] nvdimm/ocxl: Implement the heartbeat command Alastair D'Silva 2020-02-03 15:11 ` Jonathan Cameron 2020-02-19 5:02 ` Alastair D'Silva 2019-12-03 3:46 ` [PATCH v2 23/27] nvdimm/ocxl: Add debug IOCTLs Alastair D'Silva 2019-12-03 3:46 ` [PATCH v2 24/27] nvdimm/ocxl: Implement Overwrite Alastair D'Silva 2020-02-03 15:10 ` Jonathan Cameron 2020-02-19 5:13 ` Alastair D'Silva 2019-12-03 3:46 ` [PATCH v2 25/27] nvdimm/ocxl: Expose SMART data via ndctl Alastair D'Silva 2019-12-16 0:15 ` Alastair D'Silva 2019-12-03 3:46 ` [PATCH v2 26/27] powerpc: Enable OpenCAPI Storage Class Memory driver on bare metal Alastair D'Silva 2019-12-03 4:54 ` Andrew Donnellan 2019-12-03 4:57 ` Alastair D'Silva 2019-12-03 3:46 ` [PATCH v2 27/27] MAINTAINERS: Add myself & nvdimm/ocxl to ocxl Alastair D'Silva 2019-12-03 3:50 ` [PATCH v2 00/27] Add support for OpenCAPI SCM devices Matthew Wilcox 2019-12-03 4:01 ` Alastair D'Silva 2019-12-03 12:42 ` Matthew Wilcox 2019-12-04 0:15 ` Dan Williams
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=20191203034655.51561-22-alastair@au1.ibm.com \ --to=alastair@au1.ibm.com \ --cc=aik@ozlabs.ru \ --cc=ajd@linux.ibm.com \ --cc=akpm@linux-foundation.org \ --cc=alastair@d-silva.org \ --cc=anju@linux.vnet.ibm.com \ --cc=anton@ozlabs.org \ --cc=arnd@arndb.de \ --cc=benh@kernel.crashing.org \ --cc=clg@kaod.org \ --cc=davem@davemloft.net \ --cc=fbarrat@linux.ibm.com \ --cc=gregkh@linuxfoundation.org \ --cc=groug@kaod.org \ --cc=hbathini@linux.ibm.com \ --cc=krzk@kernel.org \ --cc=linux-kernel@vger.kernel.org \ --cc=linuxppc-dev@list \ --cc=maddy@linux.vnet.ibm.com \ --cc=mahesh@linux.vnet.ibm.com \ --cc=mchehab+samsung@kernel.org \ --cc=mpe@ellerman.id.au \ --cc=npiggin@gmail.com \ --cc=paulus@samba.org \ --cc=robh@kernel.org \ --cc=tglx@linutronix.de \ --cc=yamada.masahiro@socionext.com \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: link
Linux-NVDIMM Archive on lore.kernel.org Archives are clonable: git clone --mirror https://lore.kernel.org/linux-nvdimm/0 linux-nvdimm/git/0.git # If you have public-inbox 1.1+ installed, you may # initialize and index your mirror using the following commands: public-inbox-init -V2 linux-nvdimm linux-nvdimm/ https://lore.kernel.org/linux-nvdimm \ linux-nvdimm@lists.01.org public-inbox-index linux-nvdimm Example config snippet for mirrors Newsgroup available over NNTP: nntp://nntp.lore.kernel.org/org.01.lists.linux-nvdimm AGPL code for this site: git clone https://public-inbox.org/public-inbox.git