Skip to contentSkip to conversation

firmware: google: Expose coreboot tables and CBMEM

PATCH In review [email protected] 4 participants 10 messages Apr 7, 2020 – Jul 1, 2020

lore
Share & tools
lore
#0 lore raw

v4 cover firmware: google: Expose coreboot tables and CBMEM

From: Patrick Rudolph <[email protected]>

As user land tools currently use /dev/mem to access coreboot tables and CBMEM, provide a better way by using read-only sysfs attributes.

Unconditionally expose all tables and buffers making future changes in coreboot possible without modifying a kernel driver.

Changes in v2:
- Add ABI documentation
- Add 0x prefix on hex values
- Remove wrong ioremap hint as found by CI

Changes in v3:
- Use BIN_ATTR_RO

Changes in v4:
- Use temporary memremap instead of persistent ioremap
- Constify a struct
- Get rid of unused headers
- Use dev_{get|set}_drvdata
- Use dev_groups to automatically handle attributes
- Updated file description
- Updated ABI documentation

Patrick Rudolph (2):
firmware: google: Expose CBMEM over sysfs
firmware: google: Expose coreboot tables over sysfs

 Documentation/ABI/stable/sysfs-bus-coreboot |  74 +++++++++++
 drivers/firmware/google/Kconfig             |   9 ++
 drivers/firmware/google/Makefile            |   1 +
 drivers/firmware/google/cbmem-coreboot.c    | 128 ++++++++++++++++++++
 drivers/firmware/google/coreboot_table.c    |  58 +++++++++
 drivers/firmware/google/coreboot_table.h    |  14 +++
 6 files changed, 284 insertions(+)
 create mode 100644 Documentation/ABI/stable/sysfs-bus-coreboot
 create mode 100644 drivers/firmware/google/cbmem-coreboot.c
Signature · 1 line
2.24.1
#1 lore raw

PATCH v4 1/2 firmware: google: Expose CBMEM over sysfs

From: Patrick Rudolph <[email protected]>

Make all CBMEM buffers available to userland. This is useful for tools that are currently using /dev/mem.

Make the id, size and address available, as well as the raw table data.

Tools can easily scan the right CBMEM buffer by reading /sys/bus/coreboot/drivers/cbmem/coreboot*/cbmem_attributes/id or /sys/bus/coreboot/devices/coreboot*/cbmem_attributes/id

The binary table data can then be read from /sys/bus/coreboot/drivers/cbmem/coreboot*/cbmem_attributes/data or /sys/bus/coreboot/devices/coreboot*/cbmem_attributes/data

---
-v2:
- Add ABI documentation
- Add 0x prefix on hex values
-v3:
- Use BIN_ATTR_RO
-v4:
- Use temporary memremap instead of persistent ioremap
- Constify a struct
- Get rid of unused headers
- Use dev_{get|set}_drvdata
- Use dev_groups to automatically handle attributes
- Updated file description
- Updated ABI documentation

---
 Documentation/ABI/stable/sysfs-bus-coreboot |  44 +++++++
 drivers/firmware/google/Kconfig             |   9 ++
 drivers/firmware/google/Makefile            |   1 +
 drivers/firmware/google/cbmem-coreboot.c    | 128 ++++++++++++++++++++
 drivers/firmware/google/coreboot_table.h    |  14 +++
 5 files changed, 196 insertions(+)
 create mode 100644 Documentation/ABI/stable/sysfs-bus-coreboot
 create mode 100644 drivers/firmware/google/cbmem-coreboot.c
Documentation/ABI/stable/sysfs-bus-coreboot new file +44 -0
new file mode 100644
index 000000000000..6055906f41f2
@@ -0,0 +1,44 @@
+What:		/sys/bus/coreboot/devices/.../cbmem_attributes/id
+Date:		Apr 2020
+KernelVersion:	5.6
+Contact:	Patrick Rudolph <[email protected]>
+Description:
+		coreboot device directory can contain a file named
+		cbmem_attributes/id if the device corresponds to a CBMEM
+		buffer.
+		The file holds an ASCII representation of the CBMEM ID in hex
+		(e.g. 0xdeadbeef).
+
+What:		/sys/bus/coreboot/devices/.../cbmem_attributes/size
+Date:		Apr 2020
+KernelVersion:	5.6
+Contact:	Patrick Rudolph <[email protected]>
+Description:
+		coreboot device directory can contain a file named
+		cbmem_attributes/size if the device corresponds to a CBMEM
+		buffer.
+		The file holds an representation as decimal number of the
+		CBMEM buffer size (e.g. 64).
+
+What:		/sys/bus/coreboot/devices/.../cbmem_attributes/address
+Date:		Apr 2020
+KernelVersion:	5.6
+Contact:	Patrick Rudolph <[email protected]>
+Description:
+		coreboot device directory can contain a file named
+		cbmem_attributes/address if the device corresponds to a CBMEM
+		buffer.
+		The file holds an ASCII representation of the physical address
+		of the CBMEM buffer in hex (e.g. 0x000000008000d000) and should
+		be used for debugging only.
+
+What:		/sys/bus/coreboot/devices/.../cbmem_attributes/data
+Date:		Apr 2020
+KernelVersion:	5.6
+Contact:	Patrick Rudolph <[email protected]>
+Description:
+		coreboot device directory can contain a file named
+		cbmem_attributes/data if the device corresponds to a CBMEM
+		buffer.
+		The file holds a read-only binary representation of the CBMEM
+		buffer.
drivers/firmware/google/Kconfig +9 -0
index a3a6ca659ffa..11a67c397ab3 100644
@@ -58,6 +58,15 @@ config GOOGLE_FRAMEBUFFER_COREBOOT
 	  This option enables the kernel to search for a framebuffer in
 	  the coreboot table.  If found, it is registered with simplefb.
 
+config GOOGLE_CBMEM_COREBOOT
+	tristate "Coreboot CBMEM access"
+	depends on GOOGLE_COREBOOT_TABLE
+	help
+	  This option exposes all available CBMEM buffers to userland.
+	  The CBMEM id, size and address as well as the raw table data
+	  are exported as sysfs attributes of the corresponding coreboot
+	  table.
+
 config GOOGLE_MEMCONSOLE_COREBOOT
 	tristate "Firmware Memory Console"
 	depends on GOOGLE_COREBOOT_TABLE
drivers/firmware/google/Makefile +1 -0
index d17caded5d88..62053cd6d058 100644
@@ -2,6 +2,7 @@
 
 obj-$(CONFIG_GOOGLE_SMI)		+= gsmi.o
 obj-$(CONFIG_GOOGLE_COREBOOT_TABLE)        += coreboot_table.o
+obj-$(CONFIG_GOOGLE_CBMEM_COREBOOT)        += cbmem-coreboot.o
 obj-$(CONFIG_GOOGLE_FRAMEBUFFER_COREBOOT)  += framebuffer-coreboot.o
 obj-$(CONFIG_GOOGLE_MEMCONSOLE)            += memconsole.o
 obj-$(CONFIG_GOOGLE_MEMCONSOLE_COREBOOT)   += memconsole-coreboot.o
drivers/firmware/google/cbmem-coreboot.c new file +128 -0

128 lines not on this page · raw message

drivers/firmware/google/coreboot_table.h +14 -0
index 7b7b4a6eedda..fc20b8649882 100644
@@ -59,6 +59,19 @@ struct lb_framebuffer {
 	u8  reserved_mask_size;
 };
 
+/*
+ * There can be more than one of these records as there is one per cbmem entry.
+ * Describes a buffer in memory containing runtime data.
+ */
+struct lb_cbmem_entry {
+	u32 tag;
+	u32 size;
+
+	u64 address;
+	u32 entry_size;
+	u32 id;
+};
+
 /* A device, additionally with information from coreboot. */
 struct coreboot_device {
 	struct device dev;
@@ -66,6 +79,7 @@ struct coreboot_device {
 		struct coreboot_table_entry entry;
 		struct lb_cbmem_ref cbmem_ref;
 		struct lb_framebuffer framebuffer;
+		struct lb_cbmem_entry cbmem_entry;
 	};
 };
 
Signature · 1 line
2.24.1
Reviewed-by Tested-by on v4 1/2
#2 lore raw

Re: [PATCH v4 1/2] firmware: google: Expose CBMEM over sysfs

Quoted 48 lines · On 4/7/20 3:29 AM, [email protected] wrote:

From: Patrick Rudolph <[email protected]>

Make all CBMEM buffers available to userland. This is useful for tools that are currently using /dev/mem.

Make the id, size and address available, as well as the raw table data.

Tools can easily scan the right CBMEM buffer by reading /sys/bus/coreboot/drivers/cbmem/coreboot*/cbmem_attributes/id or /sys/bus/coreboot/devices/coreboot*/cbmem_attributes/id

The binary table data can then be read from /sys/bus/coreboot/drivers/cbmem/coreboot*/cbmem_attributes/data or /sys/bus/coreboot/devices/coreboot*/cbmem_attributes/data

---
-v2:
- Add ABI documentation
- Add 0x prefix on hex values
-v3:
- Use BIN_ATTR_RO
-v4:
- Use temporary memremap instead of persistent ioremap
- Constify a struct
- Get rid of unused headers
- Use dev_{get|set}_drvdata
- Use dev_groups to automatically handle attributes
- Updated file description
- Updated ABI documentation

---
 Documentation/ABI/stable/sysfs-bus-coreboot |  44 +++++++
 drivers/firmware/google/Kconfig             |   9 ++
 drivers/firmware/google/Makefile            |   1 +
 drivers/firmware/google/cbmem-coreboot.c    | 128 ++++++++++++++++++++
 drivers/firmware/google/coreboot_table.h    |  14 +++
 5 files changed, 196 insertions(+)
 create mode 100644 Documentation/ABI/stable/sysfs-bus-coreboot
 create mode 100644 drivers/firmware/google/cbmem-coreboot.c
Documentation/ABI/stable/sysfs-bus-coreboot new file +0 -0
new file mode 100644
index 000000000000..6055906f41f2

Documentation/ABI/stable/sysfs-bus-coreboot line 3

Quoted 3 lines
Documentation/ABI/stable/sysfs-bus-coreboot new file +3 -0
@@ -0,0 +1,44 @@
+What:		/sys/bus/coreboot/devices/.../cbmem_attributes/id
+Date:		Apr 2020
+KernelVersion:	5.6

I guess these will be 5.8 now.

Quoted 7 lines
Documentation/ABI/stable/sysfs-bus-coreboot new file +7 -0
+Contact:	Patrick Rudolph <[email protected]>
+Description:
+		coreboot device directory can contain a file named
+		cbmem_attributes/id if the device corresponds to a CBMEM
+		buffer.
+		The file holds an ASCII representation of the CBMEM ID in hex
+		(e.g. 0xdeadbeef).

Documentation/ABI/stable/sysfs-bus-coreboot line 20

Quoted 10 lines
Documentation/ABI/stable/sysfs-bus-coreboot new file +10 -0
+
+What:		/sys/bus/coreboot/devices/.../cbmem_attributes/size
+Date:		Apr 2020
+KernelVersion:	5.6
+Contact:	Patrick Rudolph <[email protected]>
+Description:
+		coreboot device directory can contain a file named
+		cbmem_attributes/size if the device corresponds to a CBMEM
+		buffer.
+		The file holds an representation as decimal number of the

nit: "a representation" (maybe "a decimal representation"?)

Quoted 161 lines
Documentation/ABI/stable/sysfs-bus-coreboot new file +24 -0
+		CBMEM buffer size (e.g. 64).
+
+What:		/sys/bus/coreboot/devices/.../cbmem_attributes/address
+Date:		Apr 2020
+KernelVersion:	5.6
+Contact:	Patrick Rudolph <[email protected]>
+Description:
+		coreboot device directory can contain a file named
+		cbmem_attributes/address if the device corresponds to a CBMEM
+		buffer.
+		The file holds an ASCII representation of the physical address
+		of the CBMEM buffer in hex (e.g. 0x000000008000d000) and should
+		be used for debugging only.
+
+What:		/sys/bus/coreboot/devices/.../cbmem_attributes/data
+Date:		Apr 2020
+KernelVersion:	5.6
+Contact:	Patrick Rudolph <[email protected]>
+Description:
+		coreboot device directory can contain a file named
+		cbmem_attributes/data if the device corresponds to a CBMEM
+		buffer.
+		The file holds a read-only binary representation of the CBMEM
+		buffer.
drivers/firmware/google/Kconfig +9 -0
index a3a6ca659ffa..11a67c397ab3 100644
@@ -58,6 +58,15 @@ config GOOGLE_FRAMEBUFFER_COREBOOT
 	  This option enables the kernel to search for a framebuffer in
 	  the coreboot table.  If found, it is registered with simplefb.
 
+config GOOGLE_CBMEM_COREBOOT
+	tristate "Coreboot CBMEM access"
+	depends on GOOGLE_COREBOOT_TABLE
+	help
+	  This option exposes all available CBMEM buffers to userland.
+	  The CBMEM id, size and address as well as the raw table data
+	  are exported as sysfs attributes of the corresponding coreboot
+	  table.
+
 config GOOGLE_MEMCONSOLE_COREBOOT
 	tristate "Firmware Memory Console"
 	depends on GOOGLE_COREBOOT_TABLE
drivers/firmware/google/Makefile +1 -0
index d17caded5d88..62053cd6d058 100644
@@ -2,6 +2,7 @@
 
 obj-$(CONFIG_GOOGLE_SMI)		+= gsmi.o
 obj-$(CONFIG_GOOGLE_COREBOOT_TABLE)        += coreboot_table.o
+obj-$(CONFIG_GOOGLE_CBMEM_COREBOOT)        += cbmem-coreboot.o
 obj-$(CONFIG_GOOGLE_FRAMEBUFFER_COREBOOT)  += framebuffer-coreboot.o
 obj-$(CONFIG_GOOGLE_MEMCONSOLE)            += memconsole.o
 obj-$(CONFIG_GOOGLE_MEMCONSOLE_COREBOOT)   += memconsole-coreboot.o
drivers/firmware/google/cbmem-coreboot.c new file +99 -0
new file mode 100644
index 000000000000..f76704a6eec7
@@ -0,0 +1,128 @@
+// SPDX-License-Identifier: GPL-2.0-only
+/*
+ * cbmem-coreboot.c
+ *
+ * Exports CBMEM as attributes in sysfs.
+ *
+ * Copyright 2012-2013 David Herrmann <[email protected]>
+ * Copyright 2017 Google Inc.
+ * Copyright 2019 9elements Agency GmbH
+ */
+
+#include <linux/device.h>
+#include <linux/kernel.h>
+#include <linux/string.h>
+#include <linux/module.h>
+#include <linux/io.h>
+
+#include "coreboot_table.h"
+
+#define CB_TAG_CBMEM_ENTRY 0x31
+
+struct cb_priv {
+	struct lb_cbmem_entry entry;
+};
+
+static ssize_t id_show(struct device *dev,
+		       struct device_attribute *attr, char *buffer)
+{
+	const struct cb_priv *priv = dev_get_drvdata(dev);
+
+	return sprintf(buffer, "%#08x\n", priv->entry.id);
+}
+
+static ssize_t size_show(struct device *dev,
+			 struct device_attribute *attr, char *buffer)
+{
+	const struct cb_priv *priv = dev_get_drvdata(dev);
+
+	return sprintf(buffer, "%u\n", priv->entry.entry_size);
+}
+
+static ssize_t address_show(struct device *dev,
+			    struct device_attribute *attr, char *buffer)
+{
+	const struct cb_priv *priv = dev_get_drvdata(dev);
+
+	return sprintf(buffer, "%#016llx\n", priv->entry.address);
+}
+
+static DEVICE_ATTR_RO(id);
+static DEVICE_ATTR_RO(size);
+static DEVICE_ATTR_RO(address);
+
+static struct attribute *cb_mem_attrs[] = {
+	&dev_attr_address.attr,
+	&dev_attr_id.attr,
+	&dev_attr_size.attr,
+	NULL
+};
+
+static ssize_t data_read(struct file *filp, struct kobject *kobj,
+			 struct bin_attribute *bin_attr,
+			 char *buffer, loff_t offset, size_t count)
+{
+	const struct device *dev = kobj_to_dev(kobj);
+	const struct cb_priv *priv = dev_get_drvdata(dev);
+	void *ptr;
+
+	/* CBMEM is always RAM with unknown caching attributes. */
+	ptr = memremap(priv->entry.address, priv->entry.entry_size,
+		       MEMREMAP_WB | MEMREMAP_WT);
+	if (!ptr)
+		return -ENOMEM;
+
+	count = memory_read_from_buffer(buffer, count, &offset, ptr,
+					priv->entry.entry_size);
+	memunmap(ptr);
+
+	return count;
+}
+
+static BIN_ATTR_RO(data, 0);
+
+static struct bin_attribute *cb_mem_bin_attrs[] = {
+	&bin_attr_data,
+	NULL
+};
+
+static const struct attribute_group cb_mem_attr_group = {
+	.name = "cbmem_attributes",
+	.attrs = cb_mem_attrs,
+	.bin_attrs = cb_mem_bin_attrs,
+};
+
+static const struct attribute_group *attribute_groups[] = {
+	&cb_mem_attr_group,
+	NULL,
+};
+

drivers/firmware/google/cbmem-coreboot.c line 109

Quoted 10 lines
drivers/firmware/google/cbmem-coreboot.c new file +10 -0
+static int cbmem_probe(struct coreboot_device *cdev)
+{
+	struct device *dev = &cdev->dev;
+	struct cb_priv *priv;
+
+	priv = devm_kmalloc(dev, sizeof(*priv), GFP_KERNEL);
+	if (!priv)
+		return -ENOMEM;
+
+	memcpy(&priv->entry, &cdev->cbmem_entry, sizeof(priv->entry));

I don't think it is necessary to create a second copy of the table entry, when it is already available at cdev->cbmem_entry. You could do:

	dev_set_drvdata(dev, cdev);

and that removes the need for struct cb_priv.

Otherwise,

I hacked nvramtool to pull the CMOS layout from /sys/bus/coreboot/devices/coreboot0/attributes/data, and that seemed to work.

Cheers,
Samuel

Quoted 52 lines
drivers/firmware/google/cbmem-coreboot.c new file +19 -0
+
+	dev_set_drvdata(dev, priv);
+
+	return 0;
+}
+
+static struct coreboot_driver cbmem_driver = {
+	.probe = cbmem_probe,
+	.drv = {
+		.name = "cbmem",
+		.dev_groups = attribute_groups,
+	},
+	.tag = CB_TAG_CBMEM_ENTRY,
+};
+
+module_coreboot_driver(cbmem_driver);
+
+MODULE_AUTHOR("9elements Agency GmbH");
+MODULE_LICENSE("GPL");
drivers/firmware/google/coreboot_table.h +14 -0
index 7b7b4a6eedda..fc20b8649882 100644
@@ -59,6 +59,19 @@ struct lb_framebuffer {
 	u8  reserved_mask_size;
 };
 
+/*
+ * There can be more than one of these records as there is one per cbmem entry.
+ * Describes a buffer in memory containing runtime data.
+ */
+struct lb_cbmem_entry {
+	u32 tag;
+	u32 size;
+
+	u64 address;
+	u32 entry_size;
+	u32 id;
+};
+
 /* A device, additionally with information from coreboot. */
 struct coreboot_device {
 	struct device dev;
@@ -66,6 +79,7 @@ struct coreboot_device {
 		struct coreboot_table_entry entry;
 		struct lb_cbmem_ref cbmem_ref;
 		struct lb_framebuffer framebuffer;
+		struct lb_cbmem_entry cbmem_entry;
 	};
 };
 
#3 lore raw

Re: [PATCH v4 1/2] firmware: google: Expose CBMEM over sysfs

In reply to [email protected]

Quoting [email protected] (2020-04-07 01:29:06)

Quoted 12 lines

From: Patrick Rudolph <[email protected]>

Make all CBMEM buffers available to userland. This is useful for tools that are currently using /dev/mem.

Make the id, size and address available, as well as the raw table data.

Tools can easily scan the right CBMEM buffer by reading /sys/bus/coreboot/drivers/cbmem/coreboot*/cbmem_attributes/id or /sys/bus/coreboot/devices/coreboot*/cbmem_attributes/id

Quoted 7 lines

The binary table data can then be read from /sys/bus/coreboot/drivers/cbmem/coreboot*/cbmem_attributes/data or /sys/bus/coreboot/devices/coreboot*/cbmem_attributes/data

---

Sorry, this fell off my radar. Looks close though so please resend.

Quoted 29 lines
Documentation/ABI/stable/sysfs-bus-coreboot new file +23 -0
new file mode 100644
index 000000000000..6055906f41f2
@@ -0,0 +1,44 @@
+What:          /sys/bus/coreboot/devices/.../cbmem_attributes/id
+Date:          Apr 2020
+KernelVersion: 5.6
+Contact:       Patrick Rudolph <[email protected]>
+Description:
+               coreboot device directory can contain a file named
+               cbmem_attributes/id if the device corresponds to a CBMEM
+               buffer.
+               The file holds an ASCII representation of the CBMEM ID in hex
+               (e.g. 0xdeadbeef).
+
+What:          /sys/bus/coreboot/devices/.../cbmem_attributes/size
+Date:          Apr 2020
+KernelVersion: 5.6
+Contact:       Patrick Rudolph <[email protected]>
+Description:
+               coreboot device directory can contain a file named
+               cbmem_attributes/size if the device corresponds to a CBMEM
+               buffer.
+               The file holds an representation as decimal number of the
+               CBMEM buffer size (e.g. 64).
+
+What:          /sys/bus/coreboot/devices/.../cbmem_attributes/address

Documentation/ABI/stable/sysfs-bus-coreboot line 33

Quoted 10 lines
Documentation/ABI/stable/sysfs-bus-coreboot new file +10 -0
+Date:          Apr 2020
+KernelVersion: 5.6
+Contact:       Patrick Rudolph <[email protected]>
+Description:
+               coreboot device directory can contain a file named
+               cbmem_attributes/address if the device corresponds to a CBMEM
+               buffer.
+               The file holds an ASCII representation of the physical address
+               of the CBMEM buffer in hex (e.g. 0x000000008000d000) and should
+               be used for debugging only.

If this is for debugging purposes only perhaps it should go into debugfs. We try to not leak information about physical addresses to userspace and this would let an attacker understand where memory may be. That's not ideal and should be avoided.

Quoted 28 lines
Documentation/ABI/stable/sysfs-bus-coreboot new file +11 -0
+
+What:          /sys/bus/coreboot/devices/.../cbmem_attributes/data
+Date:          Apr 2020
+KernelVersion: 5.6
+Contact:       Patrick Rudolph <[email protected]>
+Description:
+               coreboot device directory can contain a file named
+               cbmem_attributes/data if the device corresponds to a CBMEM
+               buffer.
+               The file holds a read-only binary representation of the CBMEM
+               buffer.
drivers/firmware/google/cbmem-coreboot.c new file +11 -0
new file mode 100644
index 000000000000..f76704a6eec7
@@ -0,0 +1,128 @@
+// SPDX-License-Identifier: GPL-2.0-only
+/*
+ * cbmem-coreboot.c
+ *
+ * Exports CBMEM as attributes in sysfs.
+ *
+ * Copyright 2012-2013 David Herrmann <[email protected]>
+ * Copyright 2017 Google Inc.
+ * Copyright 2019 9elements Agency GmbH
+ */
+

[..]

drivers/firmware/google/cbmem-coreboot.c line 97

Quoted 13 lines
drivers/firmware/google/cbmem-coreboot.c new file +13 -0
+       &bin_attr_data,
+       NULL
+};
+
+static const struct attribute_group cb_mem_attr_group = {
+       .name = "cbmem_attributes",
+       .attrs = cb_mem_attrs,
+       .bin_attrs = cb_mem_bin_attrs,
+};
+
+static const struct attribute_group *attribute_groups[] = {
+       &cb_mem_attr_group,
+       NULL,

Nitpick: Drop the comma on sentinel so nothing can come after lest a compile error happens.

Quoted 4 lines
drivers/firmware/google/cbmem-coreboot.c new file +4 -0
+};
+
+static int cbmem_probe(struct coreboot_device *cdev)
+{

drivers/firmware/google/cbmem-coreboot.c line 111

Quoted 10 lines
drivers/firmware/google/cbmem-coreboot.c new file +10 -0
+       struct device *dev = &cdev->dev;
+       struct cb_priv *priv;
+
+       priv = devm_kmalloc(dev, sizeof(*priv), GFP_KERNEL);
+       if (!priv)
+               return -ENOMEM;
+
+       memcpy(&priv->entry, &cdev->cbmem_entry, sizeof(priv->entry));
+
+       dev_set_drvdata(dev, priv);

Agreed, avoid the memcpy().

Quoted 3 lines
drivers/firmware/google/cbmem-coreboot.c new file +3 -0
+
+       return 0;
+}
#4 lore raw

Re: [PATCH v4 1/2] firmware: google: Expose CBMEM over sysfs

Quoted 8 lines
Quoted 8 lines
Documentation/ABI/stable/sysfs-bus-coreboot new file +8 -0
+What:          /sys/bus/coreboot/devices/.../cbmem_attributes/address
+Date:          Apr 2020
+KernelVersion: 5.6
+Contact:       Patrick Rudolph <[email protected]>
+Description:
+               coreboot device directory can contain a file named
+               cbmem_attributes/address if the device corresponds to a CBMEM
+               buffer.
Quoted 8 lines

Documentation/ABI/stable/sysfs-bus-coreboot line 33

Quoted 3 lines
Documentation/ABI/stable/sysfs-bus-coreboot new file +3 -0
+               The file holds an ASCII representation of the physical address
+               of the CBMEM buffer in hex (e.g. 0x000000008000d000) and should
+               be used for debugging only.

If this is for debugging purposes only perhaps it should go into debugfs. We try to not leak information about physical addresses to userspace and this would let an attacker understand where memory may be. That's not ideal and should be avoided.

This is memory allocated by firmware and not subject to (k)ASLR, so nothing valuable can be leaked here. The same addresses could already be parsed out of /sys/firmware/log. Before this interface we usually accessed this stuff via /dev/mem (and tools that want to remain backwards-compatible will probably want to keep doing that), so having a quick shorthand to grab physical addresses can be convenient.

#5 lore raw

Re: [PATCH v4 1/2] firmware: google: Expose CBMEM over sysfs

Quoting Julius Werner (2020-06-25 13:51:34)

Quoted 17 lines
Quoted 8 lines
Quoted 8 lines
Documentation/ABI/stable/sysfs-bus-coreboot new file +8 -0
+What:          /sys/bus/coreboot/devices/.../cbmem_attributes/address
+Date:          Apr 2020
+KernelVersion: 5.6
+Contact:       Patrick Rudolph <[email protected]>
+Description:
+               coreboot device directory can contain a file named
+               cbmem_attributes/address if the device corresponds to a CBMEM
+               buffer.
Quoted 8 lines

Documentation/ABI/stable/sysfs-bus-coreboot line 33

Quoted 3 lines
Documentation/ABI/stable/sysfs-bus-coreboot new file +3 -0
+               The file holds an ASCII representation of the physical address
+               of the CBMEM buffer in hex (e.g. 0x000000008000d000) and should
+               be used for debugging only.

If this is for debugging purposes only perhaps it should go into debugfs. We try to not leak information about physical addresses to userspace and this would let an attacker understand where memory may be. That's not ideal and should be avoided.

Quoted 6 lines

This is memory allocated by firmware and not subject to (k)ASLR, so nothing valuable can be leaked here. The same addresses could already be parsed out of /sys/firmware/log. Before this interface we usually accessed this stuff via /dev/mem (and tools that want to remain backwards-compatible will probably want to keep doing that), so having a quick shorthand to grab physical addresses can be convenient.

Ok. Regardless of the concern of the physical address is there any usage of this attribute by userspace? The description makes it sound like it's a pure debug feature, which implies that it should be in debugfs and not in sysfs.

#6 lore raw

Re: [PATCH v4 1/2] firmware: google: Expose CBMEM over sysfs

Quoted 4 lines

Ok. Regardless of the concern of the physical address is there any usage of this attribute by userspace? The description makes it sound like it's a pure debug feature, which implies that it should be in debugfs and not in sysfs.

I'll leave that up to Patrick. I doubt we'd want to create a whole separate debugfs hierarchy just for this. Like I said you can just read it out of the log too, this would just make it a little bit more convenient. It's not like it would be the only informational attribute in sysfs...

#7 lore raw

PATCH v4 2/2 firmware: google: Expose coreboot tables over sysfs

In reply to [email protected]

From: Patrick Rudolph <[email protected]>

Make all coreboot table entries available to userland. This is useful for tools that are currently using /dev/mem.

Besides the tag and size also expose the raw table data itself.

Update the ABI documentation to explain the new sysfs interface.

Tools can easily scan for the right coreboot table by reading /sys/bus/coreboot/devices/coreboot*/attributes/id The binary table data can then be read from /sys/bus/coreboot/devices/coreboot*/attributes/data

---
-v2:
- Add ABI documentation
- Add 0x prefix on hex values
- Remove wrong ioremap hint as found by CI
-v3:
- Use BIN_ATTR_RO
-v4:
- Updated ABI documentation

---
 Documentation/ABI/stable/sysfs-bus-coreboot | 30 +++++++++++
 drivers/firmware/google/coreboot_table.c    | 58 +++++++++++++++++++++
 2 files changed, 88 insertions(+)
Documentation/ABI/stable/sysfs-bus-coreboot +30 -0
index 6055906f41f2..328153a1b3f4 100644
@@ -42,3 +42,33 @@ Description:
 		buffer.
 		The file holds a read-only binary representation of the CBMEM
 		buffer.
+
+What:		/sys/bus/coreboot/devices/.../attributes/id
+Date:		Apr 2020
+KernelVersion:	5.6
+Contact:	Patrick Rudolph <[email protected]>
+Description:
+		coreboot device directory can contain a file named attributes/id.
+		The file holds an ASCII representation of the coreboot table ID
+		in hex (e.g. 0x000000ef). On coreboot enabled platforms the ID is
+		usually called TAG.
+
+What:		/sys/bus/coreboot/devices/.../attributes/size
+Date:		Apr 2020
+KernelVersion:	5.6
+Contact:	Patrick Rudolph <[email protected]>
+Description:
+		coreboot device directory can contain a file named
+		attributes/size.
+		The file holds an ASCII representation as decimal number of the
+		coreboot table size (e.g. 64).
+
+What:		/sys/bus/coreboot/devices/.../attributes/data
+Date:		Apr 2020
+KernelVersion:	5.6
+Contact:	Patrick Rudolph <[email protected]>
+Description:
+		coreboot device directory can contain a file named
+		attributes/data.
+		The file holds a read-only binary representation of the coreboot
+		table.
drivers/firmware/google/coreboot_table.c +58 -0

79 lines not on this page · raw message

Signature · 1 line
2.24.1
Reviewed-by Tested-by on v4 2/2
#8 lore raw

Re: [PATCH v4 2/2] firmware: google: Expose coreboot tables over sysfs

Quoted 7 lines · On 4/7/20 3:29 AM, [email protected] wrote:

From: Patrick Rudolph <[email protected]>

Make all coreboot table entries available to userland. This is useful for tools that are currently using /dev/mem.

Besides the tag and size also expose the raw table data itself.

Quoted 8 lines

Update the ABI documentation to explain the new sysfs interface.

Tools can easily scan for the right coreboot table by reading /sys/bus/coreboot/devices/coreboot*/attributes/id The binary table data can then be read from /sys/bus/coreboot/devices/coreboot*/attributes/data

Cheers,
Samuel

Reviewed-by on v4 2/2
#9 lore raw

Re: [PATCH v4 2/2] firmware: google: Expose coreboot tables over sysfs

In reply to [email protected]

Quoting [email protected] (2020-04-07 01:29:07)

Quoted 9 lines

From: Patrick Rudolph <[email protected]>

Make all coreboot table entries available to userland. This is useful for tools that are currently using /dev/mem.

Besides the tag and size also expose the raw table data itself.

Update the ABI documentation to explain the new sysfs interface.

Quoted 7 lines

Tools can easily scan for the right coreboot table by reading /sys/bus/coreboot/devices/coreboot*/attributes/id The binary table data can then be read from /sys/bus/coreboot/devices/coreboot*/attributes/data

---

Minor nits below:

Quoted 34 lines

-v2:
- Add ABI documentation
- Add 0x prefix on hex values
- Remove wrong ioremap hint as found by CI
-v3:
- Use BIN_ATTR_RO
-v4:
- Updated ABI documentation

---
 Documentation/ABI/stable/sysfs-bus-coreboot | 30 +++++++++++
 drivers/firmware/google/coreboot_table.c    | 58 +++++++++++++++++++++
 2 files changed, 88 insertions(+)
Documentation/ABI/stable/sysfs-bus-coreboot +0 -0
index 6055906f41f2..328153a1b3f4 100644
drivers/firmware/google/coreboot_table.c +2 -0
index 0205987a4fd4..d0fc3eb93f4f 100644
@@ -3,9 +3,11 @@
  * coreboot_table.c
  *
  * Module providing coreboot table access.
+ * Exports coreboot tables as attributes in sysfs.
  *
  * Copyright 2017 Google Inc.
  * Copyright 2017 Samuel Holland <[email protected]>
+ * Copyright 2019 9elements Agency GmbH
  */
 
 #include <linux/acpi.h>

drivers/firmware/google/coreboot_table.c void coreboot_driver_unregister(struct coreboot_driver *driver) · line 92

Quoted 7 lines
drivers/firmware/google/coreboot_table.c +4 -0
@@ -84,6 +86,60 @@ void coreboot_driver_unregister(struct coreboot_driver *driver)
 }
 EXPORT_SYMBOL(coreboot_driver_unregister);
 
+static ssize_t id_show(struct device *dev,
+                      struct device_attribute *attr, char *buffer)
+{
+       struct coreboot_device *device = CB_DEV(dev);

Wouldn't hurt to throw const in front of these.

drivers/firmware/google/coreboot_table.c void coreboot_driver_unregister(struct coreboot_driver *driver) · line 100

Quoted 8 lines
drivers/firmware/google/coreboot_table.c +8 -0
+
+       return sprintf(buffer, "0x%08x\n", device->entry.tag);
+}
+
+static ssize_t size_show(struct device *dev,
+                        struct device_attribute *attr, char *buffer)
+{
+       struct coreboot_device *device = CB_DEV(dev);

And these. But the function is so short probably doesn't really matter.

Quoted 15 lines
drivers/firmware/google/coreboot_table.c +15 -0
+
+       return sprintf(buffer, "%u\n", device->entry.size);
+}
+
+static DEVICE_ATTR_RO(id);
+static DEVICE_ATTR_RO(size);
+
+static struct attribute *cb_dev_attrs[] = {
+       &dev_attr_id.attr,
+       &dev_attr_size.attr,
+       NULL
+};
+
+static ssize_t data_read(struct file *filp, struct kobject *kobj,
+                        struct bin_attribute *bin_attr,

drivers/firmware/google/coreboot_table.c void coreboot_driver_unregister(struct coreboot_driver *driver) · line 125

Quoted 10 lines
drivers/firmware/google/coreboot_table.c +10 -0
+                        char *buffer, loff_t offset, size_t count)
+{
+       struct device *dev = kobj_to_dev(kobj);
+       struct coreboot_device *device = CB_DEV(dev);
+
+       return memory_read_from_buffer(buffer, count, &offset,
+                                      &device->entry, device->entry.size);
+}
+
+static BIN_ATTR_RO(data, 0);

Still no way to figure out the actual size? Can we add the bin_attribute at runtime?

Quoted 6 lines
drivers/firmware/google/coreboot_table.c +6 -0
+
+static struct bin_attribute *cb_dev_bin_attrs[] = {
+       &bin_attr_data,
+       NULL
+};
+