From patchwork Fri Feb 4 07:22:32 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Joel Stanley X-Patchwork-Id: 12734857 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 bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id C9C11C433F5 for ; Fri, 4 Feb 2022 07:24:16 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender: Content-Transfer-Encoding:Content-Type:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:MIME-Version:References:In-Reply-To: Message-Id:Date:Subject:Cc:To:From:Reply-To:Content-ID:Content-Description: Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: List-Owner; bh=q95J8jrzMVXsqsNKSdGYiC0FCMaQmTz5Ew0mxCHkD5k=; b=GP9TUqk0e2rzU+ 6sYDFbClMypzRqhIDKCXPxC+XUVr776+ZLTGDnfGKg/lZziyejVkJ4Q4G6+mp53gTMswCmtb5m7Aa 6Ka8vR911MRMhXULXtLydUlxSgKbBOXVGgoOQkby1vcSxPf2HaQ1fvwaBCw035g0FVFeKIlxausHa P5okZ3fzdi7e5R4SfmoTcx+rpHYn0e37wamo9Nt+I3HgxxFU7J4E29LjLqJp7GI4f18OwobUJU2Zh k4FTMhdhhDvhj2oWavHgZ7xduVgSh+7V6KkRTMSm7GAdN3xw29WOd9O0Tk/RLMbC6SXlok4kEVsmr kcCg82LdBQNoto8hbFrg==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.94.2 #2 (Red Hat Linux)) id 1nFsvq-003dT7-87; Fri, 04 Feb 2022 07:22:58 +0000 Received: from mail-pj1-x102f.google.com ([2607:f8b0:4864:20::102f]) by bombadil.infradead.org with esmtps (Exim 4.94.2 #2 (Red Hat Linux)) id 1nFsvg-003dQb-HG for linux-arm-kernel@lists.infradead.org; Fri, 04 Feb 2022 07:22:50 +0000 Received: by mail-pj1-x102f.google.com with SMTP id o64so4730399pjo.2 for ; Thu, 03 Feb 2022 23:22:47 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=sender:from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=+5LKPpbu5iKLCx8q3l3QTtraKDXoVw4tcaBCnigYFY0=; b=Ye1x1oKYhX/fuw433OWsCC+WYT2KJrWfEgXPhcjxbxm2hgAeS8b6jd3Ohjog74Pqyt u7OBe17I2pIXHHVTnuy2pG2RTYJqriTSaE/XLqZIj2SyZMCdOVvBOub3a2AMpl4aE263 8GD1zjPpHbEPPnKKn4f3ZM8gsIRx5X19bqdHZ5hWecZ0mzJtLHv7YsCNTrEOH1Zva/Mn lrDeZX8UdjFZwDG4vvwNfLluk6993FcAqLyoraf7XlI9WsZdpdCgCDdQkTyO7MHgrUfo Tw9owpoGiKWvql0zEBJgxUpIN2zZ+T8vy/fOMJs0eCOoET5U6ikWef3LbJAHBsyLwvZS TYig== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:sender:from:to:cc:subject:date:message-id :in-reply-to:references:mime-version:content-transfer-encoding; bh=+5LKPpbu5iKLCx8q3l3QTtraKDXoVw4tcaBCnigYFY0=; b=lq8dtqIlqNguZ2nhcg38iT7Dpq4Wmj50SAljyyLeWYj2Z87Utdw9IY4+/1hgwMDW8h oEYzKJocrdorbhK+2XM7I7se7uclLJ/2hPYWnMP6SDB2OKDC4kgYvD/OO6K76ZCUWfcN YwLIE2Q7u//iXDB5H48LD+YXRnDHw9Q0SEHuMycq0u8Z+nOyLMujsNFCPhIGgUBrKm/Q 2QCuDAfPsZ6mHe+2BcYrVmdChlNFnO4AQl3cg4X0V0xmrN/NV1yvcesUZIBbgZ/FYkom vj4Cs+qnQUb+ei+E4FgpRkYmE6W9V2unki3+t/FWKXGEyWIqSXH1feaCL+9Rhs97h+6k eYyw== X-Gm-Message-State: AOAM532teCXpfFk0T2HeU1AOOIs/Ntrau2U1Y56q2pqtbDo79NG9LGw4 OBxqOSjAtRtPAfZqIqm2R/cinOsj4Q8= X-Google-Smtp-Source: ABdhPJxamqaX7dV6Xu5aIa9QaGzi6tPvLY26OfbUAcepJ1S0aH7GPsguPzJfyitNg9q10b9Pe55yDg== X-Received: by 2002:a17:902:b189:: with SMTP id s9mr1679695plr.112.1643959367334; Thu, 03 Feb 2022 23:22:47 -0800 (PST) Received: from voyager.lan ([45.124.203.14]) by smtp.gmail.com with ESMTPSA id t14sm11665328pjd.6.2022.02.03.23.22.43 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 03 Feb 2022 23:22:46 -0800 (PST) From: Joel Stanley To: Arnd Bergmann , Andrew Jeffery , Greg Kroah-Hartman , "Rafael J . Wysocki" , Robin Murphy Cc: linux-kernel@vger.kernel.org, linux-arm-kernel@lists.infradead.org, linux-aspeed@lists.ozlabs.org Subject: [PATCH v3 1/3] firmware: Add boot information to sysfs Date: Fri, 4 Feb 2022 17:52:32 +1030 Message-Id: <20220204072234.304543-2-joel@jms.id.au> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20220204072234.304543-1-joel@jms.id.au> References: <20220204072234.304543-1-joel@jms.id.au> MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20220203_232248_607356_0989831D X-CRM114-Status: GOOD ( 30.32 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org Machines often have firmware that perform some action before Linux is loaded. It's useful to know how this firmware is configured, so create a sysfs directory and some properties that a system can choose to expose to describe how the system was started. Currently the intended use describes four files, relating to hardware root of trust configuration. These properties are populated by platform code at startup. Using fixed values is suitable as the state that the system booted in will not change after firmware has handed over. Signed-off-by: Joel Stanley --- v2: - Rewrite so properties are present in common code and are exposed based on the is_visible callback. - Use sysfs_emit v3: - drop uart_boot - Add kerneldoc to header - Rename en -> present - Rename val -> value - Drop unncessary __init from header - Wrap macro in do { } while(0) --- .../ABI/testing/sysfs-firmware-bootinfo | 37 +++++++++ drivers/base/firmware.c | 80 +++++++++++++++++++ include/linux/firmware_bootinfo.h | 48 +++++++++++ 3 files changed, 165 insertions(+) create mode 100644 Documentation/ABI/testing/sysfs-firmware-bootinfo create mode 100644 include/linux/firmware_bootinfo.h diff --git a/Documentation/ABI/testing/sysfs-firmware-bootinfo b/Documentation/ABI/testing/sysfs-firmware-bootinfo new file mode 100644 index 000000000000..cd8eeaa49a00 --- /dev/null +++ b/Documentation/ABI/testing/sysfs-firmware-bootinfo @@ -0,0 +1,37 @@ +What: /sys/firmware/bootinfo/* +Date: Jan 2022 +Description: + A system can expose information about how it was started in + this directory. + + This information is agnostic as to the firmware implementation. + + A system may expose a subset of these properties as applicable. + + +What: /sys/firmware/bootinfo/secure_boot +Date: Jan 2022 +Description: + Indicates the system was started with secure boot enabled in + the firmware. + + +What: /sys/firmware/bootinfo/abr_image +Date: Jan 2022 +Description: + Indicates the system was started from the alternate image + loaded from an Alternate Boot Region. Often this is a result of + the primary firmware image failing to start the system. + + +What: /sys/firmware/bootinfo/low_security_key +Date: Jan 2022 +Description: + Indicates the system's secure boot was verified with a low + security or development key. + +What: /sys/firmware/bootinfo/otp_protected +Date: Jan 2022 +Description: + Indicates the system's boot configuration region is write + protected and cannot be modified. diff --git a/drivers/base/firmware.c b/drivers/base/firmware.c index 8dff940e0db9..8d1a7a36784c 100644 --- a/drivers/base/firmware.c +++ b/drivers/base/firmware.c @@ -11,6 +11,7 @@ #include #include #include +#include #include "base.h" @@ -24,3 +25,82 @@ int __init firmware_init(void) return -ENOMEM; return 0; } + +/* + * Exposes attributes documented in Documentation/ABI/testing/sysfs-firmware-bootinfo + */ +static struct bootinfo bootinfo; + +static ssize_t abr_image_show(struct device *dev, struct device_attribute *attr, char *buf) +{ + return sysfs_emit(buf, "%d\n", bootinfo.abr_image.value); +} +static DEVICE_ATTR_RO(abr_image); + +static ssize_t low_security_key_show(struct device *dev, struct device_attribute *attr, char *buf) +{ + return sysfs_emit(buf, "%d\n", bootinfo.low_security_key.value); +} +static DEVICE_ATTR_RO(low_security_key); + +static ssize_t otp_protected_show(struct device *dev, struct device_attribute *attr, char *buf) +{ + return sysfs_emit(buf, "%d\n", bootinfo.otp_protected.value); +} +static DEVICE_ATTR_RO(otp_protected); + +static ssize_t secure_boot_show(struct device *dev, struct device_attribute *attr, char *buf) +{ + return sysfs_emit(buf, "%d\n", bootinfo.secure_boot.value); +} +static DEVICE_ATTR_RO(secure_boot); + +#define ATTR_ENABLED(a) ((attr == &dev_attr_##a.attr) && bootinfo.a.present) + +static umode_t bootinfo_attr_mode(struct kobject *kobj, struct attribute *attr, int index) +{ + if (ATTR_ENABLED(abr_image)) + return 0444; + + if (ATTR_ENABLED(otp_protected)) + return 0444; + + if (ATTR_ENABLED(low_security_key)) + return 0444; + + if (ATTR_ENABLED(otp_protected)) + return 0444; + + if (ATTR_ENABLED(low_security_key)) + return 0444; + + if (ATTR_ENABLED(secure_boot)) + return 0444; + + return 0; +} + +static struct attribute *bootinfo_attrs[] = { + &dev_attr_abr_image.attr, + &dev_attr_low_security_key.attr, + &dev_attr_otp_protected.attr, + &dev_attr_secure_boot.attr, + NULL, +}; + +static const struct attribute_group bootinfo_attr_group = { + .attrs = bootinfo_attrs, + .is_visible = bootinfo_attr_mode, +}; + +int __init firmware_bootinfo_init(struct bootinfo *bootinfo_init) +{ + struct kobject *kobj = kobject_create_and_add("bootinfo", firmware_kobj); + if (!kobj) + return -ENOMEM; + + memcpy(&bootinfo, bootinfo_init, sizeof(bootinfo)); + + return sysfs_create_group(kobj, &bootinfo_attr_group); +} +EXPORT_SYMBOL_GPL(firmware_bootinfo_init); diff --git a/include/linux/firmware_bootinfo.h b/include/linux/firmware_bootinfo.h new file mode 100644 index 000000000000..237da83b673c --- /dev/null +++ b/include/linux/firmware_bootinfo.h @@ -0,0 +1,48 @@ +/* SPDX-License-Identifier: GPL-2.0-or-later */ +/* Copyright 2022 IBM Corp. */ + +#include +#include + +#define BOOTINFO_SET(b, n, v) do {b.n.present = true; b.n.value = v; } while (0) + +/** + * struct bootinfo_entry - A bootinfo sysfs entry + * @present: true if the file should be present (visible) in sysfs + * @value: value of the entry, will be printed as 1 or 0 + * + * Contains the state of a given bootinfo sysfs file, to be filled out by the + * platform that wishes it to be present. + * + * It is used by sysfs. The is_present callback tests .present indicate the + * attribute should be shown, and by the show callback tests .value to display + * the value. + */ +struct bootinfo_entry { + bool present; + bool value; +}; + +/** + * struct bootinfo: A collection of bootinfo entries + * @abr_image: sysfs property + * @low_security_key: sysfs property + * @otp_protected: sysfs property + * @secure_boot: sysfs property + * + * The documented set of bootinfo entries to be displayed in + * /sys/firmware/bootinfo. Platform code populates a struct bootinfo and + * passes it to firmware_bootinfo_init, which takes a copy to be used at + * runtime. + * + * See struct bootinfo_entry for a description of the information each entry + * contiains. + */ +struct bootinfo { + struct bootinfo_entry abr_image; + struct bootinfo_entry low_security_key; + struct bootinfo_entry otp_protected; + struct bootinfo_entry secure_boot; +}; + +int firmware_bootinfo_init(struct bootinfo *bootinfo_init);