From patchwork Thu Sep 9 02:18:45 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Russ Weight X-Patchwork-Id: 12482307 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-16.7 required=3.0 tests=BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id B6C9FC433FE for ; Thu, 9 Sep 2021 02:19:09 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 903EA61139 for ; Thu, 9 Sep 2021 02:19:09 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S237372AbhIICUQ (ORCPT ); Wed, 8 Sep 2021 22:20:16 -0400 Received: from mga04.intel.com ([192.55.52.120]:63720 "EHLO mga04.intel.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233710AbhIICUO (ORCPT ); Wed, 8 Sep 2021 22:20:14 -0400 X-IronPort-AV: E=McAfee;i="6200,9189,10101"; a="218793851" X-IronPort-AV: E=Sophos;i="5.85,279,1624345200"; d="scan'208";a="218793851" Received: from fmsmga008.fm.intel.com ([10.253.24.58]) by fmsmga104.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 08 Sep 2021 19:18:56 -0700 X-IronPort-AV: E=Sophos;i="5.85,279,1624345200"; d="scan'208";a="503916539" Received: from rhweight-mobl2.amr.corp.intel.com (HELO rhweight-mobl2.ra.intel.com) ([10.212.194.237]) by fmsmga008-auth.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 08 Sep 2021 19:18:55 -0700 From: Russ Weight To: mdf@kernel.org, linux-fpga@vger.kernel.org, linux-kernel@vger.kernel.org Cc: trix@redhat.com, lgoncalv@redhat.com, yilun.xu@intel.com, hao.wu@intel.com, matthew.gerlach@intel.com, Russ Weight Subject: [PATCH v15 5/6] fpga: image-load: create status sysfs node Date: Wed, 8 Sep 2021 19:18:45 -0700 Message-Id: <20210909021846.681121-6-russell.h.weight@intel.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20210909021846.681121-1-russell.h.weight@intel.com> References: <20210909021846.681121-1-russell.h.weight@intel.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-fpga@vger.kernel.org Extend the FPGA Image Load class driver to include a status sysfs node that can be viewed to determine from the command line if an image load is in progress. Status will be one of: idle, starting, preparing, writing, or programming. Signed-off-by: Russ Weight --- v15: - Compare to previous patch: [PATCH v14 3/6] fpga: sec-mgr: expose sec-mgr update status - Changed file, symbol, and config names to reflect the new driver name - Removed signed-off/reviewed-by tags v14: - Updated ABI documentation date and kernel version v13: - No change v12: - Updated Date and KernelVersion fields in ABI documentation - Changed syntax of sec_mgr_prog_str[] array definition from: "idle", /* FPGA_SEC_PROG_IDLE */ to: [FPGA_SEC_PROG_IDLE] = "idle", v11: - No change v10: - Rebased to 5.12-rc2 next - Updated Date and KernelVersion in ABI documentation v9: - Updated Date and KernelVersion in ABI documentation v8: - No change v7: - Changed Date in documentation file to December 2020 v6: - No change v5: - Use new function sysfs_emit() in the status_show() function v4: - Changed from "Intel FPGA Security Manager" to FPGA Security Manager" and removed unnecessary references to "Intel". - Changed: iops -> sops, imgr -> smgr, IFPGA_ -> FPGA_, ifpga_ to fpga_ v3: - Use a local variable to read progress once in status_show() - Use dev_err to report invalid progress status v2: - Bumped documentation date and version - Changed progress state "read_file" to "reading" --- .../ABI/testing/sysfs-class-fpga-image-load | 7 ++++ MAINTAINERS | 1 + drivers/fpga/fpga-image-load.c | 33 +++++++++++++++++++ 3 files changed, 41 insertions(+) create mode 100644 Documentation/ABI/testing/sysfs-class-fpga-image-load diff --git a/Documentation/ABI/testing/sysfs-class-fpga-image-load b/Documentation/ABI/testing/sysfs-class-fpga-image-load new file mode 100644 index 000000000000..6c04a49f01cc --- /dev/null +++ b/Documentation/ABI/testing/sysfs-class-fpga-image-load @@ -0,0 +1,7 @@ +What: /sys/class/fpga_image_load/fpga_imageX/status +Date: Aug 2021 +KernelVersion: 5.15 +Contact: Russ Weight +Description: Read-only. Returns a string describing the current status + of an FPGA image upload. The string will be one of the + following: idle, starting, preparing, writing, programming. diff --git a/MAINTAINERS b/MAINTAINERS index 637bc003ca81..e3fbc1bde9bc 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -7362,6 +7362,7 @@ FPGA SECURITY MANAGER DRIVERS M: Russ Weight L: linux-fpga@vger.kernel.org S: Maintained +F: Documentation/ABI/testing/sysfs-class-fpga-image-load F: Documentation/fpga/fpga-image-load.rst F: drivers/fpga/fpga-image-load.c F: include/linux/fpga/fpga-image-load.h diff --git a/drivers/fpga/fpga-image-load.c b/drivers/fpga/fpga-image-load.c index 99a47b21c995..6ec0a39f07b3 100644 --- a/drivers/fpga/fpga-image-load.c +++ b/drivers/fpga/fpga-image-load.c @@ -236,6 +236,38 @@ static const struct file_operations fpga_image_load_fops = { .unlocked_ioctl = fpga_image_load_ioctl, }; +static const char * const image_load_prog_str[] = { + [FPGA_IMAGE_PROG_IDLE] = "idle", + [FPGA_IMAGE_PROG_STARTING] = "starting", + [FPGA_IMAGE_PROG_PREPARING] = "preparing", + [FPGA_IMAGE_PROG_WRITING] = "writing", + [FPGA_IMAGE_PROG_PROGRAMMING] = "programming" +}; + +static ssize_t +status_show(struct device *dev, struct device_attribute *attr, char *buf) +{ + struct fpga_image_load *imgld = to_image_load(dev); + const char *status = "unknown-status"; + enum fpga_image_prog progress; + + progress = imgld->progress; + if (progress < FPGA_IMAGE_PROG_MAX) + status = image_load_prog_str[progress]; + else + dev_err(dev, "Invalid status during secure update: %d\n", + progress); + + return sysfs_emit(buf, "%s\n", status); +} +static DEVICE_ATTR_RO(status); + +static struct attribute *fpga_image_load_attrs[] = { + &dev_attr_status.attr, + NULL, +}; +ATTRIBUTE_GROUPS(fpga_image_load); + /** * fpga_image_load_register - create and register an FPGA Image Load Device * @@ -373,6 +405,7 @@ static int __init fpga_image_load_class_init(void) if (ret) goto exit_destroy_class; + fpga_image_load_class->dev_groups = fpga_image_load_groups; fpga_image_load_class->dev_release = fpga_image_load_dev_release; return 0;