From nobody Sun Apr 12 04:21:48 2026 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 vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 56EC2C00144 for ; Mon, 1 Aug 2022 15:26:42 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233559AbiHAP0k (ORCPT ); Mon, 1 Aug 2022 11:26:40 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:60400 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233589AbiHAP0e (ORCPT ); Mon, 1 Aug 2022 11:26:34 -0400 Received: from mail-pj1-x102d.google.com (mail-pj1-x102d.google.com [IPv6:2607:f8b0:4864:20::102d]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 9CD4225599 for ; Mon, 1 Aug 2022 08:26:32 -0700 (PDT) Received: by mail-pj1-x102d.google.com with SMTP id 15-20020a17090a098f00b001f305b453feso15654366pjo.1 for ; Mon, 01 Aug 2022 08:26:32 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc; bh=xJfKLSPmY28U/Ok/52P+RKMSe0DWiRerNuTSlPksxN0=; b=h80mh2m6ApvPh2eInNLeAGQKgk4KBQTT8m0ULZaSLzmTy9ewTHTfQRMHfVkeuYDIq4 i1R3ZO4pg7XC7TIPCahHFPM97y+je5kr0ohCegkJx5MNbhkKlf7digjyaX6U09IgbwX9 slPrCPR5k1gd4wvKpbtVSF0qEfVi0SqcFQbVA= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc; bh=xJfKLSPmY28U/Ok/52P+RKMSe0DWiRerNuTSlPksxN0=; b=hW5optdRChmt3JFbcQJMu5WZV+Im3Uce8sZcwyAqviwrIXKiHy/pksMfIHUaWr9MYG 3TH7eYA3gYI/9Wy+9JdJdnCY4GCmAvlirb5gVMo+9+CtaJbm3JmTox/ZNuu/qinET58V IXW3vK4FJHqhVyuobthe5zQX02H0AAZHDoe53H2VPH45hXFB1PQllfsA2PKYsMn1osV0 rce4uzMdlry3Xh5XcU2ym3T8zERNPmwghpKSIWovUY0HFYKWrGKE0GPeFcyGdFleLiVB AR4ObypbZEgU82otWZKE5en2986j1gLhz7Jrwhkc9ZpfSRkLi6yy+Ak1zKmgzB8zJe3t idag== X-Gm-Message-State: ACgBeo3UtNSJXewZ1cJbNlaSxBGexx99hbAwXlKgdKLx78vRsibEkfTV 8tGe2rx4gd8vJX+oD+hb9dpLkJ/6fJOw/V4U X-Google-Smtp-Source: AA6agR7x8Y90ojvb01WIIC52Axj4QwT8dLVqIaPD9P7Ojo6Hqa2O2N4uwQwn+i8ZevBDE0TVVzk9rg== X-Received: by 2002:a17:902:bf06:b0:16d:1fd7:4d3c with SMTP id bi6-20020a170902bf0600b0016d1fd74d3cmr16855489plb.68.1659367591565; Mon, 01 Aug 2022 08:26:31 -0700 (PDT) Received: from jrosenth45.corp.google.com ([2620:0:1000:2514:243d:16b8:9238:5018]) by smtp.gmail.com with ESMTPSA id e9-20020a170902b78900b0016ee4b0bd60sm1958393pls.166.2022.08.01.08.26.30 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 01 Aug 2022 08:26:30 -0700 (PDT) From: Jack Rosenthal To: linux-kernel@vger.kernel.org, chrome-platform@lists.linux.dev Cc: Jack Rosenthal , Stephen Boyd , Guenter Roeck , Julius Werner , kernel test robot Subject: [PATCH v5] firmware: google: Implement cbmem in sysfs driver Date: Mon, 1 Aug 2022 08:26:12 -0700 Message-Id: <20220801152612.3064269-1-jrosenth@chromium.org> X-Mailer: git-send-email 2.37.1.455.g008518b4e5-goog In-Reply-To: <202207301713.q4988FIe-lkp@intel.com> References: <202207301713.q4988FIe-lkp@intel.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Type: text/plain; charset="utf-8" cbmem entries can be read from coreboot table 0x31 (LB_TAG_CBMEM_ENTRY). This commit exports access to cbmem entries in sysfs under /sys/firmware/coreboot/cbmem-*. Link: https://issuetracker.google.com/239604743 Cc: Stephen Boyd Cc: Guenter Roeck Cc: Julius Werner Reported-by: kernel test robot Tested-by: Jack Rosenthal Signed-off-by: Jack Rosenthal Reviewed-by: Julius Werner --- v5: Corrected documentation warnings reported by kernel test robot. .../ABI/testing/sysfs-firmware-coreboot | 17 ++ drivers/firmware/google/Kconfig | 8 + drivers/firmware/google/Makefile | 3 + drivers/firmware/google/cbmem.c | 232 ++++++++++++++++++ drivers/firmware/google/coreboot_table.h | 11 + 5 files changed, 271 insertions(+) create mode 100644 Documentation/ABI/testing/sysfs-firmware-coreboot create mode 100644 drivers/firmware/google/cbmem.c diff --git a/Documentation/ABI/testing/sysfs-firmware-coreboot b/Documentat= ion/ABI/testing/sysfs-firmware-coreboot new file mode 100644 index 000000000000..2401483bb86c --- /dev/null +++ b/Documentation/ABI/testing/sysfs-firmware-coreboot @@ -0,0 +1,17 @@ +What: /sys/firmware/coreboot/ +Date: July 2022 +Contact: Jack Rosenthal +Description: + Coreboot-based BIOS firmware provides a variety of information + in CBMEM. Each CBMEM entry can be found via Coreboot tables. + For each CBMEM entry, the following are exposed: + + =3D=3D=3D=3D=3D=3D=3D =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + address A hexidecimal value of the memory address the data for + the entry begins at. + size The size of the data stored. + id The id corresponding to the entry. A list of ids known + to coreboot can be found in the coreboot source tree at + ``src/commonlib/bsd/include/commonlib/bsd/cbmem_id.h`` + mem A file exposing the raw memory for the entry. + =3D=3D=3D=3D=3D=3D=3D =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D diff --git a/drivers/firmware/google/Kconfig b/drivers/firmware/google/Kcon= fig index 983e07dc022e..bf8316d1cb31 100644 --- a/drivers/firmware/google/Kconfig +++ b/drivers/firmware/google/Kconfig @@ -19,6 +19,14 @@ config GOOGLE_SMI driver provides an interface for reading and writing NVRAM variables. =20 +config GOOGLE_CBMEM + tristate "CBMEM entries in sysfs" + depends on GOOGLE_COREBOOT_TABLE + help + This option enables the kernel to search for Coreboot CBMEM + entries, and expose the memory for each entry in sysfs under + /sys/firmware/coreboot. + config GOOGLE_COREBOOT_TABLE tristate "Coreboot Table Access" depends on HAS_IOMEM && (ACPI || OF) diff --git a/drivers/firmware/google/Makefile b/drivers/firmware/google/Mak= efile index d17caded5d88..8151e323cc43 100644 --- a/drivers/firmware/google/Makefile +++ b/drivers/firmware/google/Makefile @@ -7,5 +7,8 @@ obj-$(CONFIG_GOOGLE_MEMCONSOLE) +=3D memconsole.o obj-$(CONFIG_GOOGLE_MEMCONSOLE_COREBOOT) +=3D memconsole-coreboot.o obj-$(CONFIG_GOOGLE_MEMCONSOLE_X86_LEGACY) +=3D memconsole-x86-legacy.o =20 +# Must come after coreboot_table.o, as this driver depends on that bus typ= e. +obj-$(CONFIG_GOOGLE_CBMEM) +=3D cbmem.o + vpd-sysfs-y :=3D vpd.o vpd_decode.o obj-$(CONFIG_GOOGLE_VPD) +=3D vpd-sysfs.o diff --git a/drivers/firmware/google/cbmem.c b/drivers/firmware/google/cbme= m.c new file mode 100644 index 000000000000..9646a8047742 --- /dev/null +++ b/drivers/firmware/google/cbmem.c @@ -0,0 +1,232 @@ +// SPDX-License-Identifier: GPL-2.0-only +/* + * cbmem.c + * + * Driver for exporting cbmem entries in sysfs. + * + * Copyright 2022 Google LLC + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "coreboot_table.h" + +#define LB_TAG_CBMEM_ENTRY 0x31 + +static struct kobject *coreboot_kobj; + +struct cbmem_entry; +struct cbmem_entry_attr { + struct kobj_attribute kobj_attr; + struct cbmem_entry *entry; +}; + +struct cbmem_entry { + char *kobj_name; + struct kobject *kobj; + struct coreboot_device *dev; + struct bin_attribute mem_file; + char *mem_file_buf; + struct cbmem_entry_attr address_file; + struct cbmem_entry_attr size_file; + struct cbmem_entry_attr id_file; +}; + +static struct cbmem_entry_attr *to_cbmem_entry_attr(struct kobj_attribute = *a) +{ + return container_of(a, struct cbmem_entry_attr, kobj_attr); +} + +static ssize_t cbmem_entry_mem_read(struct file *filp, struct kobject *kob= p, + struct bin_attribute *bin_attr, char *buf, + loff_t pos, size_t count) +{ + struct cbmem_entry *entry =3D bin_attr->private; + + return memory_read_from_buffer(buf, count, &pos, entry->mem_file_buf, + bin_attr->size); +} + +static ssize_t cbmem_entry_mem_write(struct file *filp, struct kobject *ko= bp, + struct bin_attribute *bin_attr, char *buf, + loff_t pos, size_t count) +{ + struct cbmem_entry *entry =3D bin_attr->private; + + if (pos < 0 || pos >=3D bin_attr->size) + return -EINVAL; + if (count > bin_attr->size - pos) + count =3D bin_attr->size - pos; + + memcpy(entry->mem_file_buf + pos, buf, count); + return count; +} + +static ssize_t cbmem_entry_address_show(struct kobject *kobj, + struct kobj_attribute *a, char *buf) +{ + struct cbmem_entry_attr *entry_attr =3D to_cbmem_entry_attr(a); + + return sysfs_emit(buf, "0x%llx\n", + entry_attr->entry->dev->cbmem_entry.address); +} + +static ssize_t cbmem_entry_size_show(struct kobject *kobj, + struct kobj_attribute *a, char *buf) +{ + struct cbmem_entry_attr *entry_attr =3D to_cbmem_entry_attr(a); + + return sysfs_emit(buf, "0x%x\n", + entry_attr->entry->dev->cbmem_entry.entry_size); +} + +static ssize_t cbmem_entry_id_show(struct kobject *kobj, + struct kobj_attribute *a, char *buf) +{ + struct cbmem_entry_attr *entry_attr =3D to_cbmem_entry_attr(a); + + return sysfs_emit(buf, "0x%x\n", + entry_attr->entry->dev->cbmem_entry.id); +} + +static int cbmem_entry_setup(struct cbmem_entry *entry) +{ + int ret; + + entry->mem_file_buf =3D + devm_memremap(&entry->dev->dev, entry->dev->cbmem_entry.address, + entry->dev->cbmem_entry.entry_size, MEMREMAP_WB); + if (!entry->mem_file_buf) + return -ENOMEM; + + entry->kobj_name =3D devm_kasprintf(&entry->dev->dev, GFP_KERNEL, + "cbmem-%08x", + entry->dev->cbmem_entry.id); + if (!entry->kobj_name) + return -ENOMEM; + + entry->kobj =3D kobject_create_and_add(entry->kobj_name, coreboot_kobj); + if (!entry->kobj) + return -ENOMEM; + + sysfs_bin_attr_init(&entry->mem_file); + entry->mem_file.attr.name =3D "mem"; + entry->mem_file.attr.mode =3D 0664; + entry->mem_file.size =3D entry->dev->cbmem_entry.entry_size; + entry->mem_file.read =3D cbmem_entry_mem_read; + entry->mem_file.write =3D cbmem_entry_mem_write; + entry->mem_file.private =3D entry; + ret =3D sysfs_create_bin_file(entry->kobj, &entry->mem_file); + if (ret) + goto free_kobj; + + sysfs_attr_init(&entry->address_file.kobj_attr.attr); + entry->address_file.kobj_attr.attr.name =3D "address"; + entry->address_file.kobj_attr.attr.mode =3D 0444; + entry->address_file.kobj_attr.show =3D cbmem_entry_address_show; + entry->address_file.entry =3D entry; + ret =3D sysfs_create_file(entry->kobj, + &entry->address_file.kobj_attr.attr); + if (ret) + goto free_mem_file; + + sysfs_attr_init(&entry->size_file.kobj_attr.attr); + entry->size_file.kobj_attr.attr.name =3D "size"; + entry->size_file.kobj_attr.attr.mode =3D 0444; + entry->size_file.kobj_attr.show =3D cbmem_entry_size_show; + entry->size_file.entry =3D entry; + ret =3D sysfs_create_file(entry->kobj, &entry->size_file.kobj_attr.attr); + if (ret) + goto free_address_file; + + sysfs_attr_init(&entry->id_file.kobj_attr.attr); + entry->id_file.kobj_attr.attr.name =3D "id"; + entry->id_file.kobj_attr.attr.mode =3D 0444; + entry->id_file.kobj_attr.show =3D cbmem_entry_id_show; + entry->id_file.entry =3D entry; + ret =3D sysfs_create_file(entry->kobj, &entry->id_file.kobj_attr.attr); + if (ret) + goto free_size_file; + + return 0; + +free_size_file: + sysfs_remove_file(entry->kobj, &entry->size_file.kobj_attr.attr); +free_address_file: + sysfs_remove_file(entry->kobj, &entry->address_file.kobj_attr.attr); +free_mem_file: + sysfs_remove_bin_file(entry->kobj, &entry->mem_file); +free_kobj: + kobject_put(entry->kobj); + return ret; +} + +static int cbmem_entry_probe(struct coreboot_device *dev) +{ + struct cbmem_entry *entry; + + entry =3D devm_kzalloc(&dev->dev, sizeof(*entry), GFP_KERNEL); + if (!entry) + return -ENOMEM; + + dev_set_drvdata(&dev->dev, entry); + entry->dev =3D dev; + return cbmem_entry_setup(entry); +} + +static void cbmem_entry_remove(struct coreboot_device *dev) +{ + struct cbmem_entry *entry =3D dev_get_drvdata(&dev->dev); + + sysfs_remove_bin_file(entry->kobj, &entry->mem_file); + sysfs_remove_file(entry->kobj, &entry->address_file.kobj_attr.attr); + sysfs_remove_file(entry->kobj, &entry->size_file.kobj_attr.attr); + sysfs_remove_file(entry->kobj, &entry->id_file.kobj_attr.attr); + kobject_put(entry->kobj); +} + +static struct coreboot_driver cbmem_entry_driver =3D { + .probe =3D cbmem_entry_probe, + .remove =3D cbmem_entry_remove, + .drv =3D { + .name =3D "cbmem", + }, + .tag =3D LB_TAG_CBMEM_ENTRY, +}; + +static int __init cbmem_init(void) +{ + int ret; + + coreboot_kobj =3D kobject_create_and_add("coreboot", firmware_kobj); + if (!coreboot_kobj) + return -ENOMEM; + + ret =3D coreboot_driver_register(&cbmem_entry_driver); + if (ret) { + kobject_put(coreboot_kobj); + return ret; + } + + return 0; +} +module_init(cbmem_init); + +static void __exit cbmem_exit(void) +{ + kobject_put(coreboot_kobj); + coreboot_driver_unregister(&cbmem_entry_driver); +} +module_exit(cbmem_exit); + +MODULE_AUTHOR("Jack Rosenthal "); +MODULE_LICENSE("GPL"); diff --git a/drivers/firmware/google/coreboot_table.h b/drivers/firmware/go= ogle/coreboot_table.h index beb778674acd..6c03a8852d1b 100644 --- a/drivers/firmware/google/coreboot_table.h +++ b/drivers/firmware/google/coreboot_table.h @@ -39,6 +39,16 @@ struct lb_cbmem_ref { u64 cbmem_addr; }; =20 +/* Corresponds to LB_TAG_CBMEM_ENTRY. */ +struct lb_cbmem_entry { + u32 tag; + u32 size; + + u64 address; + u32 entry_size; + u32 id; +}; + /* Describes framebuffer setup by coreboot */ struct lb_framebuffer { u32 tag; @@ -65,6 +75,7 @@ struct coreboot_device { union { struct coreboot_table_entry entry; struct lb_cbmem_ref cbmem_ref; + struct lb_cbmem_entry cbmem_entry; struct lb_framebuffer framebuffer; }; }; --=20 2.37.1.455.g008518b4e5-goog