From patchwork Wed Oct 27 07:07:24 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Chen Yu X-Patchwork-Id: 12586491 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 17A2CC433F5 for ; Wed, 27 Oct 2021 07:08:16 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id F0894610F8 for ; Wed, 27 Oct 2021 07:08:15 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S240303AbhJ0HKj (ORCPT ); Wed, 27 Oct 2021 03:10:39 -0400 Received: from mga03.intel.com ([134.134.136.65]:2286 "EHLO mga03.intel.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S240291AbhJ0HKi (ORCPT ); Wed, 27 Oct 2021 03:10:38 -0400 X-IronPort-AV: E=McAfee;i="6200,9189,10149"; a="230039154" X-IronPort-AV: E=Sophos;i="5.87,186,1631602800"; d="scan'208";a="230039154" Received: from fmsmga001.fm.intel.com ([10.253.24.23]) by orsmga103.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 27 Oct 2021 00:08:12 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.87,186,1631602800"; d="scan'208";a="635605540" Received: from chenyu-desktop.sh.intel.com ([10.239.158.186]) by fmsmga001.fm.intel.com with ESMTP; 27 Oct 2021 00:08:09 -0700 From: Chen Yu To: linux-acpi@vger.kernel.org Cc: Greg Kroah-Hartman , "Rafael J. Wysocki" , Ard Biesheuvel , Len Brown , Ashok Raj , Andy Shevchenko , Mike Rapoport , Aubrey Li , Chen Yu , linux-kernel@vger.kernel.org, linux-efi@vger.kernel.org Subject: [PATCH v7 1/4] efi: Introduce EFI_FIRMWARE_MANAGEMENT_CAPSULE_HEADER and corresponding structures Date: Wed, 27 Oct 2021 15:07:24 +0800 Message-Id: <4898b5784e79b89bb25ce91384427b5ca3547b8f.1635317102.git.yu.c.chen@intel.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: References: MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-acpi@vger.kernel.org Platform Firmware Runtime Update image starts with UEFI headers, and the headers are defined in UEFI specification, but some of them have not been defined in the kernel yet. For example, the header layout of a capsule file looks like this: EFI_CAPSULE_HEADER EFI_FIRMWARE_MANAGEMENT_CAPSULE_HEADER EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER EFI_FIRMWARE_IMAGE_AUTHENTICATION These structures would be used by the Platform Firmware Runtime Update driver to parse the format of capsule file to verify if the corresponding version number is valid. The EFI_CAPSULE_HEADER has been defined in the kernel, however the rest are not, thus introduce corresponding UEFI structures accordingly. Besides, EFI_FIRMWARE_MANAGEMENT_CAPSULE_HEADER and EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER are required to be packed in the uefi specification. And Ard has pointed out that, the __packed attribute does indicate to the compiler that the entire thing can appear misaligned in memory. So if one follows the other in the capsule header, the __packed attribute may be appropriate to ensure that the second one is not accessed using misaligned loads and stores. Signed-off-by: Chen Yu --- v7: Use __packed instead of pragma pack(1). (Greg Kroah-Hartman, Ard Biesheuve) v6: No change since v5. v5: No change since v4. v4: Revise the commit log to make it more clear. (Rafael J. Wysocki) --- include/linux/efi.h | 46 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) diff --git a/include/linux/efi.h b/include/linux/efi.h index 6b5d36babfcc..f4acdb52cdfb 100644 --- a/include/linux/efi.h +++ b/include/linux/efi.h @@ -148,6 +148,52 @@ typedef struct { u32 imagesize; } efi_capsule_header_t; +/* EFI_FIRMWARE_MANAGEMENT_CAPSULE_HEADER */ +struct efi_manage_capsule_header { + u32 ver; + u16 emb_drv_cnt; + u16 payload_cnt; + /* + * Variable array indicated by number of + * (emb_drv_cnt + payload_cnt) + */ + u64 offset_list[]; +} __packed; + +/* EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER */ +struct efi_manage_capsule_image_header { + u32 ver; + guid_t image_type_id; + u8 image_index; + u8 reserved_bytes[3]; + u32 image_size; + u32 vendor_code_size; + /* ver = 2. */ + u64 hw_ins; + /* ver = v3. */ + u64 capsule_support; +} __packed; + +/* WIN_CERTIFICATE */ +struct win_cert { + u32 len; + u16 rev; + u16 cert_type; +}; + +/* WIN_CERTIFICATE_UEFI_GUID */ +struct win_cert_uefi_guid { + struct win_cert hdr; + guid_t cert_type; + u8 cert_data[]; +}; + +/* EFI_FIRMWARE_IMAGE_AUTHENTICATIO */ +struct efi_image_auth { + u64 mon_count; + struct win_cert_uefi_guid auth_info; +}; + /* * EFI capsule flags */ From patchwork Wed Oct 27 07:07:51 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Chen Yu X-Patchwork-Id: 12586493 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 41280C433F5 for ; Wed, 27 Oct 2021 07:08:57 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 22C0061073 for ; Wed, 27 Oct 2021 07:08:57 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S238413AbhJ0HLU (ORCPT ); Wed, 27 Oct 2021 03:11:20 -0400 Received: from mga02.intel.com ([134.134.136.20]:23456 "EHLO mga02.intel.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S238363AbhJ0HLU (ORCPT ); Wed, 27 Oct 2021 03:11:20 -0400 X-IronPort-AV: E=McAfee;i="6200,9189,10149"; a="217263503" X-IronPort-AV: E=Sophos;i="5.87,186,1631602800"; d="scan'208";a="217263503" Received: from fmsmga001.fm.intel.com ([10.253.24.23]) by orsmga101.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 27 Oct 2021 00:08:32 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.87,186,1631602800"; d="scan'208";a="635605673" Received: from chenyu-desktop.sh.intel.com ([10.239.158.186]) by fmsmga001.fm.intel.com with ESMTP; 27 Oct 2021 00:08:29 -0700 From: Chen Yu To: linux-acpi@vger.kernel.org Cc: Greg Kroah-Hartman , "Rafael J. Wysocki" , Ard Biesheuvel , Len Brown , Ashok Raj , Andy Shevchenko , Mike Rapoport , Aubrey Li , Chen Yu , linux-kernel@vger.kernel.org Subject: [PATCH v7 2/4] drivers/acpi: Introduce Platform Firmware Runtime Update device driver Date: Wed, 27 Oct 2021 15:07:51 +0800 Message-Id: X-Mailer: git-send-email 2.25.1 In-Reply-To: References: MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-acpi@vger.kernel.org Introduce the pfru_update driver which can be used for Platform Firmware Runtime code injection and driver update [1]. The user is expected to provide the update firmware in the form of capsule file, and pass it to the driver via ioctl. Then the driver would hand this capsule file to the Platform Firmware Runtime Update via the ACPI device _DSM method. At last the low level Management Mode would do the firmware update. The corresponding userspace tool and man page will be introduced at tools/power/acpi/pfru. Link: https://uefi.org/sites/default/files/resources/Intel_MM_OS_Interface_Spec_Rev100.pdf # [1] Signed-off-by: Chen Yu --- v7: Use ida_alloc() to allocate a ID, and release the ID when device is removed. (Greg Kroah-Hartman) Check the _DSM method at early stage, before allocate or parse anything in acpi_pfru_probe(). (Greg Kroah-Hartman) Set the parent of the misc device. (Greg Kroah-Hartman) Use module_platform_driver() instead of platform_driver_register() in module_init(). Separate pfru driver and pfru_telemetry driver to two files. (Greg Kroah-Hartman) v6: Use Link: tag to add the specification download address. (Andy Shevchenko) Remove linux/uuid.h and use raw buffers to contain uuid. (Andy Shevchenko) Drop comma for each terminator entry in the enum structure. (Andy Shevchenko) Remove redundant 'else' in get_image_type(). (Andy Shevchenko) Directly return results from the switch cases in adjust_efi_size() and pfru_ioctl().(Andy Shevchenko) Keep comment style consistent by removing the period for one line comment. (Andy Shevchenko) Remove devm_kfree() if .probe() failed. (Andy Shevchenko) v5: Remove Documentation/ABI/pfru, and move the content to kernel doc in include/uapi/linux/pfru.h (Greg Kroah-Hartman) Shrink the range of ioctl numbers declared in Documentation/userspace-api/ioctl/ioctl-number.rst from 16 to 8. (Greg Kroah-Hartman) Change global variable struct pfru_device *pfru_dev to per ACPI device. (Greg Kroah-Hartman) Unregister the misc device in acpi_pfru_remove(). (Greg Kroah-Hartman) Convert the kzalloc() to devm_kzalloc() in the driver so as to avoid freeing the memory. (Greg Kroah-Hartman) Fix the compile error by declaring the pfru_log_ioctl() as static. (kernel test robot LKP) Change to global variable misc_device to per ACPI device. (Greg Kroah-Hartman) v4: Replace all pr_err() with dev_dbg() (Greg Kroah-Hartman, Rafael J. Wysocki) Returns ENOTTY rather than ENOIOCTLCMD if invalid ioctl command is provided. (Greg Kroah-Hartman) Remove compat ioctl. (Greg Kroah-Hartman) Rename /dev/pfru/pfru_update to /dev/acpi_pfru (Greg Kroah-Hartman) Simplify the check for element of the package in query_capability() (Rafael J. Wysocki) Remove the loop in query_capability(), query_buffer() and query the package elemenet directly. (Rafael J. Wysocki) Check the the number of elements in case the number of package elements is too small. (Rafael J. Wysocki) Doing the assignment as initialization in get_image_type(). Meanwhile, returns the type or a negative error code in get_image_type(). (Rafael J. Wysocki) Put the comments inside the function. (Rafael J. Wysocki) Returns the size or a negative error code in adjust_efi_size() (Rafael J. Wysocki) Fix the return value from EFAULT to EINVAL if pfru_valid_revid() does not pass. (Rafael J. Wysocki) Change the write() to be the code injection/update, the read() to be telemetry retrieval and all of the rest to be ioctl()s under one special device file.(Rafael J. Wysocki) Putting empty code lines after an if () statement that is not followed by a block. (Rafael J. Wysocki) Remove "goto" tags to make the code more readable. (Rafael J. Wysocki) v3: Use __u32 instead of int and __64 instead of unsigned long in include/uapi/linux/pfru.h (Greg Kroah-Hartman) Rename the structure in uapi to start with a prefix pfru so as to avoid confusing in the global namespace. (Greg Kroah-Hartman) v2: Add sanity check for duplicated instance of ACPI device. Update the driver to work with allocated pfru_device objects. (Mike Rapoport) For each switch case pair, get rid of the magic case numbers and add a default clause with the error handling. (Mike Rapoport) Move the obj->type checks outside the switch to reduce redundancy. (Mike Rapoport) Parse the code_inj_id and drv_update_id at driver initialization time to reduce the re-parsing at runtime.(Mike Rapoport) Explain in detail how the size needs to be adjusted when doing version check.(Mike Rapoport) Rename parse_update_result() to dump_update_result()(Mike Rapoport) Remove redundant return.(Mike Rapoport) Do not expose struct capsulate_buf_info to uapi, since it is not needed in userspace.(Mike Rapoport) --- .../userspace-api/ioctl/ioctl-number.rst | 1 + drivers/acpi/Kconfig | 1 + drivers/acpi/Makefile | 1 + drivers/acpi/pfru/Kconfig | 13 + drivers/acpi/pfru/Makefile | 2 + drivers/acpi/pfru/pfru_update.c | 572 ++++++++++++++++++ include/uapi/linux/pfru.h | 186 ++++++ 7 files changed, 776 insertions(+) create mode 100644 drivers/acpi/pfru/Kconfig create mode 100644 drivers/acpi/pfru/Makefile create mode 100644 drivers/acpi/pfru/pfru_update.c create mode 100644 include/uapi/linux/pfru.h diff --git a/Documentation/userspace-api/ioctl/ioctl-number.rst b/Documentation/userspace-api/ioctl/ioctl-number.rst index 2e8134059c87..6f7c86b6deb7 100644 --- a/Documentation/userspace-api/ioctl/ioctl-number.rst +++ b/Documentation/userspace-api/ioctl/ioctl-number.rst @@ -365,6 +365,7 @@ Code Seq# Include File Comments 0xE5 00-3F linux/fuse.h 0xEC 00-01 drivers/platform/chrome/cros_ec_dev.h ChromeOS EC driver +0xEE 00-08 uapi/linux/pfru.h Platform Firmware Runtime Update and Telemetry 0xF3 00-3F drivers/usb/misc/sisusbvga/sisusb.h sisfb (in development) 0xF6 all LTTng Linux Trace Toolkit Next Generation diff --git a/drivers/acpi/Kconfig b/drivers/acpi/Kconfig index 1da360c51d66..1d8d2e2cefac 100644 --- a/drivers/acpi/Kconfig +++ b/drivers/acpi/Kconfig @@ -482,6 +482,7 @@ source "drivers/acpi/nfit/Kconfig" source "drivers/acpi/numa/Kconfig" source "drivers/acpi/apei/Kconfig" source "drivers/acpi/dptf/Kconfig" +source "drivers/acpi/pfru/Kconfig" config ACPI_WATCHDOG bool diff --git a/drivers/acpi/Makefile b/drivers/acpi/Makefile index 3018714e87d9..9c2c5ddff6ec 100644 --- a/drivers/acpi/Makefile +++ b/drivers/acpi/Makefile @@ -102,6 +102,7 @@ obj-$(CONFIG_ACPI_CPPC_LIB) += cppc_acpi.o obj-$(CONFIG_ACPI_SPCR_TABLE) += spcr.o obj-$(CONFIG_ACPI_DEBUGGER_USER) += acpi_dbg.o obj-$(CONFIG_ACPI_PPTT) += pptt.o +obj-$(CONFIG_ACPI_PFRU) += pfru/ # processor has its own "processor." module_param namespace processor-y := processor_driver.o diff --git a/drivers/acpi/pfru/Kconfig b/drivers/acpi/pfru/Kconfig new file mode 100644 index 000000000000..5b31675b173a --- /dev/null +++ b/drivers/acpi/pfru/Kconfig @@ -0,0 +1,13 @@ +# SPDX-License-Identifier: GPL-2.0 +config ACPI_PFRU + tristate "ACPI Platform Firmware Runtime Update (PFRU)" + depends on 64BIT + help + In order to reduce the system reboot times and update the platform firmware + in time, Platform Firmware Runtime Update is leveraged to patch the system + without reboot. This driver supports Platform Firmware Runtime Update, + which is composed of two parts: code injection and driver update. It also + allows telemetry data to be retrieved from the platform firmware. + + To compile this driver as a module, choose M here: + the module will be called pfru_update. diff --git a/drivers/acpi/pfru/Makefile b/drivers/acpi/pfru/Makefile new file mode 100644 index 000000000000..098cbe80cf3d --- /dev/null +++ b/drivers/acpi/pfru/Makefile @@ -0,0 +1,2 @@ +# SPDX-License-Identifier: GPL-2.0-only +obj-$(CONFIG_ACPI_PFRU) += pfru_update.o diff --git a/drivers/acpi/pfru/pfru_update.c b/drivers/acpi/pfru/pfru_update.c new file mode 100644 index 000000000000..a9953eb6c2d5 --- /dev/null +++ b/drivers/acpi/pfru/pfru_update.c @@ -0,0 +1,572 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * ACPI Platform Firmware Runtime Update Device Driver + * + * Copyright (C) 2021 Intel Corporation + * Author: Chen Yu + */ +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +enum cap_index { + CAP_STATUS_IDX, + CAP_UPDATE_IDX, + CAP_CODE_TYPE_IDX, + CAP_FW_VER_IDX, + CAP_CODE_RT_VER_IDX, + CAP_DRV_TYPE_IDX, + CAP_DRV_RT_VER_IDX, + CAP_DRV_SVN_IDX, + CAP_PLAT_ID_IDX, + CAP_OEM_ID_IDX, + CAP_OEM_INFO_IDX, + CAP_NR_IDX +}; + +enum buf_index { + BUF_STATUS_IDX, + BUF_EXT_STATUS_IDX, + BUF_ADDR_LOW_IDX, + BUF_ADDR_HI_IDX, + BUF_SIZE_IDX, + BUF_NR_IDX +}; + +enum update_index { + UPDATE_STATUS_IDX, + UPDATE_EXT_STATUS_IDX, + UPDATE_AUTH_TIME_LOW_IDX, + UPDATE_AUTH_TIME_HI_IDX, + UPDATE_EXEC_TIME_LOW_IDX, + UPDATE_EXEC_TIME_HI_IDX, + UPDATE_NR_IDX +}; + +struct pfru_device { + guid_t uuid, code_uuid, drv_uuid; + int rev_id, index; + struct device *dev; + struct miscdevice miscdev; +}; + +static DEFINE_IDA(pfru_ida); + +static inline struct pfru_device *to_pfru_dev(struct file *file) +{ + return container_of(file->private_data, struct pfru_device, miscdev); +} + +static int query_capability(struct pfru_update_cap_info *cap, + struct pfru_device *pfru_dev) +{ + union acpi_object *out_obj; + acpi_handle handle; + int ret = -EINVAL; + + handle = ACPI_HANDLE(pfru_dev->dev); + out_obj = acpi_evaluate_dsm_typed(handle, &pfru_dev->uuid, + pfru_dev->rev_id, + FUNC_QUERY_UPDATE_CAP, + NULL, ACPI_TYPE_PACKAGE); + if (!out_obj) + return ret; + + if (out_obj->package.count < CAP_NR_IDX) + goto free_acpi_buffer; + + if (out_obj->package.elements[CAP_STATUS_IDX].type != ACPI_TYPE_INTEGER) + goto free_acpi_buffer; + + cap->status = out_obj->package.elements[CAP_STATUS_IDX].integer.value; + + if (out_obj->package.elements[CAP_UPDATE_IDX].type != ACPI_TYPE_INTEGER) + goto free_acpi_buffer; + + cap->update_cap = out_obj->package.elements[CAP_UPDATE_IDX].integer.value; + + if (out_obj->package.elements[CAP_CODE_TYPE_IDX].type != ACPI_TYPE_BUFFER) + goto free_acpi_buffer; + + memcpy(&cap->code_type, + out_obj->package.elements[CAP_CODE_TYPE_IDX].buffer.pointer, + out_obj->package.elements[CAP_CODE_TYPE_IDX].buffer.length); + + if (out_obj->package.elements[CAP_FW_VER_IDX].type != ACPI_TYPE_INTEGER) + goto free_acpi_buffer; + + cap->fw_version = + out_obj->package.elements[CAP_FW_VER_IDX].integer.value; + + if (out_obj->package.elements[CAP_CODE_RT_VER_IDX].type != ACPI_TYPE_INTEGER) + goto free_acpi_buffer; + + cap->code_rt_version = + out_obj->package.elements[CAP_CODE_RT_VER_IDX].integer.value; + + if (out_obj->package.elements[CAP_DRV_TYPE_IDX].type != ACPI_TYPE_BUFFER) + goto free_acpi_buffer; + + memcpy(&cap->drv_type, + out_obj->package.elements[CAP_DRV_TYPE_IDX].buffer.pointer, + out_obj->package.elements[CAP_DRV_TYPE_IDX].buffer.length); + + if (out_obj->package.elements[CAP_DRV_RT_VER_IDX].type != ACPI_TYPE_INTEGER) + goto free_acpi_buffer; + + cap->drv_rt_version = + out_obj->package.elements[CAP_DRV_RT_VER_IDX].integer.value; + + if (out_obj->package.elements[CAP_DRV_SVN_IDX].type != ACPI_TYPE_INTEGER) + goto free_acpi_buffer; + + cap->drv_svn = + out_obj->package.elements[CAP_DRV_SVN_IDX].integer.value; + + if (out_obj->package.elements[CAP_PLAT_ID_IDX].type != ACPI_TYPE_BUFFER) + goto free_acpi_buffer; + + memcpy(&cap->platform_id, + out_obj->package.elements[CAP_PLAT_ID_IDX].buffer.pointer, + out_obj->package.elements[CAP_PLAT_ID_IDX].buffer.length); + + if (out_obj->package.elements[CAP_OEM_ID_IDX].type != ACPI_TYPE_BUFFER) + goto free_acpi_buffer; + + memcpy(&cap->oem_id, + out_obj->package.elements[CAP_OEM_ID_IDX].buffer.pointer, + out_obj->package.elements[CAP_OEM_ID_IDX].buffer.length); + ret = 0; +free_acpi_buffer: + ACPI_FREE(out_obj); + + return ret; +} + +static int query_buffer(struct pfru_com_buf_info *info, + struct pfru_device *pfru_dev) +{ + union acpi_object *out_obj; + acpi_handle handle; + int ret = -EINVAL; + + handle = ACPI_HANDLE(pfru_dev->dev); + out_obj = acpi_evaluate_dsm_typed(handle, &pfru_dev->uuid, + pfru_dev->rev_id, FUNC_QUERY_BUF, + NULL, ACPI_TYPE_PACKAGE); + if (!out_obj) + return ret; + + if (out_obj->package.count < BUF_NR_IDX) + goto free_acpi_buffer; + + if (out_obj->package.elements[BUF_STATUS_IDX].type != ACPI_TYPE_INTEGER) + goto free_acpi_buffer; + + info->status = out_obj->package.elements[BUF_STATUS_IDX].integer.value; + + if (out_obj->package.elements[BUF_EXT_STATUS_IDX].type != ACPI_TYPE_INTEGER) + goto free_acpi_buffer; + + info->ext_status = + out_obj->package.elements[BUF_EXT_STATUS_IDX].integer.value; + + if (out_obj->package.elements[BUF_ADDR_LOW_IDX].type != ACPI_TYPE_INTEGER) + goto free_acpi_buffer; + + info->addr_lo = + out_obj->package.elements[BUF_ADDR_LOW_IDX].integer.value; + + if (out_obj->package.elements[BUF_ADDR_HI_IDX].type != ACPI_TYPE_INTEGER) + goto free_acpi_buffer; + + info->addr_hi = + out_obj->package.elements[BUF_ADDR_HI_IDX].integer.value; + + if (out_obj->package.elements[BUF_SIZE_IDX].type != ACPI_TYPE_INTEGER) + goto free_acpi_buffer; + + info->buf_size = out_obj->package.elements[BUF_SIZE_IDX].integer.value; + + ret = 0; +free_acpi_buffer: + ACPI_FREE(out_obj); + + return ret; +} + +static int get_image_type(struct efi_manage_capsule_image_header *img_hdr, + struct pfru_device *pfru_dev) +{ + guid_t *image_type_id = &img_hdr->image_type_id; + + /* check whether this is a code injection or driver update */ + if (guid_equal(image_type_id, &pfru_dev->code_uuid)) + return CODE_INJECT_TYPE; + + if (guid_equal(image_type_id, &pfru_dev->drv_uuid)) + return DRIVER_UPDATE_TYPE; + + return -EINVAL; +} + +static int adjust_efi_size(struct efi_manage_capsule_image_header *img_hdr, + int size) +{ + /* + * The (u64 hw_ins) was introduced in UEFI spec version 2, + * and (u64 capsule_support) was introduced in version 3. + * The size needs to be adjusted accordingly. That is to + * say, version 1 should subtract the size of hw_ins+capsule_support, + * and version 2 should sbstract the size of capsule_support. + */ + size += sizeof(struct efi_manage_capsule_image_header); + switch (img_hdr->ver) { + case 1: + return size - 2 * sizeof(u64); + case 2: + return size - sizeof(u64); + default: + /* only support version 1 and 2 */ + return -EINVAL; + } +} + +static bool valid_version(const void *data, struct pfru_update_cap_info *cap, + struct pfru_device *pfru_dev) +{ + struct pfru_payload_hdr *payload_hdr; + efi_capsule_header_t *cap_hdr; + struct efi_manage_capsule_header *m_hdr; + struct efi_manage_capsule_image_header *m_img_hdr; + struct efi_image_auth *auth; + int type, size; + + /* + * Sanity check if the capsule image has a newer version + * than current one. + */ + cap_hdr = (efi_capsule_header_t *)data; + size = cap_hdr->headersize; + m_hdr = (struct efi_manage_capsule_header *)(data + size); + /* + * Current data structure size plus variable array indicated + * by number of (emb_drv_cnt + payload_cnt) + */ + size += sizeof(struct efi_manage_capsule_header) + + (m_hdr->emb_drv_cnt + m_hdr->payload_cnt) * sizeof(u64); + m_img_hdr = (struct efi_manage_capsule_image_header *)(data + size); + + type = get_image_type(m_img_hdr, pfru_dev); + if (type < 0) + return false; + + size = adjust_efi_size(m_img_hdr, size); + if (size < 0) + return false; + + auth = (struct efi_image_auth *)(data + size); + size += sizeof(u64) + auth->auth_info.hdr.len; + payload_hdr = (struct pfru_payload_hdr *)(data + size); + + /* finally compare the version */ + if (type == CODE_INJECT_TYPE) + return payload_hdr->rt_ver >= cap->code_rt_version; + else + return payload_hdr->rt_ver >= cap->drv_rt_version; +} + +static void dump_update_result(struct pfru_updated_result *result, + struct pfru_device *pfru_dev) +{ + dev_dbg(pfru_dev->dev, "Update result:\n"); + dev_dbg(pfru_dev->dev, "Status:%d\n", result->status); + dev_dbg(pfru_dev->dev, "Extended Status:%d\n", result->ext_status); + dev_dbg(pfru_dev->dev, "Authentication Time Low:%lld\n", + result->low_auth_time); + dev_dbg(pfru_dev->dev, "Authentication Time High:%lld\n", + result->high_auth_time); + dev_dbg(pfru_dev->dev, "Execution Time Low:%lld\n", + result->low_exec_time); + dev_dbg(pfru_dev->dev, "Execution Time High:%lld\n", + result->high_exec_time); +} + +static int start_acpi_update(int action, struct pfru_device *pfru_dev) +{ + union acpi_object *out_obj, in_obj, in_buf; + struct pfru_updated_result update_result; + acpi_handle handle; + int ret = -EINVAL; + + memset(&in_obj, 0, sizeof(in_obj)); + memset(&in_buf, 0, sizeof(in_buf)); + in_obj.type = ACPI_TYPE_PACKAGE; + in_obj.package.count = 1; + in_obj.package.elements = &in_buf; + in_buf.type = ACPI_TYPE_INTEGER; + in_buf.integer.value = action; + + handle = ACPI_HANDLE(pfru_dev->dev); + out_obj = acpi_evaluate_dsm_typed(handle, &pfru_dev->uuid, + pfru_dev->rev_id, FUNC_START, + &in_obj, ACPI_TYPE_PACKAGE); + if (!out_obj) + return ret; + + if (out_obj->package.count < UPDATE_NR_IDX) + goto free_acpi_buffer; + + if (out_obj->package.elements[UPDATE_STATUS_IDX].type != ACPI_TYPE_INTEGER) + goto free_acpi_buffer; + + update_result.status = + out_obj->package.elements[UPDATE_STATUS_IDX].integer.value; + + if (out_obj->package.elements[UPDATE_EXT_STATUS_IDX].type != ACPI_TYPE_INTEGER) + goto free_acpi_buffer; + + update_result.ext_status = + out_obj->package.elements[UPDATE_EXT_STATUS_IDX].integer.value; + + if (out_obj->package.elements[UPDATE_AUTH_TIME_LOW_IDX].type != ACPI_TYPE_INTEGER) + goto free_acpi_buffer; + + update_result.low_auth_time = + out_obj->package.elements[UPDATE_AUTH_TIME_LOW_IDX].integer.value; + + if (out_obj->package.elements[UPDATE_AUTH_TIME_HI_IDX].type != ACPI_TYPE_INTEGER) + goto free_acpi_buffer; + + update_result.high_auth_time = + out_obj->package.elements[UPDATE_AUTH_TIME_HI_IDX].integer.value; + + if (out_obj->package.elements[UPDATE_EXEC_TIME_LOW_IDX].type != ACPI_TYPE_INTEGER) + goto free_acpi_buffer; + + update_result.low_exec_time = + out_obj->package.elements[UPDATE_EXEC_TIME_LOW_IDX].integer.value; + + if (out_obj->package.elements[UPDATE_EXEC_TIME_HI_IDX].type != ACPI_TYPE_INTEGER) + goto free_acpi_buffer; + + update_result.high_exec_time = + out_obj->package.elements[UPDATE_EXEC_TIME_HI_IDX].integer.value; + + dump_update_result(&update_result, pfru_dev); + ret = 0; + +free_acpi_buffer: + ACPI_FREE(out_obj); + + return ret; +} + +static long pfru_ioctl(struct file *file, unsigned int cmd, unsigned long arg) +{ + struct pfru_update_cap_info cap; + struct pfru_device *pfru_dev; + void __user *p; + int ret, rev; + + pfru_dev = to_pfru_dev(file); + p = (void __user *)arg; + + switch (cmd) { + case PFRU_IOC_QUERY_CAP: + ret = query_capability(&cap, pfru_dev); + if (ret) + return ret; + + if (copy_to_user(p, &cap, sizeof(cap))) + return -EFAULT; + + return 0; + case PFRU_IOC_SET_REV: + if (copy_from_user(&rev, p, sizeof(unsigned int))) + return -EFAULT; + + if (!pfru_valid_revid(rev)) + return -EINVAL; + + pfru_dev->rev_id = rev; + + return 0; + case PFRU_IOC_STAGE: + return start_acpi_update(START_STAGE, pfru_dev); + case PFRU_IOC_ACTIVATE: + return start_acpi_update(START_ACTIVATE, pfru_dev); + case PFRU_IOC_STAGE_ACTIVATE: + return start_acpi_update(START_STAGE_ACTIVATE, pfru_dev); + default: + return -ENOTTY; + } +} + +static ssize_t pfru_write(struct file *file, const char __user *buf, + size_t len, loff_t *ppos) +{ + struct pfru_update_cap_info cap; + struct pfru_com_buf_info info; + struct pfru_device *pfru_dev; + phys_addr_t phy_addr; + struct iov_iter iter; + struct iovec iov; + char *buf_ptr; + int ret; + + pfru_dev = to_pfru_dev(file); + + ret = query_buffer(&info, pfru_dev); + if (ret) + return ret; + + if (len > info.buf_size) + return -EINVAL; + + iov.iov_base = (void __user *)buf; + iov.iov_len = len; + iov_iter_init(&iter, WRITE, &iov, 1, len); + + /* map the communication buffer */ + phy_addr = (phys_addr_t)(info.addr_lo | (info.addr_hi << 32)); + buf_ptr = memremap(phy_addr, info.buf_size, MEMREMAP_WB); + if (IS_ERR(buf_ptr)) + return PTR_ERR(buf_ptr); + + if (!copy_from_iter_full(buf_ptr, len, &iter)) { + ret = -EINVAL; + goto unmap; + } + + /* check if the capsule header has a valid version number */ + ret = query_capability(&cap, pfru_dev); + if (ret) + goto unmap; + + if (cap.status != DSM_SUCCEED) + ret = -EBUSY; + else if (!valid_version(buf_ptr, &cap, pfru_dev)) + ret = -EINVAL; +unmap: + memunmap(buf_ptr); + + return ret ?: len; +} + +static const struct file_operations acpi_pfru_fops = { + .owner = THIS_MODULE, + .write = pfru_write, + .unlocked_ioctl = pfru_ioctl, + .llseek = noop_llseek, +}; + +static int acpi_pfru_remove(struct platform_device *pdev) +{ + struct pfru_device *pfru_dev = platform_get_drvdata(pdev); + + misc_deregister(&pfru_dev->miscdev); + ida_free(&pfru_ida, pfru_dev->index); + + return 0; +} + +static int acpi_pfru_probe(struct platform_device *pdev) +{ + struct pfru_device *pfru_dev; + acpi_handle handle; + int ret; + + handle = ACPI_HANDLE(&pdev->dev); + if (!acpi_has_method(handle, "_DSM")) { + dev_dbg(&pdev->dev, "Missing _DSM\n"); + return -ENODEV; + } + + pfru_dev = devm_kzalloc(&pdev->dev, sizeof(*pfru_dev), GFP_KERNEL); + if (!pfru_dev) + return -ENOMEM; + + ret = guid_parse(PFRU_UUID, &pfru_dev->uuid); + if (ret) + return ret; + + ret = guid_parse(PFRU_CODE_INJ_UUID, &pfru_dev->code_uuid); + if (ret) + return ret; + + ret = guid_parse(PFRU_DRV_UPDATE_UUID, &pfru_dev->drv_uuid); + if (ret) + return ret; + + ret = ida_alloc(&pfru_ida, GFP_KERNEL); + if (ret < 0) + return ret; + + pfru_dev->index = ret; + /* default rev id is 1 */ + pfru_dev->rev_id = 1; + pfru_dev->dev = &pdev->dev; + + pfru_dev->miscdev.minor = MISC_DYNAMIC_MINOR; + pfru_dev->miscdev.name = devm_kasprintf(&pdev->dev, GFP_KERNEL, + "pfru%d", pfru_dev->index); + if (!pfru_dev->miscdev.name) { + ret = -ENOMEM; + goto failed; + } + + pfru_dev->miscdev.nodename = devm_kasprintf(&pdev->dev, GFP_KERNEL, + "acpi_pfru%d", pfru_dev->index); + if (!pfru_dev->miscdev.nodename) { + ret = -ENOMEM; + goto failed; + } + + pfru_dev->miscdev.fops = &acpi_pfru_fops; + pfru_dev->miscdev.parent = &pdev->dev; + + ret = misc_register(&pfru_dev->miscdev); + if (ret) + goto failed; + + platform_set_drvdata(pdev, pfru_dev); + + return 0; +failed: + ida_free(&pfru_ida, pfru_dev->index); + + return ret; +} + +static const struct acpi_device_id acpi_pfru_ids[] = { + {"INTC1080", 0}, + {} +}; +MODULE_DEVICE_TABLE(acpi, acpi_pfru_ids); + +static struct platform_driver acpi_pfru_driver = { + .driver = { + .name = "pfru_update", + .acpi_match_table = acpi_pfru_ids, + }, + .probe = acpi_pfru_probe, + .remove = acpi_pfru_remove, +}; +module_platform_driver(acpi_pfru_driver); + +MODULE_DESCRIPTION("Platform Firmware Runtime Update device driver"); +MODULE_LICENSE("GPL v2"); diff --git a/include/uapi/linux/pfru.h b/include/uapi/linux/pfru.h new file mode 100644 index 000000000000..d6f57a75afd2 --- /dev/null +++ b/include/uapi/linux/pfru.h @@ -0,0 +1,186 @@ +/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ +/* + * Platform Firmware Runtime Update header + * + * Copyright(c) 2021 Intel Corporation. All rights reserved. + */ +#ifndef __PFRU_H__ +#define __PFRU_H__ + +#include +#include + +#define PFRU_UUID "ECF9533B-4A3C-4E89-939E-C77112601C6D" +#define PFRU_CODE_INJ_UUID "B2F84B79-7B6E-4E45-885F-3FB9BB185402" +#define PFRU_DRV_UPDATE_UUID "4569DD8C-75F1-429A-A3D6-24DE8097A0DF" + +#define FUNC_STANDARD_QUERY 0 +#define FUNC_QUERY_UPDATE_CAP 1 +#define FUNC_QUERY_BUF 2 +#define FUNC_START 3 + +#define CODE_INJECT_TYPE 1 +#define DRIVER_UPDATE_TYPE 2 + +#define REVID_1 1 +#define REVID_2 2 + +#define PFRU_MAGIC 0xEE + +#define UUID_SIZE 16 + +/** + * PFRU_IOC_SET_REV - _IOW(PFRU_MAGIC, 0x01, unsigned int) + * + * Return: 0 on success, -errno on failure + * + * Set the Revision ID for PFRU Runtime Update. It could be either 1 or 2. + */ +#define PFRU_IOC_SET_REV _IOW(PFRU_MAGIC, 0x01, unsigned int) +/** + * PFRU_IOC_STAGE - _IOW(PFRU_MAGIC, 0x02, unsigned int) + * + * Return: 0 on success, -errno on failure + * + * Stage a capsule image from communication buffer and perform authentication. + */ +#define PFRU_IOC_STAGE _IOW(PFRU_MAGIC, 0x02, unsigned int) +/** + * PFRU_IOC_ACTIVATE - _IOW(PFRU_MAGIC, 0x03, unsigned int) + * + * Return: 0 on success, -errno on failure + * + * Activate a previous staged capsule image. + */ +#define PFRU_IOC_ACTIVATE _IOW(PFRU_MAGIC, 0x03, unsigned int) +/** + * PFRU_IOC_STAGE_ACTIVATE - _IOW(PFRU_MAGIC, 0x04, unsigned int) + * + * Return: 0 on success, -errno on failure + * + * Perform both stage and activation actions. + */ +#define PFRU_IOC_STAGE_ACTIVATE _IOW(PFRU_MAGIC, 0x04, unsigned int) +/** + * PFRU_IOC_QUERY_CAP - _IOR(PFRU_MAGIC, 0x05, + * struct pfru_update_cap_info) + * + * Return: 0 on success, -errno on failure. + * + * Retrieve information about the PFRU Runtime Update capability. + * The information is a struct pfru_update_cap_info. + */ +#define PFRU_IOC_QUERY_CAP _IOR(PFRU_MAGIC, 0x05, struct pfru_update_cap_info) + +static inline int pfru_valid_revid(int id) +{ + return id == REVID_1 || id == REVID_2; +} + +/** + * struct pfru_payload_hdr - Capsule file payload header. + * + * @sig: Signature of this capsule file. + * @hdr_version: Revision of this header structure. + * @hdr_size: Size of this header, including the OemHeader bytes. + * @hw_ver: The supported firmware version. + * @rt_ver: Version of the code injection image. + * @platform_id: A platform specific GUID to specify the platform what + * this capsule image support. + */ +struct pfru_payload_hdr { + __u32 sig; + __u32 hdr_version; + __u32 hdr_size; + __u32 hw_ver; + __u32 rt_ver; + __u8 platform_id[UUID_SIZE]; +}; + +enum pfru_start_action { + START_STAGE, + START_ACTIVATE, + START_STAGE_ACTIVATE, +}; + +enum pfru_dsm_status { + DSM_SUCCEED, + DSM_FUNC_NOT_SUPPORT, + DSM_INVAL_INPUT, + DSM_HARDWARE_ERR, + DSM_RETRY_SUGGESTED, + DSM_UNKNOWN, + DSM_FUNC_SPEC_ERR, +}; + +/** + * struct pfru_update_cap_info - Runtime update capability information. + * + * @status: Indicator of whether this query succeed. + * @update_cap: Bitmap to indicate whether the feature is supported. + * @code_type: A buffer containing an image type GUID. + * @fw_version: Platform firmware version. + * @code_rt_version: Code injection runtime version for anti-rollback. + * @drv_type: A buffer containing an image type GUID. + * @drv_rt_version: The version of the driver update runtime code. + * @drv_svn: The secure version number(SVN) of the driver update runtime code. + * @platform_id: A buffer containing a platform ID GUID. + * @oem_id: A buffer containing an OEM ID GUID. + * @oem_info: A buffer containing the vendor specific information. + */ +struct pfru_update_cap_info { + __u32 status; + __u32 update_cap; + + __u8 code_type[UUID_SIZE]; + __u32 fw_version; + __u32 code_rt_version; + + __u8 drv_type[UUID_SIZE]; + __u32 drv_rt_version; + __u32 drv_svn; + + __u8 platform_id[UUID_SIZE]; + __u8 oem_id[UUID_SIZE]; + + char oem_info[]; +}; + +/** + * struct pfru_com_buf_info - Communication buffer information. + * + * @status: Indicator of whether this query succeed. + * @ext_status: Implementation specific query result. + * @addr_lo: Low 32bit physical address of the communication buffer to hold + * a runtime update package. + * @addr_hi: High 32bit physical address of the communication buffer to hold + * a runtime update package. + * @buf_size: Maximum size in bytes of the communication buffer. + */ +struct pfru_com_buf_info { + __u32 status; + __u32 ext_status; + __u64 addr_lo; + __u64 addr_hi; + __u32 buf_size; +}; + +/** + * struct pfru_updated_result - Platform firmware runtime update result information. + * @status: Indicator of whether this update succeed. + * @ext_status: Implementation specific update result. + * @low_auth_time: Low 32bit value of image authentication time in nanosecond. + * @high_auth_time: High 32bit value of image authentication time in nanosecond. + * @low_exec_time: Low 32bit value of image execution time in nanosecond. + * @high_exec_time: High 32bit value of image execution time in nanosecond. + */ +struct pfru_updated_result { + __u32 status; + __u32 ext_status; + __u64 low_auth_time; + __u64 high_auth_time; + __u64 low_exec_time; + __u64 high_exec_time; +}; + +#endif /* __PFRU_H__ */ From patchwork Wed Oct 27 07:08:05 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Chen Yu X-Patchwork-Id: 12586497 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 8ACACC433EF for ; Wed, 27 Oct 2021 07:09:25 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 675D2610A5 for ; Wed, 27 Oct 2021 07:09:25 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S238363AbhJ0HLt (ORCPT ); Wed, 27 Oct 2021 03:11:49 -0400 Received: from mga04.intel.com ([192.55.52.120]:63070 "EHLO mga04.intel.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S240357AbhJ0HLs (ORCPT ); Wed, 27 Oct 2021 03:11:48 -0400 X-IronPort-AV: E=McAfee;i="6200,9189,10149"; a="228843483" X-IronPort-AV: E=Sophos;i="5.87,186,1631602800"; d="scan'208";a="228843483" Received: from fmsmga001.fm.intel.com ([10.253.24.23]) by fmsmga104.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 27 Oct 2021 00:08:52 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.87,186,1631602800"; d="scan'208";a="635605729" Received: from chenyu-desktop.sh.intel.com ([10.239.158.186]) by fmsmga001.fm.intel.com with ESMTP; 27 Oct 2021 00:08:49 -0700 From: Chen Yu To: linux-acpi@vger.kernel.org Cc: Greg Kroah-Hartman , "Rafael J. Wysocki" , Ard Biesheuvel , Len Brown , Ashok Raj , Andy Shevchenko , Mike Rapoport , Aubrey Li , Chen Yu , linux-kernel@vger.kernel.org Subject: [PATCH v7 3/4] drivers/acpi: Introduce Platform Firmware Runtime Update Telemetry Date: Wed, 27 Oct 2021 15:08:05 +0800 Message-Id: X-Mailer: git-send-email 2.25.1 In-Reply-To: References: MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-acpi@vger.kernel.org Platform Firmware Runtime Update(PFRU) Telemetry Service is part of RoT (Root of Trust), which allows PFRU handler and other PFRU drivers to produce telemetry data to upper layer OS consumer at runtime. The linux provides interfaces for the user to query the parameters of telemetry data, and the user could read out the telemetry data accordingly. The corresponding userspace tool and man page will be introduced at tools/power/acpi/pfru. Signed-off-by: Chen Yu --- v7: Use ida_alloc() to allocate a ID, and release the ID when device is removed. (Greg Kroah-Hartman) Check the _DSM method at early stage, before allocate or parse anything in acpi_pfru_log_probe(). (Greg Kroah-Hartman) Set the parent of the misc device. (Greg Kroah-Hartman) Use module_platform_driver() instead of platform_driver_register() in module_init(). Separate pfru driver and pfru_telemetry driver to two files. (Greg Kroah-Hartman) v6: Remove linux/uuid.h and use raw buffers to contain uuid. (Andy Shevchenko) Include types.h in pfru.h. (Andy Shevchenko) Use __u8[16] instead of uuid_t. (Andy Shevchenko) Replace enum in pfru.h with __u32 as enum size is not the same on all possible architectures. (Andy Shevchenko) Directly return results from the switch cases in pfru_log_ioctl(). (Andy Shevchenko) v5: Remove the log output sample in commit log. (Greg Kroah-Hartman) Add link for corresponding userspace tool in the commit log. (Greg Kroah-Hartman) Replace the telemetry .read() with .mmap() so that the userspace could mmap once, and read multiple times. (Greg Kroah-Hartman) Fix the compile warning by declaring the pfru_log_ioctl() as static. (kernel test robot LKP) v4: Change the write() to be the code injection/update, the read() to be telemetry retrieval and all of the rest to be ioctl()s under one special device file.(Rafael J. Wysocki) Remove redundant parens. (Rafael J. Wysocki) Putting empty code lines after an if () statement that is not followed by a block. (Rafael J. Wysocki) Remove "goto" tags to make the code more readable. (Rafael J. Wysocki) v3: Use __u32 instead of int and __64 instead of unsigned long in include/uapi/linux/pfru.h (Greg Kroah-Hartman) Rename the structure in uapi to start with a prefix pfru so as to avoid confusing in the global namespace. (Greg Kroah-Hartman) v2: Do similar clean up as pfru_update driver: Add sanity check for duplicated instance of ACPI device. Update the driver to work with allocated telem_device objects. (Mike Rapoport) For each switch case pair, get rid of the magic case numbers and add a default clause with the error handling. (Mike Rapoport) --- drivers/acpi/pfru/Makefile | 2 +- drivers/acpi/pfru/pfru_telemetry.c | 441 +++++++++++++++++++++++++++++ include/uapi/linux/pfru.h | 94 ++++++ 3 files changed, 536 insertions(+), 1 deletion(-) create mode 100644 drivers/acpi/pfru/pfru_telemetry.c diff --git a/drivers/acpi/pfru/Makefile b/drivers/acpi/pfru/Makefile index 098cbe80cf3d..9ba11efe10b3 100644 --- a/drivers/acpi/pfru/Makefile +++ b/drivers/acpi/pfru/Makefile @@ -1,2 +1,2 @@ # SPDX-License-Identifier: GPL-2.0-only -obj-$(CONFIG_ACPI_PFRU) += pfru_update.o +obj-$(CONFIG_ACPI_PFRU) += pfru_update.o pfru_telemetry.o diff --git a/drivers/acpi/pfru/pfru_telemetry.c b/drivers/acpi/pfru/pfru_telemetry.c new file mode 100644 index 000000000000..b2b055b5dd5d --- /dev/null +++ b/drivers/acpi/pfru/pfru_telemetry.c @@ -0,0 +1,441 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * ACPI Platform Firmware Runtime Update Telemetry Driver + * + * Copyright (C) 2021 Intel Corporation + * Author: Chen Yu + */ +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +enum log_index { + LOG_STATUS_IDX, + LOG_EXT_STATUS_IDX, + LOG_MAX_SZ_IDX, + LOG_CHUNK1_LO_IDX, + LOG_CHUNK1_HI_IDX, + LOG_CHUNK1_SZ_IDX, + LOG_CHUNK2_LO_IDX, + LOG_CHUNK2_HI_IDX, + LOG_CHUNK2_SZ_IDX, + LOG_ROLLOVER_CNT_IDX, + LOG_RESET_CNT_IDX, + LOG_NR_IDX +}; + +struct pfru_log_device { + guid_t uuid; + int index; + struct pfru_log_info info; + struct device *dev; + struct miscdevice miscdev; +}; + +static DEFINE_IDA(pfru_log_ida); + +static inline struct pfru_log_device *to_pfru_log_dev(struct file *file) +{ + return container_of(file->private_data, struct pfru_log_device, miscdev); +} + +static int get_pfru_log_data_info(struct pfru_log_data_info *data_info, + struct pfru_log_device *pfru_log_dev) +{ + union acpi_object *out_obj, in_obj, in_buf; + acpi_handle handle; + int ret = -EINVAL; + + handle = ACPI_HANDLE(pfru_log_dev->dev); + + memset(&in_obj, 0, sizeof(in_obj)); + memset(&in_buf, 0, sizeof(in_buf)); + in_obj.type = ACPI_TYPE_PACKAGE; + in_obj.package.count = 1; + in_obj.package.elements = &in_buf; + in_buf.type = ACPI_TYPE_INTEGER; + in_buf.integer.value = pfru_log_dev->info.log_type; + + out_obj = acpi_evaluate_dsm_typed(handle, &pfru_log_dev->uuid, + pfru_log_dev->info.log_revid, FUNC_GET_DATA, + &in_obj, ACPI_TYPE_PACKAGE); + if (!out_obj) + return ret; + + if (out_obj->package.count < LOG_NR_IDX) + goto free_acpi_buffer; + + if (out_obj->package.elements[LOG_STATUS_IDX].type != ACPI_TYPE_INTEGER) + goto free_acpi_buffer; + + data_info->status = out_obj->package.elements[LOG_STATUS_IDX].integer.value; + + if (out_obj->package.elements[LOG_EXT_STATUS_IDX].type != ACPI_TYPE_INTEGER) + goto free_acpi_buffer; + + data_info->ext_status = + out_obj->package.elements[LOG_EXT_STATUS_IDX].integer.value; + + if (out_obj->package.elements[LOG_MAX_SZ_IDX].type != ACPI_TYPE_INTEGER) + goto free_acpi_buffer; + + data_info->max_data_size = + out_obj->package.elements[LOG_MAX_SZ_IDX].integer.value; + + if (out_obj->package.elements[LOG_CHUNK1_LO_IDX].type != ACPI_TYPE_INTEGER) + goto free_acpi_buffer; + + data_info->chunk1_addr_lo = + out_obj->package.elements[LOG_CHUNK1_LO_IDX].integer.value; + + if (out_obj->package.elements[LOG_CHUNK1_HI_IDX].type != ACPI_TYPE_INTEGER) + goto free_acpi_buffer; + + data_info->chunk1_addr_hi = + out_obj->package.elements[LOG_CHUNK1_HI_IDX].integer.value; + + if (out_obj->package.elements[LOG_CHUNK1_SZ_IDX].type != ACPI_TYPE_INTEGER) + goto free_acpi_buffer; + + data_info->chunk1_size = + out_obj->package.elements[LOG_CHUNK1_SZ_IDX].integer.value; + + if (out_obj->package.elements[LOG_CHUNK2_LO_IDX].type != ACPI_TYPE_INTEGER) + goto free_acpi_buffer; + + data_info->chunk2_addr_lo = + out_obj->package.elements[LOG_CHUNK2_LO_IDX].integer.value; + + if (out_obj->package.elements[LOG_CHUNK2_HI_IDX].type != ACPI_TYPE_INTEGER) + goto free_acpi_buffer; + + data_info->chunk2_addr_hi = + out_obj->package.elements[LOG_CHUNK2_HI_IDX].integer.value; + + if (out_obj->package.elements[LOG_CHUNK2_SZ_IDX].type != ACPI_TYPE_INTEGER) + goto free_acpi_buffer; + + data_info->chunk2_size = + out_obj->package.elements[LOG_CHUNK2_SZ_IDX].integer.value; + + if (out_obj->package.elements[LOG_ROLLOVER_CNT_IDX].type != ACPI_TYPE_INTEGER) + goto free_acpi_buffer; + + data_info->rollover_cnt = + out_obj->package.elements[LOG_ROLLOVER_CNT_IDX].integer.value; + + if (out_obj->package.elements[LOG_RESET_CNT_IDX].type != ACPI_TYPE_INTEGER) + goto free_acpi_buffer; + + data_info->reset_cnt = + out_obj->package.elements[LOG_RESET_CNT_IDX].integer.value; + + ret = 0; +free_acpi_buffer: + ACPI_FREE(out_obj); + + return ret; +} + +static int set_pfru_log_level(int level, struct pfru_log_device *pfru_log_dev) +{ + union acpi_object *out_obj, *obj, in_obj, in_buf; + enum pfru_dsm_status status; + acpi_handle handle; + int ret = -EINVAL; + + handle = ACPI_HANDLE(pfru_log_dev->dev); + + memset(&in_obj, 0, sizeof(in_obj)); + memset(&in_buf, 0, sizeof(in_buf)); + in_obj.type = ACPI_TYPE_PACKAGE; + in_obj.package.count = 1; + in_obj.package.elements = &in_buf; + in_buf.type = ACPI_TYPE_INTEGER; + in_buf.integer.value = level; + + out_obj = acpi_evaluate_dsm_typed(handle, &pfru_log_dev->uuid, + pfru_log_dev->info.log_revid, FUNC_SET_LEV, + &in_obj, ACPI_TYPE_PACKAGE); + if (!out_obj) + return -EINVAL; + + obj = &out_obj->package.elements[0]; + status = obj->integer.value; + if (status) + goto free_acpi_buffer; + + obj = &out_obj->package.elements[1]; + status = obj->integer.value; + if (status) + goto free_acpi_buffer; + + ret = 0; + +free_acpi_buffer: + ACPI_FREE(out_obj); + + return ret; +} + +static int get_pfru_log_level(struct pfru_log_device *pfru_log_dev) +{ + union acpi_object *out_obj, *obj; + enum pfru_dsm_status status; + acpi_handle handle; + int ret = -EINVAL; + + handle = ACPI_HANDLE(pfru_log_dev->dev); + out_obj = acpi_evaluate_dsm_typed(handle, &pfru_log_dev->uuid, + pfru_log_dev->info.log_revid, FUNC_GET_LEV, + NULL, ACPI_TYPE_PACKAGE); + if (!out_obj) + return -EINVAL; + + obj = &out_obj->package.elements[0]; + if (obj->type != ACPI_TYPE_INTEGER) + goto free_acpi_buffer; + + status = obj->integer.value; + if (status) + goto free_acpi_buffer; + + obj = &out_obj->package.elements[1]; + if (obj->type != ACPI_TYPE_INTEGER) + goto free_acpi_buffer; + + status = obj->integer.value; + if (status) + goto free_acpi_buffer; + + obj = &out_obj->package.elements[2]; + if (obj->type != ACPI_TYPE_INTEGER) + goto free_acpi_buffer; + + ret = obj->integer.value; + +free_acpi_buffer: + ACPI_FREE(out_obj); + + return ret; +} + +static int valid_log_level(int level) +{ + return level == LOG_ERR || level == LOG_WARN || + level == LOG_INFO || level == LOG_VERB; +} + +static int valid_log_type(int type) +{ + return type == LOG_EXEC_IDX || type == LOG_HISTORY_IDX; +} + +static long pfru_log_ioctl(struct file *file, unsigned int cmd, unsigned long arg) +{ + struct pfru_log_device *pfru_log_dev; + struct pfru_log_data_info data_info; + struct pfru_log_info info; + void __user *p; + int ret = 0; + + pfru_log_dev = to_pfru_log_dev(file); + p = (void __user *)arg; + + switch (cmd) { + case PFRU_LOG_IOC_SET_INFO: + if (copy_from_user(&info, p, sizeof(info))) + return -EFAULT; + + if (pfru_valid_revid(info.log_revid)) + pfru_log_dev->info.log_revid = info.log_revid; + + if (valid_log_level(info.log_level)) { + ret = set_pfru_log_level(info.log_level, pfru_log_dev); + if (ret < 0) + return ret; + + pfru_log_dev->info.log_level = info.log_level; + } + + if (valid_log_type(info.log_type)) + pfru_log_dev->info.log_type = info.log_type; + + return 0; + case PFRU_LOG_IOC_GET_INFO: + info.log_level = get_pfru_log_level(pfru_log_dev); + if (ret < 0) + return ret; + + info.log_type = pfru_log_dev->info.log_type; + info.log_revid = pfru_log_dev->info.log_revid; + if (copy_to_user(p, &info, sizeof(info))) + return -EFAULT; + + return 0; + case PFRU_LOG_IOC_GET_DATA_INFO: + ret = get_pfru_log_data_info(&data_info, pfru_log_dev); + if (ret) + return ret; + + if (copy_to_user(p, &data_info, sizeof(struct pfru_log_data_info))) + return -EFAULT; + + return 0; + default: + return -ENOTTY; + } +} + +static int +pfru_log_mmap(struct file *file, struct vm_area_struct *vma) +{ + struct pfru_log_device *pfru_log_dev; + struct pfru_log_data_info info; + unsigned long psize, vsize; + phys_addr_t base_addr; + int ret; + + if (vma->vm_flags & VM_WRITE) + return -EROFS; + + /* changing from read to write with mprotect is not allowed */ + vma->vm_flags &= ~VM_MAYWRITE; + + pfru_log_dev = to_pfru_log_dev(file); + + ret = get_pfru_log_data_info(&info, pfru_log_dev); + if (ret) + return ret; + + base_addr = (phys_addr_t)(info.chunk2_addr_lo | (info.chunk2_addr_hi << 32)); + /* pfru update has not been launched yet */ + if (!base_addr) + return -ENODEV; + + psize = info.max_data_size; + /* base address and total buffer size must be page aligned */ + if (!PAGE_ALIGNED(base_addr) || !PAGE_ALIGNED(psize)) + return -ENODEV; + + vsize = vma->vm_end - vma->vm_start; + if (vsize > psize) + return -EINVAL; + + vma->vm_page_prot = pgprot_noncached(vma->vm_page_prot); + if (io_remap_pfn_range(vma, vma->vm_start, PFN_DOWN(base_addr), + vsize, vma->vm_page_prot)) + return -EAGAIN; + + return 0; +} + +static const struct file_operations acpi_pfru_log_fops = { + .owner = THIS_MODULE, + .mmap = pfru_log_mmap, + .unlocked_ioctl = pfru_log_ioctl, + .llseek = noop_llseek, +}; + +static int acpi_pfru_log_remove(struct platform_device *pdev) +{ + struct pfru_log_device *pfru_log_dev = platform_get_drvdata(pdev); + + misc_deregister(&pfru_log_dev->miscdev); + ida_free(&pfru_log_ida, pfru_log_dev->index); + + return 0; +} + +static int acpi_pfru_log_probe(struct platform_device *pdev) +{ + struct pfru_log_device *pfru_log_dev; + acpi_handle handle; + int ret; + + handle = ACPI_HANDLE(&pdev->dev); + if (!acpi_has_method(handle, "_DSM")) { + dev_dbg(&pdev->dev, "Missing _DSM\n"); + return -ENODEV; + } + + pfru_log_dev = devm_kzalloc(&pdev->dev, sizeof(*pfru_log_dev), GFP_KERNEL); + if (!pfru_log_dev) + return -ENOMEM; + + ret = guid_parse(PFRU_LOG_UUID, &pfru_log_dev->uuid); + if (ret) + return ret; + + ret = ida_alloc(&pfru_log_ida, GFP_KERNEL); + if (ret < 0) + return ret; + + pfru_log_dev->index = ret; + /* default rev id is 1 */ + pfru_log_dev->info.log_revid = 1; + pfru_log_dev->dev = &pdev->dev; + + pfru_log_dev->miscdev.minor = MISC_DYNAMIC_MINOR; + pfru_log_dev->miscdev.name = devm_kasprintf(&pdev->dev, GFP_KERNEL, + "pfru_telemetry%d", + pfru_log_dev->index); + if (!pfru_log_dev->miscdev.name) { + ret = -ENOMEM; + goto failed; + } + + pfru_log_dev->miscdev.nodename = devm_kasprintf(&pdev->dev, GFP_KERNEL, + "acpi_pfru_telemetry%d", + pfru_log_dev->index); + if (!pfru_log_dev->miscdev.nodename) { + ret = -ENOMEM; + goto failed; + } + + pfru_log_dev->miscdev.fops = &acpi_pfru_log_fops; + pfru_log_dev->miscdev.parent = &pdev->dev; + + ret = misc_register(&pfru_log_dev->miscdev); + if (ret) + goto failed; + + platform_set_drvdata(pdev, pfru_log_dev); + + return 0; +failed: + ida_free(&pfru_log_ida, pfru_log_dev->index); + + return ret; +} + +static const struct acpi_device_id acpi_pfru_log_ids[] = { + {"INTC1081", 0}, + {} +}; +MODULE_DEVICE_TABLE(acpi, acpi_pfru_log_ids); + +static struct platform_driver acpi_pfru_log_driver = { + .driver = { + .name = "pfru_telemetry", + .acpi_match_table = acpi_pfru_log_ids, + }, + .probe = acpi_pfru_log_probe, + .remove = acpi_pfru_log_remove, +}; +module_platform_driver(acpi_pfru_log_driver); + +MODULE_DESCRIPTION("Platform Firmware Runtime Update Telemetry driver"); +MODULE_LICENSE("GPL v2"); diff --git a/include/uapi/linux/pfru.h b/include/uapi/linux/pfru.h index d6f57a75afd2..368d62effa43 100644 --- a/include/uapi/linux/pfru.h +++ b/include/uapi/linux/pfru.h @@ -183,4 +183,98 @@ struct pfru_updated_result { __u64 high_exec_time; }; +#define PFRU_LOG_UUID "75191659-8178-4D9D-B88F-AC5E5E93E8BF" + +/** + * struct pfru_log_data_info - Log Data from telemetry service. + * @status: Indicator of whether this update succeed. + * @ext_status: Implementation specific update result. + * @chunk1_addr_lo: Low 32bit physical address of the telemetry data chunk1 + * starting address. + * @chunk1_addr_hi: High 32bit physical address of the telemetry data chunk1 + * starting address. + * @chunk2_addr_lo: Low 32bit physical address of the telemetry data chunk2 + * starting address. + * @chunk2_addr_hi: High 32bit physical address of the telemetry data chunk2 + * starting address. + * @max_data_size: Maximum supported size of data of all data chunks combined. + * @chunk1_size: Data size in bytes of the telemetry data chunk1 buffer. + * @chunk2_size: Data size in bytes of the telemetry data chunk2 buffer. + * @rollover_cnt: Number of times telemetry data buffer is overwritten + * since telemetry buffer reset. + * @reset_cnt: Number of times telemetry services resets that results in + * rollover count and data chunk buffers are reset. + */ +struct pfru_log_data_info { + __u32 status; + __u32 ext_status; + __u64 chunk1_addr_lo; + __u64 chunk1_addr_hi; + __u64 chunk2_addr_lo; + __u64 chunk2_addr_hi; + __u32 max_data_size; + __u32 chunk1_size; + __u32 chunk2_size; + __u32 rollover_cnt; + __u32 reset_cnt; +}; + +/** + * struct pfru_log_info - Telemetry log information. + * @log_level: The telemetry log level. + * @log_type: The telemetry log type(history and execution). + * @log_revid: The telemetry log revision id. + */ +struct pfru_log_info { + __u32 log_level; + __u32 log_type; + __u32 log_revid; +}; + +#define LOG_EXEC_IDX 0 +#define LOG_HISTORY_IDX 1 +#define NR_LOG_TYPE 2 + +#define LOG_ERR 0 +#define LOG_WARN 1 +#define LOG_INFO 2 +#define LOG_VERB 4 + +#define FUNC_SET_LEV 1 +#define FUNC_GET_LEV 2 +#define FUNC_GET_DATA 3 + +#define LOG_NAME_SIZE 10 + +/** + * PFRU_LOG_IOC_SET_INFO - _IOW(PFRU_MAGIC, 0x06, + * struct pfru_log_info) + * + * Return: 0 on success, -errno on failure. + * + * Set the PFRU log level and log type. The input information is + * a struct pfru_log_info. + */ +#define PFRU_LOG_IOC_SET_INFO _IOW(PFRU_MAGIC, 0x06, struct pfru_log_info) +/** + * PFRU_LOG_IOC_GET_INFO - _IOR(PFRU_MAGIC, 0x07, + * struct pfru_log_info) + * + * Return: 0 on success, -errno on failure. + * + * Retrieve log level and log type of the PFRU telemetry. The information is + * a struct pfru_log_info. + */ +#define PFRU_LOG_IOC_GET_INFO _IOR(PFRU_MAGIC, 0x07, struct pfru_log_info) +/** + * PFRU_LOG_IOC_GET_DATA_INFO - _IOR(PFRU_MAGIC, 0x08, + * struct pfru_log_data_info) + * + * Return: 0 on success, -errno on failure. + * + * Retrieve data information about the PFRU telemetry. The information + * is a struct pfru_log_data_info. + */ +#define PFRU_LOG_IOC_GET_DATA_INFO _IOR(PFRU_MAGIC, 0x08, struct pfru_log_data_info) + #endif /* __PFRU_H__ */ From patchwork Wed Oct 27 07:08:25 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Chen Yu X-Patchwork-Id: 12586495 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id B79DEC433EF for ; Wed, 27 Oct 2021 07:09:14 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 9C3F66103B for ; Wed, 27 Oct 2021 07:09:14 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S238419AbhJ0HLh (ORCPT ); Wed, 27 Oct 2021 03:11:37 -0400 Received: from mga09.intel.com ([134.134.136.24]:19657 "EHLO mga09.intel.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S238363AbhJ0HLg (ORCPT ); Wed, 27 Oct 2021 03:11:36 -0400 X-IronPort-AV: E=McAfee;i="6200,9189,10149"; a="229949000" X-IronPort-AV: E=Sophos;i="5.87,186,1631602800"; d="scan'208";a="229949000" Received: from fmsmga001.fm.intel.com ([10.253.24.23]) by orsmga102.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 27 Oct 2021 00:09:06 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.87,186,1631602800"; d="scan'208";a="635605798" Received: from chenyu-desktop.sh.intel.com ([10.239.158.186]) by fmsmga001.fm.intel.com with ESMTP; 27 Oct 2021 00:09:03 -0700 From: Chen Yu To: linux-acpi@vger.kernel.org Cc: Greg Kroah-Hartman , "Rafael J. Wysocki" , Ard Biesheuvel , Len Brown , Ashok Raj , Andy Shevchenko , Mike Rapoport , Aubrey Li , Chen Yu , linux-kernel@vger.kernel.org Subject: [PATCH v7 4/4] tools: Introduce power/acpi/pfru/pfru Date: Wed, 27 Oct 2021 15:08:25 +0800 Message-Id: <1954cde1d2086c2ae8b8e230d91bcde1edc77eed.1635317102.git.yu.c.chen@intel.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: References: MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-acpi@vger.kernel.org Introduce a user space tool to make use of the interface exposed by Platform Firmware Runtime Update and Telemetry drivers. The users can use this tool to do firmware code injection, driver update and to retrieve the telemetry data. Signed-off-by: Chen Yu --- v7: No change since v6. v6: Simplify the userspace tool to use while loop for getopt_long(). (Andy Shevchenko) v5: Replace the read() with mmap() so that the userspace could mmap once, and read multiple times. (Greg Kroah-Hartman) --- tools/power/acpi/pfru/Makefile | 25 ++ tools/power/acpi/pfru/pfru.8 | 137 +++++++++++ tools/power/acpi/pfru/pfru.c | 404 +++++++++++++++++++++++++++++++++ 3 files changed, 566 insertions(+) create mode 100644 tools/power/acpi/pfru/Makefile create mode 100644 tools/power/acpi/pfru/pfru.8 create mode 100644 tools/power/acpi/pfru/pfru.c diff --git a/tools/power/acpi/pfru/Makefile b/tools/power/acpi/pfru/Makefile new file mode 100644 index 000000000000..54bf913b2a09 --- /dev/null +++ b/tools/power/acpi/pfru/Makefile @@ -0,0 +1,25 @@ +# SPDX-License-Identifier: GPL-2.0+ + +CFLAGS += -Wall -O2 +CFLAGS += -DPFRU_HEADER='"../../../../include/uapi/linux/pfru.h"' +BUILD_OUTPUT := $(CURDIR) + +ifeq ("$(origin O)", "command line") + BUILD_OUTPUT := $(O) +endif + +pfru : pfru.c + +%: %.c + @mkdir -p $(BUILD_OUTPUT) + $(CC) $(CFLAGS) $< -o $(BUILD_OUTPUT)/$@ $(LDFLAGS) -luuid + +.PHONY : clean +clean : + @rm -f $(BUILD_OUTPUT)/pfru + +install : pfru + install -d $(DESTDIR)$(PREFIX)/bin + install $(BUILD_OUTPUT)/pfru $(DESTDIR)$(PREFIX)/bin/pfru + install -d $(DESTDIR)$(PREFIX)/share/man/man8 + install -m 644 pfru.8 $(DESTDIR)$(PREFIX)/share/man/man8 diff --git a/tools/power/acpi/pfru/pfru.8 b/tools/power/acpi/pfru/pfru.8 new file mode 100644 index 000000000000..d9cda7beaa3c --- /dev/null +++ b/tools/power/acpi/pfru/pfru.8 @@ -0,0 +1,137 @@ +.TH "PFRU" "8" "October 2021" "pfru 1.0" "" +.hy +.SH Name +.PP +pfru \- Platform Firmware Runtime Update tool +.SH SYNOPSIS +.PP +\f[B]pfru\f[R] [\f[I]Options\f[R]] +.SH DESCRIPTION +.PP +The PFRU(Platform Firmware Runtime Update) kernel interface is designed +to +.PD 0 +.P +.PD +interact with the platform firmware interface defined in the +.PD 0 +.P +.PD +Management Mode Firmware Runtime +Update (https://uefi.org/sites/default/files/resources/Intel_MM_OS_Interface_Spec_Rev100.pdf) +.PD 0 +.P +.PD +\f[B]pfru\f[R] is the tool to interact with the kernel interface. +.PD 0 +.P +.PD +.SH OPTIONS +.TP +.B \f[B]\-h\f[R], \f[B]\-\-help\f[R] +Display helper information. +.TP +.B \f[B]\-l\f[R], \f[B]\-\-load\f[R] +Load the capsule file into the system. +To be more specific, the capsule file will be copied to the +communication buffer. +.TP +.B \f[B]\-s\f[R], \f[B]\-\-stage\f[R] +Stage the capsule image from communication buffer into Management Mode +and perform authentication. +.TP +.B \f[B]\-a\f[R], \f[B]\-\-activate\f[R] +Activate a previous staged capsule image. +.TP +.B \f[B]\-u\f[R], \f[B]\-\-update\f[R] +Perform both stage and activation actions. +.TP +.B \f[B]\-q\f[R], \f[B]\-\-query\f[R] +Query the update capability. +.TP +.B \f[B]\-d\f[R], \f[B]\-\-setrev\f[R] +Set the revision ID of code injection/driver update. +.TP +.B \f[B]\-D\f[R], \f[B]\-\-setrevlog\f[R] +Set the revision ID of telemetry. +.TP +.B \f[B]\-G\f[R], \f[B]\-\-getloginfo\f[R] +Get telemetry log information and print it out. +.TP +.B \f[B]\-T\f[R], \f[B]\-\-type\f[R] +Set the telemetry log data type. +.TP +.B \f[B]\-L\f[R], \f[B]\-\-level\f[R] +Set the telemetry log level. +.TP +.B \f[B]\-R\f[R], \f[B]\-\-read\f[R] +Read all the telemetry data and print it out. +.SH EXAMPLES +.PP +\f[B]pfru \-G\f[R] +.PP +log_level:4 +.PD 0 +.P +.PD +log_type:0 +.PD 0 +.P +.PD +log_revid:2 +.PD 0 +.P +.PD +max_data_size:65536 +.PD 0 +.P +.PD +chunk1_size:0 +.PD 0 +.P +.PD +chunk2_size:1401 +.PD 0 +.P +.PD +rollover_cnt:0 +.PD 0 +.P +.PD +reset_cnt:4 +.PP +\f[B]pfru \-q\f[R] +.PP +code injection image type:794bf8b2\-6e7b\-454e\-885f\-3fb9bb185402 +.PD 0 +.P +.PD +fw_version:0 +.PD 0 +.P +.PD +code_rt_version:1 +.PD 0 +.P +.PD +driver update image type:0e5f0b14\-f849\-7945\-ad81\-bc7b6d2bb245 +.PD 0 +.P +.PD +drv_rt_version:0 +.PD 0 +.P +.PD +drv_svn:0 +.PD 0 +.P +.PD +platform id:39214663\-b1a8\-4eaa\-9024\-f2bb53ea4723 +.PD 0 +.P +.PD +oem id:a36db54f\-ea2a\-e14e\-b7c4\-b5780e51ba3d +.PP +\f[B]pfru \-l yours.cap \-u \-T 1 \-L 4\f[R] +.SH AUTHORS +Chen Yu. diff --git a/tools/power/acpi/pfru/pfru.c b/tools/power/acpi/pfru/pfru.c new file mode 100644 index 000000000000..6ca68a4a59ba --- /dev/null +++ b/tools/power/acpi/pfru/pfru.c @@ -0,0 +1,404 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * Platform Firmware Runtime Update tool to do Management + * Mode code injection/driver update and telemetry retrieval. + */ +#define _GNU_SOURCE +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include PFRU_HEADER + +char *capsule_name; +int action, query_cap, log_type, log_level, log_read, log_getinfo, + revid, log_revid; +int set_log_level, set_log_type, + set_revid, set_log_revid; + +char *progname; + +static int valid_log_level(int level) +{ + return level == LOG_ERR || level == LOG_WARN || + level == LOG_INFO || level == LOG_VERB; +} + +static int valid_log_type(int type) +{ + return type == LOG_EXEC_IDX || type == LOG_HISTORY_IDX; +} + +static void help(void) +{ + fprintf(stderr, + "usage: %s [OPTIONS]\n" + " code injection:\n" + " -l, --load\n" + " -s, --stage\n" + " -a, --activate\n" + " -u, --update [stage and activate]\n" + " -q, --query\n" + " -d, --revid update\n" + " telemetry:\n" + " -G, --getloginfo\n" + " -T, --type(0:execution, 1:history)\n" + " -L, --level(0, 1, 2, 4)\n" + " -R, --read\n" + " -D, --revid log\n", + progname); +} + +char *option_string = "l:sauqd:GT:L:RD:h"; +static struct option long_options[] = { + {"load", required_argument, 0, 'l'}, + {"stage", no_argument, 0, 's'}, + {"activate", no_argument, 0, 'a'}, + {"update", no_argument, 0, 'u'}, + {"query", no_argument, 0, 'q'}, + {"getloginfo", no_argument, 0, 'G'}, + {"type", required_argument, 0, 'T'}, + {"level", required_argument, 0, 'L'}, + {"read", no_argument, 0, 'R'}, + {"setrev", required_argument, 0, 'd'}, + {"setrevlog", required_argument, 0, 'D'}, + {"help", no_argument, 0, 'h'}, + {} +}; + +static void parse_options(int argc, char **argv) +{ + int option_index = 0; + char *pathname; + int opt; + + pathname = strdup(argv[0]); + progname = basename(pathname); + + while ((opt = getopt_long_only(argc, argv, option_string, + long_options, &option_index)) != -1) { + switch (opt) { + case 'l': + capsule_name = optarg; + break; + case 's': + action = 1; + break; + case 'a': + action = 2; + break; + case 'u': + action = 3; + break; + case 'q': + query_cap = 1; + break; + case 'G': + log_getinfo = 1; + break; + case 'T': + log_type = atoi(optarg); + set_log_type = 1; + break; + case 'L': + log_level = atoi(optarg); + set_log_level = 1; + break; + case 'R': + log_read = 1; + break; + case 'd': + revid = atoi(optarg); + set_revid = 1; + break; + case 'D': + log_revid = atoi(optarg); + set_log_revid = 1; + break; + case 'h': + help(); + exit(0); + default: + break; + } + } +} + +void print_cap(struct pfru_update_cap_info *cap) +{ + char *uuid; + + uuid = malloc(37); + if (!uuid) { + perror("Can not allocate uuid buffer\n"); + exit(1); + } + + uuid_unparse(cap->code_type, uuid); + printf("code injection image type:%s\n", uuid); + printf("fw_version:%d\n", cap->fw_version); + printf("code_rt_version:%d\n", cap->code_rt_version); + + uuid_unparse(cap->drv_type, uuid); + printf("driver update image type:%s\n", uuid); + printf("drv_rt_version:%d\n", cap->drv_rt_version); + printf("drv_svn:%d\n", cap->drv_svn); + + uuid_unparse(cap->platform_id, uuid); + printf("platform id:%s\n", uuid); + uuid_unparse(cap->oem_id, uuid); + printf("oem id:%s\n", uuid); + + free(uuid); +} + +int main(int argc, char *argv[]) +{ + int fd_update, fd_update_log, fd_capsule; + struct pfru_log_data_info data_info; + struct pfru_log_info info; + struct pfru_update_cap_info cap; + void *addr_map_capsule; + struct stat st; + char *log_buf; + int ret = 0; + + if (getuid() != 0) { + printf("Please run the tool as root - Exiting.\n"); + return 1; + } + + parse_options(argc, argv); + + fd_update = open("/dev/acpi_pfru0", O_RDWR); + if (fd_update < 0) { + printf("PFRU device not supported - Quit...\n"); + return 1; + } + + fd_update_log = open("/dev/acpi_pfru_telemetry0", O_RDWR); + if (fd_update_log < 0) { + printf("PFRU telemetry device not supported - Quit...\n"); + return 1; + } + + if (query_cap) { + ret = ioctl(fd_update, PFRU_IOC_QUERY_CAP, &cap); + if (ret) + perror("Query Update Capability info failed."); + else + print_cap(&cap); + + close(fd_update); + close(fd_update_log); + + return ret; + } + + if (log_getinfo) { + ret = ioctl(fd_update_log, PFRU_LOG_IOC_GET_DATA_INFO, &data_info); + if (ret) { + perror("Get telemetry data info failed."); + + close(fd_update); + close(fd_update_log); + + return 1; + } + + ret = ioctl(fd_update_log, PFRU_LOG_IOC_GET_INFO, &info); + if (ret) { + perror("Get telemetry info failed."); + + close(fd_update); + close(fd_update_log); + + return 1; + } + + printf("log_level:%d\n", info.log_level); + printf("log_type:%d\n", info.log_type); + printf("log_revid:%d\n", info.log_revid); + printf("max_data_size:%d\n", data_info.max_data_size); + printf("chunk1_size:%d\n", data_info.chunk1_size); + printf("chunk2_size:%d\n", data_info.chunk2_size); + printf("rollover_cnt:%d\n", data_info.rollover_cnt); + printf("reset_cnt:%d\n", data_info.reset_cnt); + + return 0; + } + + info.log_level = -1; + info.log_type = -1; + info.log_revid = -1; + + if (set_log_level) { + if (!valid_log_level(log_level)) { + printf("Invalid log level %d\n", + log_level); + } else { + info.log_level = log_level; + } + } + + if (set_log_type) { + if (!valid_log_type(log_type)) { + printf("Invalid log type %d\n", + log_type); + } else { + info.log_type = log_type; + } + } + + if (set_log_revid) { + if (!pfru_valid_revid(log_revid)) { + printf("Invalid log revid %d, unchanged.\n", + log_revid); + } else { + info.log_revid = log_revid; + } + } + + ret = ioctl(fd_update_log, PFRU_LOG_IOC_SET_INFO, &info); + if (ret) { + perror("Log information set failed.(log_level, log_type, log_revid)"); + close(fd_update); + close(fd_update_log); + + return 1; + } + + if (set_revid) { + ret = ioctl(fd_update, PFRU_IOC_SET_REV, &revid); + if (ret) { + perror("pfru update revid set failed"); + close(fd_update); + close(fd_update_log); + + return 1; + } + + printf("pfru update revid set to %d\n", revid); + } + + if (capsule_name) { + fd_capsule = open(capsule_name, O_RDONLY); + if (fd_capsule < 0) { + perror("Can not open capsule file..."); + close(fd_update); + close(fd_update_log); + + return 1; + } + + if (fstat(fd_capsule, &st) < 0) { + perror("Can not fstat capsule file..."); + close(fd_capsule); + close(fd_update); + close(fd_update_log); + + return 1; + } + + addr_map_capsule = mmap(NULL, st.st_size, PROT_READ, MAP_SHARED, + fd_capsule, 0); + if (addr_map_capsule == MAP_FAILED) { + perror("Failed to mmap capsule file."); + close(fd_capsule); + close(fd_update); + close(fd_update_log); + + return 1; + } + + ret = write(fd_update, (char *)addr_map_capsule, st.st_size); + printf("Load %d bytes of capsule file into the system\n", + ret); + + if (ret == -1) { + perror("Failed to load capsule file"); + close(fd_capsule); + close(fd_update); + close(fd_update_log); + + return 1; + } + + munmap(addr_map_capsule, st.st_size); + close(fd_capsule); + printf("Load done.\n"); + } + + if (action) { + if (action == 1) { + ret = ioctl(fd_update, PFRU_IOC_STAGE, NULL); + } else if (action == 2) { + ret = ioctl(fd_update, PFRU_IOC_ACTIVATE, NULL); + } else if (action == 3) { + ret = ioctl(fd_update, PFRU_IOC_STAGE_ACTIVATE, NULL); + } else { + close(fd_update); + close(fd_update_log); + + return 1; + } + printf("Update finished, return %d\n", ret); + } + + close(fd_update); + + if (log_read) { + void *p_mmap; + int max_data_sz; + + ret = ioctl(fd_update_log, PFRU_LOG_IOC_GET_DATA_INFO, &data_info); + if (ret) { + perror("Get telemetry data info failed."); + close(fd_update_log); + + return 1; + } + + max_data_sz = data_info.max_data_size; + if (!max_data_sz) { + printf("No telemetry data available.\n"); + close(fd_update_log); + + return 1; + } + + log_buf = malloc(max_data_sz + 1); + if (!log_buf) { + perror("log_buf allocate failed."); + close(fd_update_log); + + return 1; + } + + p_mmap = mmap(NULL, max_data_sz, PROT_READ, MAP_SHARED, fd_update_log, 0); + if (p_mmap == MAP_FAILED) { + perror("mmap error."); + close(fd_update_log); + + return 1; + } + + memcpy(log_buf, p_mmap, max_data_sz); + log_buf[max_data_sz] = '\0'; + printf("%s\n", log_buf); + free(log_buf); + + munmap(p_mmap, max_data_sz); + } + + close(fd_update_log); + + return 0; +}