Skip to contentSkip to conversation

Introduce support for Dell SMBIOS over WMI

PATCH Superseded Mario Limonciello 5 participants 30 messages Oct 14, 2017 – Oct 17, 2017

Subsystems (2)

v8 of 12 Superseded Latest is v12 →

lore
Share & tools
lore
#0 lore raw

v8 cover Introduce support for Dell SMBIOS over WMI

The existing way that the dell-smbios helper module and associated other drivers (dell-laptop, dell-wmi) communicate with the platform really isn't secure. It requires creating a buffer in physical DMA32 memory space and passing that to the platform via SMM.

Since the platform got a physical memory pointer, you've just got to trust that the platform has only modified (and accessed) memory within that buffer.

Dell Platform designers recognize this security risk and offer a safer way to communicate with the platform over ACPI. This is in turn exposed via a WMI interface to the OS.

When communicating over WMI-ACPI the communication doesn't occur with physical memory pointers. When the ASL is invoked, the fixed length ACPI buffer is copied to a small operating region. The ASL will invoke the SMI, and SMM will only have access to this operating region. When the ASL returns the buffer is copied back for the OS to process.

This method of communication should also deprecate the usage of the dcdbas kernel module and software dependent upon it's interface. Instead offer a character device interface for communicating with this ASL method to allow userspace to use instead.

To faciliate that this patch series introduces a generic way for WMI drivers to be able to create discoverable character devices with a predictable IOCTL interface through the WMI bus when desired. Requiring WMI drivers to explicitly ask for this functionality will act as an effective vendor whitelist to character device creation.

Some of this work is the basis for what will be a proper interpreter of MOF in the kernel and controls for what drivers will be able to do with that MOF.

NOTE: This patch series is intended to go on top of platform-drivers-x86 linux-next.

For convenience the entire series including those is also available here:
https://github.com/superm1/linux/tree/wmi-smbios
changes bweteen v7 and v8:
* fix typo s/desc_buffer/buffer/ in 32k split commit
* Add missing include for <linux/types.h> in uapi
* dell-smbios: initialize correct attribute files
* Output class/select in debug messages in base 10.
* Don't send the u64 length argument to ACPI call length
* Only filter calls that originate from userspace
* Filter kernel calls from userspace
* Add more blacklisting/whitelisting logic per Alan Cox's recommendations
* Adjust tokens attributes to only be accessible to CAP_SYS_ADMIN
* Set default permissions on character device.
* Move token, class, select definitions for items used in drivers to dells-smios.h.
changes between v6 and v7:
* Use deferred probing in any function results needed from dell-wmi-descriptor
* Protect against a list entry disappearing when running an ioctl from WMI bus
* Move ioctl uapi declaration into a common header file for all WMI drivers.
* New patch: create required_buffer_size for method type WMI objects in WMI core rather than vendor driver.
* WSMT patch: Add comment explaining WSMT
* Filtering patch: Add comments explaining what I can about blacklists.
* WMI, dell-smbios-wmi: Add back in compat ioctl, it is needed. My previous test was erroneous in forgetting to copy an updated header into the chroot.
* dell-laptop, dell-wmi: allocate less memory for buffer, page no longer needed
* dell-laptop make the changes (hopefully) more amenable to pali style wise.
* read SMM cmd address in dell-smbios-smm rather than dell-smbios
* shuffle structure definitions for this
changes between v5 and v6:
* Adjust Kconfig for dell-smbios to not depend on anything.
- SMM and WMI drivers will both select dell-smbios
- Technically the module can run on it's own (it's just not useful)
* Add a new tokens sysfs interface
* Rework blacklisting into easily expandable structures
* Lock modules during ioctl call from WMI bus
* drop references to compat ioctl in both WMI and dell-smbios-wmi drivers. (Made sure ioctl worked in both 32 and 64 userspace though)
* dell-smbios-wmi
- s/buffer_size/req_buf_size/ to make it clearer that userspace doesn't get to set this, it's set internally.
- read just buffer length before reading whole structure from userspace
- if buffer length is too big, show a warning
- I tried to rename argument for unlocked_ioctl, but this caused problems in matching initialization lists, so still casting.
- Add comments clarifying everything happening in ioctl
changes between v4 and v5:
* Remove Andy's S suggested by in sysfs tokens patch
* Make some output in dell-wmi-descriptor debug only
* Adjust various Kconfig dependencies as recommended by Darren
* Drop patch to set dell-smbios to default on ACPI_WMI,
it's not needed after the Kconfig dependencies rework
* Move WSMT check patch to after WMI driver is introduced.
* Make common smbios call return value int as there could be errors now with drivers not being loaded.
* Make SMBIOS call methods for all drivers return status
* Reorder patches 2 and 4.
* Don't export symbols for calling functions on dispatchers
* wmi patch:
- use sprintf instead of strcpy
- remove needless bool for tracking found
- adjust logic to look for instance_count - 1, it's zero based not 1 based.
- Pass a callback to unlocked_ioctl instead of full file operations object
- ioctl: Don't fail on no bound WMI driver
- Add missing header for uapi
- Make helper macros include data types
- add compat ioctl
* dell-smbios:
- Add filtering functionality for SMBIOS calling interface
- Use dev_dbg rather than pr_debug where possible
* dell-smbios-wmi:
- test for handle on b1 table
- correct misc flags comment
- drop access checks
- use dev_dbg instead of pr_* calls
- use filtering functionality
- add mutexes around list add/remove
- switch from get_first_device to get_first_priv and inline
- add mutex locking to prevent unloading mid-call.
- update to new ioctl passing
- fix userspace uapi to use __u32 instead of u32
- Don't use a header file for internal only use
- make sure it works with compat ioctl
* dell-laptop: make dell_smbios_send_request local function for boilerplate calls.
* ioctl patch
- Change API to have a simpler structure to pass back and forth
- Rename header file
- Export to sysfs properly
- Add the size of the length variable into the requested buffersize to sysfs, do math in the driver when copying data around.
changes between v3 and v4:
* Make Dell WMI notifications driver fail notifications fail when WMI descriptor driver is unavailable.
* Add a patch to check for Dell OEM string to stop dell-smbios module from being loaded in unsupported systems manually.
* Split Dell WMI descriptor into it's own driver for others to query.
* Test the misc BIOS flags table to decide whether to run in WMI or SMI mode.
* s/dell-wmi-smbios/dell-smbios/ in a few patch titles
* Add missing Suggested-by to a patch from v2 (Sorry Andy S!)
* Adjust cleanup order of wmi character device.
* Fix a remaining reference to /dev/wmi-$driver
* Use get_order to get size for pages
* Split up dell-smbios into 3 drivers:
dell-smbios
-> dell-smbios-smm
-> dell-smbios-wmi
If either of the two dispatcher drivers is unloaded but the other still works, gracefully fall back to that driver
* Remove unneded open and release on file operations in WMI driver
* Switch to misc character device in WMI bus.
* Query the size of the calling interface buffer from WMI descriptor driver.
* Require userspace to use this information to build an appropriately sized buffer.
* Verify the size of buffer passed from userspace matches expectation of buffer processed in kernel.
* Add more documentation about the IOCTL API.
* Add in a recommendation from Andy S about outputing tokens
* Add a patch to test for non-functional SMM due to WSMT
* Define macros for IOCTL's through the WMI bus.
* Pass all IOCTL calls for WMI drivers through WMI bus
WMI bus will guarantee instance count matches and prevent creating too many more IOCTLs.
changes between v2 and v3:
* Drop patches 1-7, they're in Darren's review tree now
* Add missing newline on new Documentation
* Add Reviewed by from Edward O'Callaghan
* Adjust path of character device from /dev/wmi-$driver to /dev/wmi/$driver
* Store wmi_device pointer rather than using a boolean has_wmi to indicate driver is running in WMI mode
* Don't guard free_page from freeing NULL (this is OK)
* New patch: add wmidev_evaluate_method to wmi bus as recommended by Andy L
* Adjust ACPI-WMI interface for this patch change ^
* Add back in sysfs token patch, drop 2nd and 3rd ioctls per discussion on mailing list.
* On sysfs interface: adjust the delimiter to be tabs
* Drop the rename dell-smbios -> dell-wmi-smbios patch
* Remove/move some unnecessary tests for CONFIG_DCDBAS
* Reword s/platform/SMM/ in the WMI-ACPI patch.
* Update Kconfig to recommend using CONFIG_DCDBAS on old machines.
* Allocate buffer to the same pointer regardless of the struct assigned to it. Keep track of the buffer size for cleaning up.
* Explain policy around character device creation in commit message
changes between v1 and v2:
* Introduce another patch to sort the includes in wmi.c
* Introduce another patch to cleanup dell_wmi_check_descriptor_buffer checks.
* Add a commit message to the pr_fmt commit
* Introduce includes to wmi.c in proper location
* Add Reviewed-by to relevant patches from Pali
* Make the WMI introduction patch fallback to legacy SMI
if compiled with CONFIG_DCDBAS
* Separate format of WMI and SMI buffers. WMI buffer supports more arguments and data.
* Adjust the rename patch for changes to fallback
* Drop sysfs token creation patch
* Adjust WMI descriptor check patch for changes to fallback
* introduce another patch to remove needless includes in dell-smbios.c
* Add token ioctl interface to character device.
- Can query number of tokens
- Can query values in all tokens
* Expose format of all buffers and IOCTL commands to uapi header
* Drop the read interface from character device. It doesn't make sense with multiple different ioctl methods.
* Default WMI interface to 32k (This would normally be queried via MOF, but that's not possible yet)
* Create separate buffers for WMI and SMI. If WMI is available, free the SMI buffer.
* Reorder patches so all fixups come first in the series.

Mario Limonciello (15):
platform/x86: wmi: Add new method wmidev_evaluate_method platform/x86: dell-wmi: increase severity of some failures platform/x86: dell-wmi: clean up wmi descriptor check platform/x86: dell-wmi: allow 32k return size in the descriptor platform/x86: dell-wmi-descriptor: split WMI descriptor into it's own
driver
platform/x86: wmi: Don't allow drivers to get each other's GUIDs platform/x86: dell-smbios: only run if proper oem string is detected platform/x86: dell-smbios: Add a sysfs interface for SMBIOS tokens platform/x86: dell-smbios: Introduce dispatcher for SMM calls platform/x86: dell-smbios-wmi: Add new WMI dispatcher driver platform/x86: dell-smbios-smm: test for WSMT
platform/x86: dell-smbios: Add filtering support platform/x86: wmi: Add sysfs attribute for required_buffer_size platform/x86: wmi: create userspace interface for drivers platform/x86: dell-smbios-wmi: introduce userspace interface

 Documentation/ABI/testing/dell-smbios-wmi          |  41 ++
 .../ABI/testing/sysfs-platform-dell-smbios         |  21 +
 MAINTAINERS                                        |  25 +
 drivers/platform/x86/Kconfig                       |  34 +-
 drivers/platform/x86/Makefile                      |   3 +
 drivers/platform/x86/dell-laptop.c                 | 283 +++++-------
 drivers/platform/x86/dell-smbios-smm.c             | 195 ++++++++
 drivers/platform/x86/dell-smbios-wmi.c             | 292 ++++++++++++
 drivers/platform/x86/dell-smbios.c                 | 510 +++++++++++++++++++--
 drivers/platform/x86/dell-smbios.h                 |  68 ++-
 drivers/platform/x86/dell-wmi-descriptor.c         | 162 +++++++
 drivers/platform/x86/dell-wmi-descriptor.h         |  18 +
 drivers/platform/x86/dell-wmi.c                    |  91 +---
 drivers/platform/x86/wmi.c                         | 192 +++++++-
 include/linux/wmi.h                                |  17 +-
 include/uapi/linux/wmi.h                           |  52 +++
 16 files changed, 1655 insertions(+), 349 deletions(-)
 create mode 100644 Documentation/ABI/testing/dell-smbios-wmi
 create mode 100644 Documentation/ABI/testing/sysfs-platform-dell-smbios
 create mode 100644 drivers/platform/x86/dell-smbios-smm.c
 create mode 100644 drivers/platform/x86/dell-smbios-wmi.c
 create mode 100644 drivers/platform/x86/dell-wmi-descriptor.c
 create mode 100644 drivers/platform/x86/dell-wmi-descriptor.h
 create mode 100644 include/uapi/linux/wmi.h
Signature · 1 line
2.14.1
#1 lore raw

PATCH v8 1/15 platform/x86: wmi: Add new method wmidev_evaluate_method

Drivers properly using the wmibus can pass their wmi_device pointer rather than the GUID back to the WMI bus to evaluate the proper methods.

Any "new" drivers added that use the WMI bus should use this rather than the old wmi_evaluate_method that would take the GUID.

---
 drivers/platform/x86/wmi.c | 28 ++++++++++++++++++++++++----
 include/linux/wmi.h        |  6 ++++++
 2 files changed, 30 insertions(+), 4 deletions(-)
drivers/platform/x86/wmi.c +24 -4
index 7a05843aff19..4d73a87c2ddf 100644
@@ -200,6 +200,28 @@ static acpi_status wmi_method_enable(struct wmi_block *wblock, int enable)
  */
 acpi_status wmi_evaluate_method(const char *guid_string, u8 instance,
 u32 method_id, const struct acpi_buffer *in, struct acpi_buffer *out)
+{
+	struct wmi_block *wblock = NULL;
+
+	if (!find_guid(guid_string, &wblock))
+		return AE_ERROR;
+	return wmidev_evaluate_method(&wblock->dev, instance, method_id,
+				      in, out);
+}
+EXPORT_SYMBOL_GPL(wmi_evaluate_method);
+
+/**
+ * wmidev_evaluate_method - Evaluate a WMI method
+ * @wdev: A wmi bus device from a driver
+ * @instance: Instance index
+ * @method_id: Method ID to call
+ * &in: Buffer containing input for the method call
+ * &out: Empty buffer to return the method results
+ *
+ * Call an ACPI-WMI method
+ */
+acpi_status wmidev_evaluate_method(struct wmi_device *wdev, u8 instance,
+	u32 method_id, const struct acpi_buffer *in, struct acpi_buffer *out)
 {
 	struct guid_block *block = NULL;
 	struct wmi_block *wblock = NULL;
@@ -209,9 +231,7 @@ u32 method_id, const struct acpi_buffer *in, struct acpi_buffer *out)
 	union acpi_object params[3];
 	char method[5] = "WM";
 
-	if (!find_guid(guid_string, &wblock))
-		return AE_ERROR;
-
+	wblock = container_of(wdev, struct wmi_block, dev);
 	block = &wblock->gblock;
 	handle = wblock->acpi_device->handle;
 
@@ -246,7 +266,7 @@ u32 method_id, const struct acpi_buffer *in, struct acpi_buffer *out)
 
 	return status;
 }
-EXPORT_SYMBOL_GPL(wmi_evaluate_method);
+EXPORT_SYMBOL_GPL(wmidev_evaluate_method);
 
 static acpi_status __query_block(struct wmi_block *wblock, u8 instance,
 				 struct acpi_buffer *out)
include/linux/wmi.h +6 -0
index cd0d7734dc49..2cd10c3b89e9 100644
@@ -26,6 +26,12 @@ struct wmi_device {
 	bool setable;
 };
 
+/* evaluate the ACPI method associated with this device */
+extern acpi_status wmidev_evaluate_method(struct wmi_device *wdev,
+					  u8 instance, u32 method_id,
+					  const struct acpi_buffer *in,
+					  struct acpi_buffer *out);
+
 /* Caller must kfree the result. */
 extern union acpi_object *wmidev_block_query(struct wmi_device *wdev,
 					     u8 instance);
Signature · 1 line
2.14.1
#2 lore raw

PATCH v8 2/15 platform/x86: dell-wmi: increase severity of some failures

In reply to Mario Limonciello

There is a lot of error checking in place for the format of the WMI descriptor buffer, but some of the potentially raised issues should be considered critical failures.

If the buffer size or header don't match, this is a good indication that the buffer format changed in a way that the rest of the data should not be relied upon.

For the remaining data set vectors, continue to notate a warning in undefined results, but as those are fields that the descriptor intended to refer to other applications, don't fail if they're new values.

---
 drivers/platform/x86/dell-wmi.c | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)
drivers/platform/x86/dell-wmi.c +7 -6
index 1fbef560ca67..2cfaaa8faf0a 100644
@@ -657,17 +657,18 @@ static int dell_wmi_check_descriptor_buffer(struct wmi_device *wdev)
 		dev_err(&wdev->dev,
 			"Dell descriptor buffer has invalid length (%d)\n",
 			obj->buffer.length);
-		if (obj->buffer.length < 16) {
-			ret = -EINVAL;
-			goto out;
-		}
+		ret = -EINVAL;
+		goto out;
 	}
 
 	buffer = (u32 *)obj->buffer.pointer;
 
-	if (buffer[0] != 0x4C4C4544 && buffer[1] != 0x494D5720)
-		dev_warn(&wdev->dev, "Dell descriptor buffer has invalid signature (%*ph)\n",
+	if (buffer[0] != 0x4C4C4544 && buffer[1] != 0x494D5720) {
+		dev_err(&wdev->dev, "Dell descriptor buffer has invalid signature (%*ph)\n",
 			8, buffer);
+		ret = -EINVAL;
+		goto out;
+	}
 
 	if (buffer[2] != 0 && buffer[2] != 1)
 		dev_warn(&wdev->dev, "Dell descriptor buffer has unknown version (%d)\n",
Signature · 1 line
2.14.1
#3 lore raw

PATCH v8 3/15 platform/x86: dell-wmi: clean up wmi descriptor check

In reply to Mario Limonciello

Some cases the wrong type was used for errors and checks can be done more cleanly.

---
 drivers/platform/x86/dell-wmi.c | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)
drivers/platform/x86/dell-wmi.c +5 -5
index 2cfaaa8faf0a..ece2fe341f01 100644
@@ -663,19 +663,19 @@ static int dell_wmi_check_descriptor_buffer(struct wmi_device *wdev)
 
 	buffer = (u32 *)obj->buffer.pointer;
 
-	if (buffer[0] != 0x4C4C4544 && buffer[1] != 0x494D5720) {
-		dev_err(&wdev->dev, "Dell descriptor buffer has invalid signature (%*ph)\n",
-			8, buffer);
+	if (strncmp(obj->string.pointer, "DELL WMI", 8) != 0) {
+		dev_err(&wdev->dev, "Dell descriptor buffer has invalid signature (%8ph)\n",
+			buffer);
 		ret = -EINVAL;
 		goto out;
 	}
 
 	if (buffer[2] != 0 && buffer[2] != 1)
-		dev_warn(&wdev->dev, "Dell descriptor buffer has unknown version (%d)\n",
+		dev_warn(&wdev->dev, "Dell descriptor buffer has unknown version (%u)\n",
 			buffer[2]);
 
 	if (buffer[3] != 4096)
-		dev_warn(&wdev->dev, "Dell descriptor buffer has invalid buffer length (%d)\n",
+		dev_warn(&wdev->dev, "Dell descriptor buffer has invalid buffer length (%u)\n",
 			buffer[3]);
 
 	priv->interface_version = buffer[2];
Signature · 1 line
2.14.1
#4 lore raw

PATCH v8 4/15 platform/x86: dell-wmi: allow 32k return size in the descriptor

In reply to Mario Limonciello

Some platforms this year will be adopting 32k WMI buffer, so don't complain when encountering those.

---
 drivers/platform/x86/dell-wmi.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/platform/x86/dell-wmi.c +2 -2
index ece2fe341f01..2578dff90a14 100644
@@ -624,7 +624,7 @@ static void dell_wmi_input_destroy(struct wmi_device *wdev)
  * Vendor Signature          0       4    "DELL"
  * Object Signature          4       4    " WMI"
  * WMI Interface Version     8       4    <version>
- * WMI buffer length        12       4    4096
+ * WMI buffer length        12       4    4096 or 32768
  */
 static int dell_wmi_check_descriptor_buffer(struct wmi_device *wdev)
 {
@@ -674,7 +674,7 @@ static int dell_wmi_check_descriptor_buffer(struct wmi_device *wdev)
 		dev_warn(&wdev->dev, "Dell descriptor buffer has unknown version (%u)\n",
 			buffer[2]);
 
-	if (buffer[3] != 4096)
+	if (buffer[3] != 4096 && buffer[3] != 32768)
 		dev_warn(&wdev->dev, "Dell descriptor buffer has invalid buffer length (%u)\n",
 			buffer[3]);
 
Signature · 1 line
2.14.1
#5 lore raw

PATCH v8 5/15 platform/x86: dell-wmi-descriptor: split WMI descriptor into it's own driver

In reply to Mario Limonciello

All communication on individual GUIDs should occur in separate drivers. Allowing a driver to communicate with the bus to another GUID is just a hack that discourages drivers to adopt the bus model.

The information found from the WMI descriptor driver is now exported for use by other drivers.

---
 MAINTAINERS                                |   5 +
 drivers/platform/x86/Kconfig               |   5 +
 drivers/platform/x86/Makefile              |   1 +
 drivers/platform/x86/dell-wmi-descriptor.c | 162 +++++++++++++++++++++++++++++
 drivers/platform/x86/dell-wmi-descriptor.h |  18 ++++
 drivers/platform/x86/dell-wmi.c            |  81 +--------------
 6 files changed, 194 insertions(+), 78 deletions(-)
 create mode 100644 drivers/platform/x86/dell-wmi-descriptor.c
 create mode 100644 drivers/platform/x86/dell-wmi-descriptor.h
MAINTAINERS +5 -0
index 2347e36588dc..f4cf35950b08 100644
@@ -4013,6 +4013,11 @@ M:	Pali Rohár <[email protected]>
 S:	Maintained
 F:	drivers/platform/x86/dell-wmi.c
 
+DELL WMI DESCRIPTOR DRIVER
+M:	Mario Limonciello <[email protected]>
+S:	Maintained
+F:	drivers/platform/x86/dell-wmi-descriptor.c
+
 DELTA ST MEDIA DRIVER
 M:	Hugues Fruchet <[email protected]>
 L:	[email protected]
drivers/platform/x86/Kconfig +5 -0
index 1f7959ff055c..7722923c968c 100644
@@ -121,6 +121,7 @@ config DELL_WMI
 	depends on DMI
 	depends on INPUT
 	depends on ACPI_VIDEO || ACPI_VIDEO = n
+	select DELL_WMI_DESCRIPTOR
 	select DELL_SMBIOS
 	select INPUT_SPARSEKMAP
 	---help---
@@ -129,6 +130,10 @@ config DELL_WMI
 	  To compile this driver as a module, choose M here: the module will
 	  be called dell-wmi.
 
+config DELL_WMI_DESCRIPTOR
+	tristate
+	depends on ACPI_WMI
+
 config DELL_WMI_AIO
 	tristate "WMI Hotkeys for Dell All-In-One series"
 	depends on ACPI_WMI
drivers/platform/x86/Makefile +1 -0
index 2b315d0df3b7..8636f5d3424f 100644
@@ -14,6 +14,7 @@ obj-$(CONFIG_COMPAL_LAPTOP)	+= compal-laptop.o
 obj-$(CONFIG_DELL_SMBIOS)	+= dell-smbios.o
 obj-$(CONFIG_DELL_LAPTOP)	+= dell-laptop.o
 obj-$(CONFIG_DELL_WMI)		+= dell-wmi.o
+obj-$(CONFIG_DELL_WMI_DESCRIPTOR)	+= dell-wmi-descriptor.o
 obj-$(CONFIG_DELL_WMI_AIO)	+= dell-wmi-aio.o
 obj-$(CONFIG_DELL_WMI_LED)	+= dell-wmi-led.o
 obj-$(CONFIG_DELL_SMO8800)	+= dell-smo8800.o
drivers/platform/x86/dell-wmi-descriptor.c new file +162 -0

162 lines not on this page · raw message

drivers/platform/x86/dell-wmi-descriptor.h new file +18 -0
new file mode 100644
index 000000000000..3e652c6da034
@@ -0,0 +1,18 @@
+/*
+ *
+ *  Copyright (c) 2017 Dell Inc.
+ *
+ *  This program is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License version 2 as
+ *  published by the Free Software Foundation.
+ */
+
+#ifndef _DELL_WMI_DESCRIPTOR_H_
+#define _DELL_WMI_DESCRIPTOR_H_
+
+#include <linux/wmi.h>
+
+bool dell_wmi_get_interface_version(u32 *version);
+bool dell_wmi_get_size(u32 *size);
+
+#endif
drivers/platform/x86/dell-wmi.c +3 -78

111 lines not on this page · raw message

Signature · 1 line
2.14.1
#6 lore raw

PATCH v8 6/15 platform/x86: wmi: Don't allow drivers to get each other's GUIDs

In reply to Mario Limonciello

The only driver using this was dell-wmi, and it really was a hack. The driver was getting a data attribute from another driver and this type of action should not be encouraged.

Rather drivers that need to interact with one another should pass data back and forth via exported functions.

---
 drivers/platform/x86/wmi.c | 17 -----------------
 include/linux/wmi.h        |  4 ----
 2 files changed, 21 deletions(-)
drivers/platform/x86/wmi.c +0 -17
index 4d73a87c2ddf..bcb41c1c7f52 100644
@@ -368,23 +368,6 @@ union acpi_object *wmidev_block_query(struct wmi_device *wdev, u8 instance)
 }
 EXPORT_SYMBOL_GPL(wmidev_block_query);
 
-struct wmi_device *wmidev_get_other_guid(struct wmi_device *wdev,
-					 const char *guid_string)
-{
-	struct wmi_block *this_wb = container_of(wdev, struct wmi_block, dev);
-	struct wmi_block *other_wb;
-
-	if (!find_guid(guid_string, &other_wb))
-		return NULL;
-
-	if (other_wb->acpi_device != this_wb->acpi_device)
-		return NULL;
-
-	get_device(&other_wb->dev.dev);
-	return &other_wb->dev;
-}
-EXPORT_SYMBOL_GPL(wmidev_get_other_guid);
-
 /**
  * wmi_set_block - Write to a WMI block
  * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
include/linux/wmi.h +0 -4
index 2cd10c3b89e9..ddee427e0721 100644
@@ -36,10 +36,6 @@ extern acpi_status wmidev_evaluate_method(struct wmi_device *wdev,
 extern union acpi_object *wmidev_block_query(struct wmi_device *wdev,
 					     u8 instance);
 
-/* Gets another device on the same bus.  Caller must put_device the result. */
-extern struct wmi_device *wmidev_get_other_guid(struct wmi_device *wdev,
-						const char *guid_string);
-
 struct wmi_device_id {
 	const char *guid_string;
 };
Signature · 1 line
2.14.1
#7 lore raw

PATCH v8 7/15 platform/x86: dell-smbios: only run if proper oem string is detected

In reply to Mario Limonciello

The proper way to indicate that a system is a 'supported' Dell System is by the presence of this string in OEM strings.

Allowing the driver to load on non-Dell systems will have undefined results.

---
 drivers/platform/x86/dell-smbios.c | 7 +++++++
 1 file changed, 7 insertions(+)
drivers/platform/x86/dell-smbios.c +7 -0
index e9b1ca07c872..7e779278d054 100644
@@ -172,8 +172,15 @@ static void __init find_tokens(const struct dmi_header *dm, void *dummy)
 
 static int __init dell_smbios_init(void)
 {
+	const struct dmi_device *valid;
 	int ret;
 
+	valid = dmi_find_device(DMI_DEV_TYPE_OEM_STRING, "Dell System", NULL);
+	if (!valid) {
+		pr_err("Unable to run on non-Dell system\n");
+		return -ENODEV;
+	}
+
 	dmi_walk(find_tokens, NULL);
 
 	if (!da_tokens)  {
Signature · 1 line
2.14.1
#8 lore raw

PATCH v8 8/15 platform/x86: dell-smbios: Add a sysfs interface for SMBIOS tokens

In reply to Mario Limonciello

Currently userspace tools can access system tokens via the dcdbas kernel module and a SMI call that will cause the platform to execute SMM code.

With a goal in mind of deprecating the dcdbas kernel module a different method for accessing these tokens from userspace needs to be created.

This is intentionally marked to only be readable as a process with CAP_SYS_ADMIN as it can contain sensitive information about the platform's configuration.

While adding this interface I found that some tokens are duplicated. These need to be ignored from sysfs to avoid duplicate files.

MAINTAINERS was missing for this driver. Add myself and Pali to maintainers list for it.

---
 .../ABI/testing/sysfs-platform-dell-smbios         |  21 ++
 MAINTAINERS                                        |   7 +
 drivers/platform/x86/dell-smbios.c                 | 211 ++++++++++++++++++++-
 3 files changed, 238 insertions(+), 1 deletion(-)
 create mode 100644 Documentation/ABI/testing/sysfs-platform-dell-smbios
Documentation/ABI/testing/sysfs-platform-dell-smbios new file +21 -0
new file mode 100644
index 000000000000..205d3b6361e0
@@ -0,0 +1,21 @@
+What:		/sys/devices/platform/<platform>/tokens/*
+Date:		November 2017
+KernelVersion:	4.15
+Contact:	"Mario Limonciello" <[email protected]>
+Description:
+		A read-only description of Dell platform tokens
+		available on the machine.
+
+		Each token attribute is available as a pair of
+		sysfs attributes readable by a process with
+		CAP_SYS_ADMIN.
+
+		For example the token ID "5" would be available
+		as the following attributes:
+
+		0005_location
+		0005_value
+
+		Tokens will vary from machine to machine, and
+		only tokens available on that machine will be
+		displayed.
MAINTAINERS +7 -0
index f4cf35950b08..09e774f1d0b2 100644
@@ -3978,6 +3978,13 @@ M:	"Maciej W. Rozycki" <[email protected]>
 S:	Maintained
 F:	drivers/net/fddi/defxx.*
 
+DELL SMBIOS DRIVER
+M:	Pali Rohár <[email protected]>
+M:	Mario Limonciello <[email protected]>
+L:	[email protected]
+S:	Maintained
+F:	drivers/platform/x86/dell-smbios.*
+
 DELL LAPTOP DRIVER
 M:	Matthew Garrett <[email protected]>
 M:	Pali Rohár <[email protected]>
drivers/platform/x86/dell-smbios.c +210 -1

252 lines not on this page · raw message

Signature · 1 line
2.14.1
#9 lore raw

Re: [PATCH v8 08/15] platform/x86: dell-smbios: Add a sysfs interface for SMBIOS tokens

reproduce:

Hi Mario,

[auto build test WARNING on platform-drivers-x86/for-next]
[also build test WARNING on v4.14-rc5 next-20171016]
[if your patch is applied to the wrong git tree, please drop us a note to help improve the system]

url:    https://github.com/0day-ci/linux/commits/Mario-Limonciello/Introduce-support-for-Dell-SMBIOS-over-WMI/20171017-103109
base:   git://git.infradead.org/users/dvhart/linux-platform-drivers-x86.git for-next
config: i386-randconfig-x074-201742 (attached as .config)
compiler: gcc-6 (Debian 6.2.0-3) 6.2.0 20160901
reproduce:
        # save the attached .config to linux build tree
        make ARCH=i386 

All warnings (new ones prefixed by >>):

In file included from include/linux/linkage.h:4:0,

                    from include/linux/kernel.h:6,
                    from drivers/platform/x86/dell-smbios.c:17:
   drivers/platform/x86/dell-smbios.c: In function 'location_show':
   drivers/platform/x86/dell-smbios.c:218:7: error: implicit declaration of function 'capable' [-Werror=implicit-function-declaration]
     if (!capable(CAP_SYS_ADMIN))
          ^
   include/linux/compiler.h:156:30: note: in definition of macro '__trace_if'
     if (__builtin_constant_p(!!(cond)) ? !!(cond) :   \
                                 ^~~~
>> drivers/platform/x86/dell-smbios.c:218:2: note: in expansion of macro 'if'
     if (!capable(CAP_SYS_ADMIN))
     ^~
   drivers/platform/x86/dell-smbios.c:218:15: error: 'CAP_SYS_ADMIN' undeclared (first use in this function)
     if (!capable(CAP_SYS_ADMIN))
                  ^
   include/linux/compiler.h:156:30: note: in definition of macro '__trace_if'
     if (__builtin_constant_p(!!(cond)) ? !!(cond) :   \
                                 ^~~~
>> drivers/platform/x86/dell-smbios.c:218:2: note: in expansion of macro 'if'
     if (!capable(CAP_SYS_ADMIN))
     ^~
   drivers/platform/x86/dell-smbios.c:218:15: note: each undeclared identifier is reported only once for each function it appears in
     if (!capable(CAP_SYS_ADMIN))
                  ^
   include/linux/compiler.h:156:30: note: in definition of macro '__trace_if'
     if (__builtin_constant_p(!!(cond)) ? !!(cond) :   \
                                 ^~~~
>> drivers/platform/x86/dell-smbios.c:218:2: note: in expansion of macro 'if'
     if (!capable(CAP_SYS_ADMIN))
     ^~
   drivers/platform/x86/dell-smbios.c: In function 'value_show':
   drivers/platform/x86/dell-smbios.c:232:15: error: 'CAP_SYS_ADMIN' undeclared (first use in this function)
     if (!capable(CAP_SYS_ADMIN))
                  ^
   include/linux/compiler.h:156:30: note: in definition of macro '__trace_if'
     if (__builtin_constant_p(!!(cond)) ? !!(cond) :   \
                                 ^~~~
   drivers/platform/x86/dell-smbios.c:232:2: note: in expansion of macro 'if'
     if (!capable(CAP_SYS_ADMIN))
     ^~

cc1: some warnings being treated as errors

vim +/if +218 drivers/platform/x86/dell-smbios.c

212
213 static ssize_t location_show(struct device *dev,
214 struct device_attribute *attr, char *buf)
215 {
216 int i;
217

 > 218		if (!capable(CAP_SYS_ADMIN))

219 return -EPERM;
220
221 i = match_attribute(dev, attr);
222 if (i > 0)
223 return scnprintf(buf, PAGE_SIZE, "%08x", da_tokens[i].location);
224 return 0;
225 }
226

---
0-DAY kernel test infrastructure Open Source Technology Center
https://lists.01.org/pipermail/kbuild-all Intel Corporation

#10 lore raw

PATCH v8 9/15 platform/x86: dell-smbios: Introduce dispatcher for SMM calls

In reply to Mario Limonciello

This splits up the dell-smbios driver into two drivers:
* dell-smbios
* dell-smbios-smm

dell-smbios can operate with multiple different dispatcher drivers to perform SMBIOS operations.

Also modify the interface that dell-laptop and dell-wmi use align to this model more closely. Rather than a single global buffer being allocated for all drivers, each driver will allocate and be responsible for it's own buffer. The pointer will be passed to the calling function and each dispatcher driver will then internally copy it to the proper location to perform it's call.

Add defines for calls used by these methods in the dell-smbios.h header for tracking purposes.

---
 MAINTAINERS                            |   6 +
 drivers/platform/x86/Kconfig           |  15 +-
 drivers/platform/x86/Makefile          |   1 +
 drivers/platform/x86/dell-laptop.c     | 283 ++++++++++++---------------------
 drivers/platform/x86/dell-smbios-smm.c | 162 +++++++++++++++++++
 drivers/platform/x86/dell-smbios.c     | 120 +++++++-------
 drivers/platform/x86/dell-smbios.h     |  46 +++++-
 drivers/platform/x86/dell-wmi.c        |  11 +-
 8 files changed, 397 insertions(+), 247 deletions(-)
 create mode 100644 drivers/platform/x86/dell-smbios-smm.c
MAINTAINERS +6 -0
index 09e774f1d0b2..9dc1ee9603e7 100644
@@ -3985,6 +3985,12 @@ L:	[email protected]
 S:	Maintained
 F:	drivers/platform/x86/dell-smbios.*
 
+DELL SMBIOS SMM DRIVER
+M:	Mario Limonciello <[email protected]>
+L:	[email protected]
+S:	Maintained
+F:	drivers/platform/x86/dell-smbios-smm.c
+
 DELL LAPTOP DRIVER
 M:	Matthew Garrett <[email protected]>
 M:	Pali Rohár <[email protected]>
drivers/platform/x86/Kconfig +11 -4
index 7722923c968c..53a2de781de6 100644
@@ -93,12 +93,19 @@ config ASUS_LAPTOP
 
 config DELL_SMBIOS
 	tristate
-	select DCDBAS
+
+config DELL_SMBIOS_SMM
+	tristate "Dell SMBIOS calling interface (SMM implementation)"
+	depends on DCDBAS
+	default DCDBAS
+	select DELL_SMBIOS
 	---help---
-	This module provides common functions for kernel modules using
-	Dell SMBIOS.
+	This provides an implementation for the Dell SMBIOS calling interface
+	communicated over SMI/SMM.
 
-	If you have a Dell laptop, say Y or M here.
+	If you have a Dell computer from <=2017 you should say Y or M here.
+	If you aren't sure and this module doesn't work for your computer
+	it just won't load.
 
 config DELL_LAPTOP
 	tristate "Dell Laptop Extras"
drivers/platform/x86/Makefile +1 -0
index 8636f5d3424f..e743615241f8 100644
@@ -12,6 +12,7 @@ obj-$(CONFIG_MSI_LAPTOP)	+= msi-laptop.o
 obj-$(CONFIG_ACPI_CMPC)		+= classmate-laptop.o
 obj-$(CONFIG_COMPAL_LAPTOP)	+= compal-laptop.o
 obj-$(CONFIG_DELL_SMBIOS)	+= dell-smbios.o
+obj-$(CONFIG_DELL_SMBIOS_SMM)	+= dell-smbios-smm.o
 obj-$(CONFIG_DELL_LAPTOP)	+= dell-laptop.o
 obj-$(CONFIG_DELL_WMI)		+= dell-wmi.o
 obj-$(CONFIG_DELL_WMI_DESCRIPTOR)	+= dell-wmi-descriptor.o
drivers/platform/x86/dell-laptop.c +105 -178

538 lines not on this page · raw message

drivers/platform/x86/dell-smbios-smm.c new file +162 -0

162 lines not on this page · raw message

drivers/platform/x86/dell-smbios.c +64 -56

192 lines not on this page · raw message

drivers/platform/x86/dell-smbios.h +41 -5

59 lines not on this page · raw message

drivers/platform/x86/dell-wmi.c +7 -4
index b74d328c9da2..d2dfdbcadf46 100644
@@ -638,13 +638,16 @@ static int dell_wmi_events_set_enabled(bool enable)
 	struct calling_interface_buffer *buffer;
 	int ret;
 
-	buffer = dell_smbios_get_buffer();
+	buffer = kzalloc(sizeof(struct calling_interface_buffer), GFP_KERNEL);
+	buffer->class = CLASS_INFO;
+	buffer->select = SELECT_APP_REGISTRATION;
 	buffer->input[0] = 0x10000;
 	buffer->input[1] = 0x51534554;
 	buffer->input[3] = enable;
-	dell_smbios_send_request(17, 3);
-	ret = buffer->output[0];
-	dell_smbios_release_buffer();
+	ret = dell_smbios_call(buffer);
+	if (ret == 0)
+		ret = buffer->output[0];
+	kfree(buffer);
 
 	return dell_smbios_error(ret);
 }
Signature · 1 line
2.14.1
#11 lore raw

Re: [PATCH v8 09/15] platform/x86: dell-smbios: Introduce dispatcher for SMM calls

reproduce:

Hi Mario,

[auto build test ERROR on platform-drivers-x86/for-next]
[also build test ERROR on v4.14-rc5 next-20171016]
[if your patch is applied to the wrong git tree, please drop us a note to help improve the system]

url:    https://github.com/0day-ci/linux/commits/Mario-Limonciello/Introduce-support-for-Dell-SMBIOS-over-WMI/20171017-103109
base:   git://git.infradead.org/users/dvhart/linux-platform-drivers-x86.git for-next
config: x86_64-randconfig-x001-201742 (attached as .config)
compiler: gcc-6 (Debian 6.2.0-3) 6.2.0 20160901
reproduce:
        # save the attached .config to linux build tree
        make ARCH=x86_64 

All errors (new ones prefixed by >>):

drivers/platform/x86/dell-smbios.c: In function 'location_show':

>> drivers/platform/x86/dell-smbios.c:238:7: error: implicit declaration of function 'capable' [-Werror=implicit-function-declaration]
     if (!capable(CAP_SYS_ADMIN))
          ^~~~~~~
   drivers/platform/x86/dell-smbios.c:238:15: error: 'CAP_SYS_ADMIN' undeclared (first use in this function)
     if (!capable(CAP_SYS_ADMIN))
                  ^~~~~~~~~~~~~
   drivers/platform/x86/dell-smbios.c:238:15: note: each undeclared identifier is reported only once for each function it appears in
   drivers/platform/x86/dell-smbios.c: In function 'value_show':
   drivers/platform/x86/dell-smbios.c:252:15: error: 'CAP_SYS_ADMIN' undeclared (first use in this function)
     if (!capable(CAP_SYS_ADMIN))
                  ^~~~~~~~~~~~~
   cc1: some warnings being treated as errors
--
   drivers/platform/x86/dell-smbios-smm.c: In function 'dell_smbios_smm_call':
>> drivers/platform/x86/dell-smbios-smm.c:93:16: error: implicit declaration of function 'virt_to_phys' [-Werror=implicit-function-declaration]
     command.ebx = virt_to_phys(buffer);
                   ^~~~~~~~~~~~

Cyclomatic Complexity 4 include/linux/string.h:memcpy
Cyclomatic Complexity 1 drivers/platform/x86/dell-smbios-smm.c:dell_smbios_smm_call Cyclomatic Complexity 2 drivers/platform/x86/dell-smbios-smm.c:dell_smbios_smm_exit Cyclomatic Complexity 5 drivers/platform/x86/dell-smbios-smm.c:dell_smbios_smm_init Cyclomatic Complexity 3 drivers/platform/x86/dell-smbios-smm.c:parse_da_table
Cyclomatic Complexity 2 drivers/platform/x86/dell-smbios-smm.c:find_cmd_address Cyclomatic Complexity 1 drivers/platform/x86/dell-smbios-smm.c:_GLOBAL__sub_D_65535_0_dell_smbios_smm_call Cyclomatic Complexity 1 drivers/platform/x86/dell-smbios-smm.c:_GLOBAL__sub_I_65535_1_dell_smbios_smm_call
cc1: some warnings being treated as errors

vim +/capable +238 drivers/platform/x86/dell-smbios.c

0b0f338a Mario Limonciello 2017-10-14  232  
0b0f338a Mario Limonciello 2017-10-14  233  static ssize_t location_show(struct device *dev,
0b0f338a Mario Limonciello 2017-10-14  234  			     struct device_attribute *attr, char *buf)
0b0f338a Mario Limonciello 2017-10-14  235  {
0b0f338a Mario Limonciello 2017-10-14  236  	int i;
0b0f338a Mario Limonciello 2017-10-14  237  
0b0f338a Mario Limonciello 2017-10-14 @238  	if (!capable(CAP_SYS_ADMIN))
0b0f338a Mario Limonciello 2017-10-14  239  		return -EPERM;
0b0f338a Mario Limonciello 2017-10-14  240  
0b0f338a Mario Limonciello 2017-10-14  241  	i = match_attribute(dev, attr);
0b0f338a Mario Limonciello 2017-10-14  242  	if (i > 0)
0b0f338a Mario Limonciello 2017-10-14  243  		return scnprintf(buf, PAGE_SIZE, "%08x", da_tokens[i].location);
0b0f338a Mario Limonciello 2017-10-14  244  	return 0;
0b0f338a Mario Limonciello 2017-10-14  245  }
0b0f338a Mario Limonciello 2017-10-14  246  

:::::: The code at line 238 was first introduced by commit
:::::: 0b0f338a482cc8b1f4807887c866d7095d8d1b16 platform/x86: dell-smbios: Add a sysfs interface for SMBIOS tokens

:::::: TO: Mario Limonciello <[email protected]> :::::: CC: 0day robot <[email protected]>

---
0-DAY kernel test infrastructure Open Source Technology Center
https://lists.01.org/pipermail/kbuild-all Intel Corporation

#12 lore raw

[PATCH] platform/x86: dell-smbios: fix semicolon.cocci warnings

In reply to Mario Limonciello
drivers/platform/x86/dell-smbios.c:108:2-3: Unneeded semicolon drivers/platform/x86/dell-smbios.c:87:2-3: Unneeded semicolon

drivers/platform/x86/dell-smbios.c:108:2-3: Unneeded semicolon drivers/platform/x86/dell-smbios.c:87:2-3: Unneeded semicolon

Remove unneeded semicolon.

Generated by: scripts/coccinelle/misc/semicolon.cocci

Fixes 79480699ede0 ("platform/x86: dell-smbios: Introduce dispatcher for SMM calls")
CC Mario Limonciello <[email protected]>

---

 dell-smbios.c |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/platform/x86/dell-smbios.c +2 -2
@@ -84,7 +84,7 @@ void dell_smbios_unregister_device(struc
 			put_device(d);
 			break;
 		}
-	};
+	}
 	mutex_unlock(&smbios_mutex);
 	dev_dbg(d, "Remove device: %s\n", d->driver->name);
 }
@@ -105,7 +105,7 @@ int dell_smbios_call(struct calling_inte
 			call_fn = priv->call_fn;
 			selected_dev = priv->device;
 		}
-	};
+	}
 
 	if (!selected_dev) {
 		ret = -ENODEV;
#13 lore raw

Re: [PATCH v8 09/15] platform/x86: dell-smbios: Introduce dispatcher for SMM calls

In reply to Mario Limonciello
coccinelle warnings: (new ones prefixed by >>)

Hi Mario,

[auto build test WARNING on platform-drivers-x86/for-next]
[also build test WARNING on v4.14-rc5 next-20171016]
[if your patch is applied to the wrong git tree, please drop us a note to help improve the system]

url:    https://github.com/0day-ci/linux/commits/Mario-Limonciello/Introduce-support-for-Dell-SMBIOS-over-WMI/20171017-103109
base:   git://git.infradead.org/users/dvhart/linux-platform-drivers-x86.git for-next

coccinelle warnings: (new ones prefixed by >>)

>> drivers/platform/x86/dell-smbios.c:108:2-3: Unneeded semicolon

drivers/platform/x86/dell-smbios.c:87:2-3: Unneeded semicolon

Please review and possibly fold the followup patch.

---
0-DAY kernel test infrastructure Open Source Technology Center
https://lists.01.org/pipermail/kbuild-all Intel Corporation

#14 lore raw

Re: [PATCH v8 09/15] platform/x86: dell-smbios: Introduce dispatcher for SMM calls

In reply to Mario Limonciello
reproduce:

Hi Mario,

[auto build test ERROR on platform-drivers-x86/for-next]
[also build test ERROR on v4.14-rc5 next-20171016]
[if your patch is applied to the wrong git tree, please drop us a note to help improve the system]

url:    https://github.com/0day-ci/linux/commits/Mario-Limonciello/Introduce-support-for-Dell-SMBIOS-over-WMI/20171017-103109
base:   git://git.infradead.org/users/dvhart/linux-platform-drivers-x86.git for-next
config: x86_64-randconfig-x013-201742 (attached as .config)
compiler: gcc-6 (Debian 6.2.0-3) 6.2.0 20160901
reproduce:
        # save the attached .config to linux build tree
        make ARCH=x86_64 

Note: the linux-review/Mario-Limonciello/Introduce-support-for-Dell-SMBIOS-over-WMI/20171017-103109 HEAD 73d71487dc3728417e851f3fac100ee4d6cdebd1 builds fine.
It only hurts bisectibility.

All errors (new ones prefixed by >>):

drivers/platform/x86/dell-smbios.c: In function 'location_show':
drivers/platform/x86/dell-smbios.c:238:7: error: implicit declaration of function 'capable' [-Werror=implicit-function-declaration]

     if (!capable(CAP_SYS_ADMIN))
          ^~~~~~~
>> drivers/platform/x86/dell-smbios.c:238:15: error: 'CAP_SYS_ADMIN' undeclared (first use in this function)
     if (!capable(CAP_SYS_ADMIN))
                  ^~~~~~~~~~~~~
   drivers/platform/x86/dell-smbios.c:238:15: note: each undeclared identifier is reported only once for each function it appears in
   drivers/platform/x86/dell-smbios.c: In function 'value_show':
   drivers/platform/x86/dell-smbios.c:252:15: error: 'CAP_SYS_ADMIN' undeclared (first use in this function)
     if (!capable(CAP_SYS_ADMIN))
                  ^~~~~~~~~~~~~

cc1: some warnings being treated as errors

vim +/CAP_SYS_ADMIN +238 drivers/platform/x86/dell-smbios.c

0b0f338a Mario Limonciello 2017-10-14  232  
0b0f338a Mario Limonciello 2017-10-14  233  static ssize_t location_show(struct device *dev,
0b0f338a Mario Limonciello 2017-10-14  234  			     struct device_attribute *attr, char *buf)
0b0f338a Mario Limonciello 2017-10-14  235  {
0b0f338a Mario Limonciello 2017-10-14  236  	int i;
0b0f338a Mario Limonciello 2017-10-14  237  
0b0f338a Mario Limonciello 2017-10-14 @238  	if (!capable(CAP_SYS_ADMIN))
0b0f338a Mario Limonciello 2017-10-14  239  		return -EPERM;
0b0f338a Mario Limonciello 2017-10-14  240  
0b0f338a Mario Limonciello 2017-10-14  241  	i = match_attribute(dev, attr);
0b0f338a Mario Limonciello 2017-10-14  242  	if (i > 0)
0b0f338a Mario Limonciello 2017-10-14  243  		return scnprintf(buf, PAGE_SIZE, "%08x", da_tokens[i].location);
0b0f338a Mario Limonciello 2017-10-14  244  	return 0;
0b0f338a Mario Limonciello 2017-10-14  245  }
0b0f338a Mario Limonciello 2017-10-14  246  

:::::: The code at line 238 was first introduced by commit
:::::: 0b0f338a482cc8b1f4807887c866d7095d8d1b16 platform/x86: dell-smbios: Add a sysfs interface for SMBIOS tokens

:::::: TO: Mario Limonciello <[email protected]> :::::: CC: 0day robot <[email protected]>

---
0-DAY kernel test infrastructure Open Source Technology Center
https://lists.01.org/pipermail/kbuild-all Intel Corporation

#15 lore raw

PATCH v8 10/15 platform/x86: dell-smbios-wmi: Add new WMI dispatcher driver

In reply to Mario Limonciello

The dell-smbios stack only currently uses an SMI interface which grants direct access to physical memory to the firmware SMM methods via a pointer.

This dispatcher driver adds a WMI-ACPI interface that is detected by WMI probe and preferred over the SMI interface in dell-smbios.

Changing this to operate over WMI-ACPI will use an ACPI OperationRegion for a buffer of data storage when SMM calls are performed.

This is a safer approach to use in kernel drivers as the SMM will only have access to that OperationRegion.

---
 MAINTAINERS                            |   6 +
 drivers/platform/x86/Kconfig           |  14 ++
 drivers/platform/x86/Makefile          |   1 +
 drivers/platform/x86/dell-smbios-wmi.c | 233 +++++++++++++++++++++++++++++++++
 4 files changed, 254 insertions(+)
 create mode 100644 drivers/platform/x86/dell-smbios-wmi.c
MAINTAINERS +6 -0
index 9dc1ee9603e7..8fd2f0d2ddf6 100644
@@ -3991,6 +3991,12 @@ L:	[email protected]
 S:	Maintained
 F:	drivers/platform/x86/dell-smbios-smm.c
 
+DELL SMBIOS WMI DRIVER
+M:	Mario Limonciello <[email protected]>
+L:	[email protected]
+S:	Maintained
+F:	drivers/platform/x86/dell-smbios-wmi.c
+
 DELL LAPTOP DRIVER
 M:	Matthew Garrett <[email protected]>
 M:	Pali Rohár <[email protected]>
drivers/platform/x86/Kconfig +14 -0
index 53a2de781de6..83aee9068c64 100644
@@ -94,6 +94,20 @@ config ASUS_LAPTOP
 config DELL_SMBIOS
 	tristate
 
+config DELL_SMBIOS_WMI
+	tristate "Dell SMBIOS calling interface (WMI implementation)"
+	depends on ACPI_WMI
+	select DELL_WMI_DESCRIPTOR
+	default ACPI_WMI
+	select DELL_SMBIOS
+	---help---
+	This provides an implementation for the Dell SMBIOS calling interface
+	communicated over ACPI-WMI.
+
+	If you have a Dell computer from >2007 you should say Y or M here.
+	If you aren't sure and this module doesn't work for your computer
+	it just won't load.
+
 config DELL_SMBIOS_SMM
 	tristate "Dell SMBIOS calling interface (SMM implementation)"
 	depends on DCDBAS
drivers/platform/x86/Makefile +1 -0
index e743615241f8..1c4234861de0 100644
@@ -12,6 +12,7 @@ obj-$(CONFIG_MSI_LAPTOP)	+= msi-laptop.o
 obj-$(CONFIG_ACPI_CMPC)		+= classmate-laptop.o
 obj-$(CONFIG_COMPAL_LAPTOP)	+= compal-laptop.o
 obj-$(CONFIG_DELL_SMBIOS)	+= dell-smbios.o
+obj-$(CONFIG_DELL_SMBIOS_WMI)	+= dell-smbios-wmi.o
 obj-$(CONFIG_DELL_SMBIOS_SMM)	+= dell-smbios-smm.o
 obj-$(CONFIG_DELL_LAPTOP)	+= dell-laptop.o
 obj-$(CONFIG_DELL_WMI)		+= dell-wmi.o
drivers/platform/x86/dell-smbios-wmi.c new file +233 -0

233 lines not on this page · raw message

Signature · 1 line
2.14.1
#16 lore raw

PATCH v8 11/15 platform/x86: dell-smbios-smm: test for WSMT

In reply to Mario Limonciello

WSMT is as an attestation to the OS that the platform won't modify memory outside of pre-defined areas.

If a platform has WSMT enabled in BIOS setup, SMM calls through dcdbas will fail. The only way to access platform data in these instances is through the WMI SMBIOS calling interface.

---
 drivers/platform/x86/dell-smbios-smm.c | 33 +++++++++++++++++++++++++++++++++
 drivers/platform/x86/dell-smbios.h     |  2 ++
 2 files changed, 35 insertions(+)
drivers/platform/x86/dell-smbios-smm.c +33 -0
index bd5a63a4aa15..5a03a3ea51e0 100644
@@ -101,6 +101,31 @@ int dell_smbios_smm_call(struct calling_interface_buffer *input)
 	return 0;
 }
 
+/* When enabled this indicates that SMM won't work */
+static int test_wsmt_enabled(void)
+{
+	struct calling_interface_token *token;
+
+	/* if token doesn't exist, SMM will work */
+	token = dell_smbios_find_token(WSMT_EN_TOKEN);
+	if (!token)
+		return 0;
+
+	/* if token exists, try to access over SMM */
+	buffer->class = CLASS_TOKEN_READ;
+	buffer->select = SELECT_TOKEN_STD;
+	memset(buffer, 0, sizeof(struct calling_interface_buffer));
+	buffer->input[0] = token->location;
+	dell_smbios_smm_call(buffer);
+
+	/* if lookup failed, we know WSMT was enabled */
+	if (buffer->output[0] != 0)
+		return 1;
+
+	/* query token status if it didn't fail */
+	return (buffer->output[1] == token->value);
+}
+
 static int __init dell_smbios_smm_init(void)
 {
 	int ret;
@@ -114,6 +139,13 @@ static int __init dell_smbios_smm_init(void)
 
 	dmi_walk(find_cmd_address, NULL);
 
+	ret = test_wsmt_enabled();
+	pr_debug("WSMT enable test: %d\n", ret);
+	if (ret) {
+		ret = -ENODEV;
+		goto fail_wsmt;
+	}
+
 	platform_device = platform_device_alloc("dell-smbios", 1);
 	if (!platform_device) {
 		ret = -ENOMEM;
@@ -137,6 +169,7 @@ static int __init dell_smbios_smm_init(void)
 fail_platform_device_add:
 	platform_device_put(platform_device);
 
+fail_wsmt:
 fail_platform_device_alloc:
 	free_page((unsigned long)buffer);
 	return ret;
drivers/platform/x86/dell-smbios.h +2 -0
index 8df330abeb5d..db6a16e5f87c 100644
@@ -44,6 +44,8 @@
 #define KBD_LED_AUTO_100_TOKEN	0x02F6
 #define GLOBAL_MIC_MUTE_ENABLE	0x0364
 #define GLOBAL_MIC_MUTE_DISABLE	0x0365
+#define WSMT_EN_TOKEN		0x04EC
+#define WSMT_DIS_TOKEN		0x04ED
 
 struct notifier_block;
 
Signature · 1 line
2.14.1
#17 lore raw

PATCH v8 12/15 platform/x86: dell-smbios: Add filtering support

In reply to Mario Limonciello

When a userspace interface is introduced to dell-smbios filtering support will be used to make sure that userspace doesn't make calls deemed unsafe or that can cause the kernel drivers to get out of sync.

A blacklist is provided for the following:
- Items that are in use by other kernel drivers
- Items that are deemed unsafe (diagnostics, write-once, etc)
- Any items in the blacklist will be rejected.

Following that a whitelist is provided as follows:
- Each item has an associated capability. If a userspace interface accesses this item, that capability will be tested to filter the request.
- If the process provides CAP_SYS_RAWIO the whitelist will be overridden.

When an item is not in the blacklist, or whitelist and the process is run with insufficient capabilities the call will be rejected.

---
 drivers/platform/x86/dell-smbios.c | 190 +++++++++++++++++++++++++++++++++++++
 drivers/platform/x86/dell-smbios.h |  11 +++
 2 files changed, 201 insertions(+)
drivers/platform/x86/dell-smbios.c +190 -0
index b1939abc4216..4aede844de11 100644
@@ -24,6 +24,7 @@
 #include <linux/platform_device.h>
 #include "dell-smbios.h"
 
+static u32 da_supported_commands;
 static int da_num_tokens;
 static struct platform_device *platform_device;
 static struct calling_interface_token *da_tokens;
@@ -38,6 +39,91 @@ struct smbios_device {
 	int (*call_fn)(struct calling_interface_buffer *);
 };
 
+struct smbios_call {
+	u32 need_capability;
+	int class;
+	int select;
+};
+
+/* calls that are whitelisted for given capabilities */
+static struct smbios_call call_whitelist[] = {
+	/* generally tokens are allowed, but may be further filtered or
+	 * restricted by token blacklist or whitelist
+	 */
+	{CAP_SYS_ADMIN,	CLASS_TOKEN_READ,	SELECT_TOKEN_STD},
+	{CAP_SYS_ADMIN,	CLASS_TOKEN_READ,	SELECT_TOKEN_AC},
+	{CAP_SYS_ADMIN,	CLASS_TOKEN_READ,	SELECT_TOKEN_BAT},
+	{CAP_SYS_ADMIN,	CLASS_TOKEN_WRITE,	SELECT_TOKEN_STD},
+	{CAP_SYS_ADMIN,	CLASS_TOKEN_WRITE,	SELECT_TOKEN_AC},
+	{CAP_SYS_ADMIN,	CLASS_TOKEN_WRITE,	SELECT_TOKEN_BAT},
+	/* used by userspace: fwupdate */
+	{CAP_SYS_ADMIN, CLASS_ADMIN_PROP,	SELECT_ADMIN_PROP},
+	/* used by userspace: fwupd */
+	{CAP_SYS_ADMIN,	CLASS_INFO,		SELECT_DOCK},
+	{CAP_SYS_ADMIN,	CLASS_FLASH_INTERFACE,	SELECT_FLASH_INTERFACE},
+};
+
+/* calls that are explicitly blacklisted */
+static struct smbios_call call_blacklist[] = {
+	{0x0000, 01, 07}, /* manufacturing use */
+	{0x0000, 06, 05}, /* manufacturing use */
+	{0x0000, 11, 03}, /* write once */
+	{0x0000, 11, 07}, /* write once */
+	{0x0000, 11, 11}, /* write once */
+	{0x0000, 19, -1}, /* diagnostics */
+	/* handled by kernel: dell-laptop */
+	{0x0000, CLASS_INFO, SELECT_RFKILL},
+	{0x0000, CLASS_KBD_BACKLIGHT, SELECT_KBD_BACKLIGHT},
+};
+
+struct token_range {
+	u32 need_capability;
+	u16 min;
+	u16 max;
+};
+
+/* tokens that are whitelisted for given capabilities */
+static struct token_range token_whitelist[] = {
+	/* used by userspace: fwupdate */
+	{CAP_SYS_ADMIN,	CAPSULE_EN_TOKEN,	CAPSULE_DIS_TOKEN},
+	/* can indicate to userspace that WMI is needed */
+	{0x0000,	WSMT_EN_TOKEN,		WSMT_DIS_TOKEN}
+};
+
+/* tokens that are explicitly blacklisted */
+static struct token_range token_blacklist[] = {
+	{0x0000, 0x0058, 0x0059}, /* ME use */
+	{0x0000, 0x00CD, 0x00D0}, /* raid shadow copy */
+	{0x0000, 0x013A, 0x01FF}, /* sata shadow copy */
+	{0x0000, 0x0175, 0x0176}, /* write once */
+	{0x0000, 0x0195, 0x0197}, /* diagnostics */
+	{0x0000, 0x01DC, 0x01DD}, /* manufacturing use */
+	{0x0000, 0x027D, 0x0284}, /* diagnostics */
+	{0x0000, 0x02E3, 0x02E3}, /* manufacturing use */
+	{0x0000, 0x02FF, 0x02FF}, /* manufacturing use */
+	{0x0000, 0x0300, 0x0302}, /* manufacturing use */
+	{0x0000, 0x0325, 0x0326}, /* manufacturing use */
+	{0x0000, 0x0332, 0x0335}, /* fan control */
+	{0x0000, 0x0350, 0x0350}, /* manufacturing use */
+	{0x0000, 0x0363, 0x0363}, /* manufacturing use */
+	{0x0000, 0x0368, 0x0368}, /* manufacturing use */
+	{0x0000, 0x03F6, 0x03F7}, /* manufacturing use */
+	{0x0000, 0x049E, 0x049F}, /* manufacturing use */
+	{0x0000, 0x04A0, 0x04A3}, /* disagnostics */
+	{0x0000, 0x04E6, 0x04E7}, /* manufacturing use */
+	{0x0000, 0x4000, 0x7FFF}, /* internal BIOS use */
+	{0x0000, 0x9000, 0x9001}, /* internal BIOS use */
+	{0x0000, 0xA000, 0xBFFF}, /* write only */
+	{0x0000, 0xEFF0, 0xEFFF}, /* internal BIOS use */
+	/* handled by kernel: dell-laptop */
+	{0x0000, BRIGHTNESS_TOKEN,	BRIGHTNESS_TOKEN},
+	{0x0000, KBD_LED_OFF_TOKEN,	KBD_LED_AUTO_TOKEN},
+	{0x0000, KBD_LED_AC_TOKEN,	KBD_LED_AC_TOKEN},
+	{0x0000, KBD_LED_AUTO_25_TOKEN,	KBD_LED_AUTO_75_TOKEN},
+	{0x0000, KBD_LED_AUTO_100_TOKEN,	KBD_LED_AUTO_100_TOKEN},
+	{0x0000, GLOBAL_MIC_MUTE_ENABLE,	GLOBAL_MIC_MUTE_DISABLE},
+};
+
 static LIST_HEAD(smbios_device_list);
 
 int dell_smbios_error(int value)
@@ -90,6 +176,108 @@ void dell_smbios_unregister_device(struct device *d)
 }
 EXPORT_SYMBOL_GPL(dell_smbios_unregister_device);
 
+int dell_smbios_call_filter(struct device *d,
+			    struct calling_interface_buffer *buffer)
+{
+	u16 t = 0;
+	int i;
+
+	/* can't make calls over 30 */
+	if (buffer->class > 30) {
+		dev_dbg(d, "class too big: %u\n", buffer->class);
+		return -EINVAL;
+	}
+
+	/* supported calls on the particular system */
+	if (!(da_supported_commands & (1 << buffer->class))) {
+		dev_dbg(d, "invalid command, supported commands: 0x%8x\n",
+			da_supported_commands);
+		return -EINVAL;
+	}
+
+	/* match against call blacklist  */
+	for (i = 0; i < ARRAY_SIZE(call_blacklist); i++) {
+		if (buffer->class != call_blacklist[i].class)
+			continue;
+		if (buffer->select != call_blacklist[i].select &&
+		    call_blacklist[i].select != -1)
+			continue;
+		dev_dbg(d, "blacklisted command: %u/%u\n",
+			buffer->class, buffer->select);
+		return -EINVAL;
+	}
+
+	/* if a token call, find token ID */
+	if ((buffer->class == CLASS_TOKEN_READ && buffer->select < 3) ||
+	    (buffer->class == CLASS_TOKEN_WRITE && buffer->select < 3)) {
+		/* find the matching token ID */
+		for (i = 0; i < da_num_tokens; i++) {
+			if (da_tokens[i].location != buffer->input[0])
+				continue;
+			t = da_tokens[i].tokenID;
+			break;
+		}
+
+		/* token call; but token didn't exist */
+		if (!t) {
+			dev_dbg(d, "token at location %04x doesn't exist\n",
+				buffer->input[0]);
+			return -EINVAL;
+		}
+
+		/* match against token blacklist */
+		for (i = 0; i < ARRAY_SIZE(token_blacklist); i++) {
+			if (!token_blacklist[i].min || !token_blacklist[i].max)
+				continue;
+			if (t >= token_blacklist[i].min &&
+			    t <= token_blacklist[i].max)
+				return -EINVAL;
+		}
+
+		/* match against token whitelist */
+		for (i = 0; i < ARRAY_SIZE(token_whitelist); i++) {
+			if (!token_whitelist[i].min || !token_whitelist[i].max)
+				continue;
+			if (t < token_whitelist[i].min ||
+			    t > token_whitelist[i].max)
+				continue;
+			if (!token_whitelist[i].need_capability ||
+			    capable(token_whitelist[i].need_capability)) {
+				dev_dbg(d, "whitelisted token: %x\n", t);
+				return 0;
+			}
+
+		}
+	}
+	/* match against call whitelist */
+	for (i = 0; i < ARRAY_SIZE(call_whitelist); i++) {
+		if (buffer->class != call_whitelist[i].class)
+			continue;
+		if (buffer->select != call_whitelist[i].select)
+			continue;
+		if (!call_whitelist[i].need_capability ||
+		    capable(call_whitelist[i].need_capability)) {
+			dev_dbg(d, "whitelisted capable command: %u/%u\n",
+			buffer->class, buffer->select);
+			return 0;
+		}
+		dev_dbg(d, "missing capability %d for %u/%u\n",
+			call_whitelist[i].need_capability,
+			buffer->class, buffer->select);
+
+	}
+
+	/* not in a whitelist, only allow processes with capabilities */
+	if (capable(CAP_SYS_RAWIO)) {
+		dev_dbg(d, "Allowing %u/%u due to CAP_SYS_RAWIO\n",
+			buffer->class, buffer->select);
+		return 0;
+	}
+
+	return -EACCES;
+}
+EXPORT_SYMBOL_GPL(dell_smbios_call_filter);
+
 int dell_smbios_call(struct calling_interface_buffer *buffer)
 {
 	int (*call_fn)(struct calling_interface_buffer *) = NULL;
@@ -168,6 +356,8 @@ static void __init parse_da_table(const struct dmi_header *dm)
 	if (dm->length < 17)
 		return;
 
+	da_supported_commands = table->supportedCmds;
+
 	new_da_tokens = krealloc(da_tokens, (da_num_tokens + tokens) *
 				 sizeof(struct calling_interface_token),
 				 GFP_KERNEL);
drivers/platform/x86/dell-smbios.h +11 -0
index db6a16e5f87c..91b9c615452d 100644
@@ -26,9 +26,14 @@
 #define SELECT_TOKEN_AC 2
 #define CLASS_KBD_BACKLIGHT 4
 #define SELECT_KBD_BACKLIGHT 11
+#define CLASS_FLASH_INTERFACE 7
+#define SELECT_FLASH_INTERFACE 3
+#define CLASS_ADMIN_PROP 10
+#define SELECT_ADMIN_PROP 3
 #define CLASS_INFO 17
 #define SELECT_RFKILL 11
 #define SELECT_APP_REGISTRATION	3
+#define SELECT_DOCK 22
 
 /* Tokens used in kernel drivers, any of these
  * should be filtered from userspace access
@@ -44,6 +49,10 @@
 #define KBD_LED_AUTO_100_TOKEN	0x02F6
 #define GLOBAL_MIC_MUTE_ENABLE	0x0364
 #define GLOBAL_MIC_MUTE_DISABLE	0x0365
+
+/* tokens whitelisted to userspace use */
+#define CAPSULE_EN_TOKEN	0x0461
+#define CAPSULE_DIS_TOKEN	0x0462
 #define WSMT_EN_TOKEN		0x04EC
 #define WSMT_DIS_TOKEN		0x04ED
 
@@ -80,6 +89,8 @@ int dell_smbios_register_device(struct device *d, void *call_fn);
 void dell_smbios_unregister_device(struct device *d);
 
 int dell_smbios_error(int value);
+int dell_smbios_call_filter(struct device *d,
+	struct calling_interface_buffer *buffer);
 int dell_smbios_call(struct calling_interface_buffer *buffer);
 
 struct calling_interface_token *dell_smbios_find_token(int tokenid);
Signature · 1 line
2.14.1
#18 lore raw

Re: [PATCH v8 12/15] platform/x86: dell-smbios: Add filtering support

reproduce:

Hi Mario,

[auto build test ERROR on platform-drivers-x86/for-next]
[also build test ERROR on v4.14-rc5 next-20171016]
[if your patch is applied to the wrong git tree, please drop us a note to help improve the system]

url:    https://github.com/0day-ci/linux/commits/Mario-Limonciello/Introduce-support-for-Dell-SMBIOS-over-WMI/20171017-103109
base:   git://git.infradead.org/users/dvhart/linux-platform-drivers-x86.git for-next
config: x86_64-randconfig-x001-201742 (attached as .config)
compiler: gcc-6 (Debian 6.2.0-3) 6.2.0 20160901
reproduce:
        # save the attached .config to linux build tree
        make ARCH=x86_64 

All errors (new ones prefixed by >>):

>> drivers/platform/x86/dell-smbios.c:53:3: error: 'CAP_SYS_ADMIN' undeclared here (not in a function)
     {CAP_SYS_ADMIN, CLASS_TOKEN_READ, SELECT_TOKEN_STD},
      ^~~~~~~~~~~~~
>> drivers/platform/x86/dell-smbios.c:88:3: error: initializer element is not constant
     {CAP_SYS_ADMIN, CAPSULE_EN_TOKEN, CAPSULE_DIS_TOKEN},
      ^~~~~~~~~~~~~
   drivers/platform/x86/dell-smbios.c:88:3: note: (near initialization for 'token_whitelist[0].need_capability')
   drivers/platform/x86/dell-smbios.c: In function 'dell_smbios_call_filter':
   drivers/platform/x86/dell-smbios.c:245:8: error: implicit declaration of function 'capable' [-Werror=implicit-function-declaration]
           capable(token_whitelist[i].need_capability)) {
           ^~~~~~~
>> drivers/platform/x86/dell-smbios.c:271:14: error: 'CAP_SYS_RAWIO' undeclared (first use in this function)
     if (capable(CAP_SYS_RAWIO)) {
                 ^~~~~~~~~~~~~

drivers/platform/x86/dell-smbios.c:271:14: note: each undeclared identifier is reported only once for each function it appears in
cc1: some warnings being treated as errors

vim +/CAP_SYS_ADMIN +53 drivers/platform/x86/dell-smbios.c

47
48 /* calls that are whitelisted for given capabilities */
49 static struct smbios_call call_whitelist[] = {
50 /* generally tokens are allowed, but may be further filtered or
51 * restricted by token blacklist or whitelist
52 */

  > 53		{CAP_SYS_ADMIN,	CLASS_TOKEN_READ,	SELECT_TOKEN_STD},
    54		{CAP_SYS_ADMIN,	CLASS_TOKEN_READ,	SELECT_TOKEN_AC},
    55		{CAP_SYS_ADMIN,	CLASS_TOKEN_READ,	SELECT_TOKEN_BAT},
    56		{CAP_SYS_ADMIN,	CLASS_TOKEN_WRITE,	SELECT_TOKEN_STD},
    57		{CAP_SYS_ADMIN,	CLASS_TOKEN_WRITE,	SELECT_TOKEN_AC},
    58		{CAP_SYS_ADMIN,	CLASS_TOKEN_WRITE,	SELECT_TOKEN_BAT},
    59		/* used by userspace: fwupdate */
    60		{CAP_SYS_ADMIN, CLASS_ADMIN_PROP,	SELECT_ADMIN_PROP},
    61		/* used by userspace: fwupd */
    62		{CAP_SYS_ADMIN,	CLASS_INFO,		SELECT_DOCK},
    63		{CAP_SYS_ADMIN,	CLASS_FLASH_INTERFACE,	SELECT_FLASH_INTERFACE},
    64	};
    65	
    66	/* calls that are explicitly blacklisted */
    67	static struct smbios_call call_blacklist[] = {
    68		{0x0000, 01, 07}, /* manufacturing use */
    69		{0x0000, 06, 05}, /* manufacturing use */
    70		{0x0000, 11, 03}, /* write once */
    71		{0x0000, 11, 07}, /* write once */
    72		{0x0000, 11, 11}, /* write once */
    73		{0x0000, 19, -1}, /* diagnostics */
    74		/* handled by kernel: dell-laptop */
    75		{0x0000, CLASS_INFO, SELECT_RFKILL},
    76		{0x0000, CLASS_KBD_BACKLIGHT, SELECT_KBD_BACKLIGHT},
    77	};
    78	
    79	struct token_range {
    80		u32 need_capability;
    81		u16 min;
    82		u16 max;
    83	};
    84	
    85	/* tokens that are whitelisted for given capabilities */
    86	static struct token_range token_whitelist[] = {
    87		/* used by userspace: fwupdate */
  > 88		{CAP_SYS_ADMIN,	CAPSULE_EN_TOKEN,	CAPSULE_DIS_TOKEN},
    89		/* can indicate to userspace that WMI is needed */
    90		{0x0000,	WSMT_EN_TOKEN,		WSMT_DIS_TOKEN}
    91	};
    92	

---
0-DAY kernel test infrastructure Open Source Technology Center
https://lists.01.org/pipermail/kbuild-all Intel Corporation

#19 lore raw

PATCH v8 13/15 platform/x86: wmi: Add sysfs attribute for required_buffer_size

In reply to Mario Limonciello

Method type WMI objects need to be able to describe the size of the interface that they will expect to use.

Export this information to sysfs and allow vendor drivers to set it.

---
 drivers/platform/x86/wmi.c | 31 +++++++++++++++++++++++++++++++
 include/linux/wmi.h        |  3 +++
 2 files changed, 34 insertions(+)
drivers/platform/x86/wmi.c +31 -0
index bcb41c1c7f52..63d01f98bf4c 100644
@@ -72,6 +72,7 @@ struct wmi_block {
 	struct acpi_device *acpi_device;
 	wmi_notify_handler handler;
 	void *handler_data;
+	u64 req_buf_size;
 
 	bool read_takes_no_args;
 };
@@ -188,6 +189,26 @@ static acpi_status wmi_method_enable(struct wmi_block *wblock, int enable)
 /*
  * Exported WMI functions
  */
+
+/**
+ * set_required_buffer_size - Sets the buffer size needed for performing IOCTL
+ * @wdev: A wmi bus device from a driver
+ * @instance: Instance index
+ *
+ * Allocates memory needed for buffer, stores the buffer size in that memory
+ */
+int set_required_buffer_size(struct wmi_device *wdev, u8 instance, u64 length)
+{
+	struct wmi_block *wblock;
+
+	wblock = container_of(wdev, struct wmi_block, dev);
+	if (!wblock)
+		return -ENODEV;
+	wblock->req_buf_size = length;
+	return 0;
+}
+EXPORT_SYMBOL_GPL(set_required_buffer_size);
+
 /**
  * wmi_evaluate_method - Evaluate a WMI method
  * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
@@ -718,8 +739,18 @@ static struct attribute *wmi_data_attrs[] = {
 };
 ATTRIBUTE_GROUPS(wmi_data);
 
+static ssize_t required_buffer_size_show(struct device *dev,
+				      struct device_attribute *attr, char *buf)
+{
+	struct wmi_block *wblock = dev_to_wblock(dev);
+
+	return sprintf(buf, "%lld\n", wblock->req_buf_size);
+}
+static DEVICE_ATTR_RO(required_buffer_size);
+
 static struct attribute *wmi_method_attrs[] = {
 	&dev_attr_object_id.attr,
+	&dev_attr_required_buffer_size.attr,
 	NULL,
 };
 ATTRIBUTE_GROUPS(wmi_method);
include/linux/wmi.h +3 -0
index ddee427e0721..a9a72a4c5ed8 100644
@@ -36,6 +36,9 @@ extern acpi_status wmidev_evaluate_method(struct wmi_device *wdev,
 extern union acpi_object *wmidev_block_query(struct wmi_device *wdev,
 					     u8 instance);
 
+extern int set_required_buffer_size(struct wmi_device *wdev, u8 instance,
+				    u64 length);
+
 struct wmi_device_id {
 	const char *guid_string;
 };
Signature · 1 line
2.14.1
#20 lore raw

PATCH v8 14/15 platform/x86: wmi: create userspace interface for drivers

In reply to Mario Limonciello

For WMI operations that are only Set or Query read or write sysfs attributes created by WMI vendor drivers make sense.

For other WMI operations that are run on Method, there needs to be a way to guarantee to userspace that the results from the method call belong to the data request to the method call. Sysfs attributes don't work well in this scenario because two userspace processes may be competing at reading/writing an attribute and step on each other's data.

When a WMI vendor driver declares an ioctl callback in the wmi_driver the WMI bus driver will create a character device that maps to that function.

That character device will correspond to this path:
/dev/wmi/$driver

The WMI bus driver will interpret the IOCTL calls, test them for a valid instance and pass them on to the vendor driver to run.

This creates an implicit policy that only driver per character device. If a module matches multiple GUID's, the wmi_devices will need to be all handled by the same wmi_driver if the same character device is used.

The WMI vendor drivers will be responsible for managing access to this character device and proper locking on it.

When a WMI vendor driver is unloaded the WMI bus driver will clean up the character device.

---
 MAINTAINERS                |   1 +
 drivers/platform/x86/wmi.c | 116 +++++++++++++++++++++++++++++++++++++++++++++
 include/linux/wmi.h        |   6 +++
 include/uapi/linux/wmi.h   |  26 ++++++++++
 4 files changed, 149 insertions(+)
 create mode 100644 include/uapi/linux/wmi.h
MAINTAINERS +1 -0
index 8fd2f0d2ddf6..84afbf8ef7d5 100644
@@ -384,6 +384,7 @@ ACPI WMI DRIVER
 L:	[email protected]
 S:	Orphan
 F:	drivers/platform/x86/wmi.c
+F:	include/uapi/linux/wmi.h
 
 AD1889 ALSA SOUND DRIVER
 M:	Thibaut Varene <[email protected]>
drivers/platform/x86/wmi.c +116 -0

152 lines not on this page · raw message

include/linux/wmi.h +6 -0
index a9a72a4c5ed8..1f52dc49a896 100644
@@ -50,6 +50,12 @@ struct wmi_driver {
 	int (*probe)(struct wmi_device *wdev);
 	int (*remove)(struct wmi_device *wdev);
 	void (*notify)(struct wmi_device *device, union acpi_object *data);
+	long (*unlocked_ioctl)(struct wmi_device *wdev, unsigned int cmd,
+				unsigned long arg);
+#ifdef CONFIG_COMPAT
+	long (*compat_ioctl)(struct wmi_device *wdev, unsigned int cmd,
+				unsigned long arg);
+#endif
 };
 
 extern int __must_check __wmi_driver_register(struct wmi_driver *driver,
include/uapi/linux/wmi.h new file +26 -0
new file mode 100644
index 000000000000..7e52350ac9b3
@@ -0,0 +1,26 @@
+/*
+ *  User API methods for ACPI-WMI mapping driver
+ *
+ *  Copyright (C) 2017 Dell, Inc.
+ *
+ *  This program is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License version 2 as
+ *  published by the Free Software Foundation.
+ */
+#ifndef _UAPI_LINUX_WMI_H
+#define _UAPI_LINUX_WMI_H
+
+#include <linux/types.h>
+
+/* WMI bus will filter all WMI vendor driver requests through this IOC */
+#define WMI_IOC 'W'
+
+/* All ioctl requests through WMI should declare their size followed by
+ * relevant data objects
+ */
+struct wmi_ioctl_buffer {
+	__u64	length;
+	__u8	data[];
+};
+
+#endif
Signature · 1 line
2.14.1
#21 lore raw

Re: [PATCH v8 14/15] platform/x86: wmi: create userspace interface for drivers

reproduce:

Hi Mario,

[auto build test WARNING on platform-drivers-x86/for-next]
[also build test WARNING on next-20171016]
[cannot apply to v4.14-rc5]
[if your patch is applied to the wrong git tree, please drop us a note to help improve the system]

url:    https://github.com/0day-ci/linux/commits/Mario-Limonciello/Introduce-support-for-Dell-SMBIOS-over-WMI/20171017-103109
base:   git://git.infradead.org/users/dvhart/linux-platform-drivers-x86.git for-next
config: i386-randconfig-x002-201742 (attached as .config)
compiler: gcc-6 (Debian 6.2.0-3) 6.2.0 20160901
reproduce:
        # save the attached .config to linux build tree
        make ARCH=i386 

All warnings (new ones prefixed by >>):

In file included from include/linux/ioport.h:12:0,

                    from include/linux/acpi.h:25,
                    from drivers/platform/x86/wmi.c:36:
   drivers/platform/x86/wmi.c: In function 'match_ioctl':
   drivers/platform/x86/wmi.c:861:14: error: 'struct wmi_driver' has no member named 'compat_ioctl'; did you mean 'unlocked_ioctl'?
      if (wdriver->compat_ioctl)
                 ^
   include/linux/compiler.h:156:30: note: in definition of macro '__trace_if'
     if (__builtin_constant_p(!!(cond)) ? !!(cond) :   \
                                 ^~~~
>> drivers/platform/x86/wmi.c:861:3: note: in expansion of macro 'if'
      if (wdriver->compat_ioctl)
      ^~
   drivers/platform/x86/wmi.c:861:14: error: 'struct wmi_driver' has no member named 'compat_ioctl'; did you mean 'unlocked_ioctl'?
      if (wdriver->compat_ioctl)
                 ^
   include/linux/compiler.h:156:42: note: in definition of macro '__trace_if'
     if (__builtin_constant_p(!!(cond)) ? !!(cond) :   \
                                             ^~~~
>> drivers/platform/x86/wmi.c:861:3: note: in expansion of macro 'if'
      if (wdriver->compat_ioctl)
      ^~
   drivers/platform/x86/wmi.c:861:14: error: 'struct wmi_driver' has no member named 'compat_ioctl'; did you mean 'unlocked_ioctl'?
      if (wdriver->compat_ioctl)
                 ^
   include/linux/compiler.h:167:16: note: in definition of macro '__trace_if'
      ______r = !!(cond);     \
                   ^~~~
>> drivers/platform/x86/wmi.c:861:3: note: in expansion of macro 'if'
      if (wdriver->compat_ioctl)
      ^~
   drivers/platform/x86/wmi.c:862:17: error: 'struct wmi_driver' has no member named 'compat_ioctl'; did you mean 'unlocked_ioctl'?
       ret = wdriver->compat_ioctl(&wblock->dev, cmd, arg);
                    ^~

At top level:
drivers/platform/x86/wmi.c:877:13: warning: 'wmi_compat_ioctl' defined but not used [-Wunused-function]
static long wmi_compat_ioctl(struct file *filp, unsigned int cmd,
^~~~~~~~~~~~~~~~

vim +/if +861 drivers/platform/x86/wmi.c

802
803 static long match_ioctl(struct file *filp, unsigned int cmd, unsigned long arg,
804 int compat)
805 {
806 struct wmi_ioctl_buffer __user *input =
807 (struct wmi_ioctl_buffer __user *) arg;
808 struct wmi_driver *wdriver = NULL;
809 struct wmi_block *wblock = NULL;
810 struct wmi_block *next = NULL;
811 const char *driver_name;
812 u64 size;
813 int ret;
814
815 if (_IOC_TYPE(cmd) != WMI_IOC)
816 return -ENOTTY;
817
818 driver_name = filp->f_path.dentry->d_iname;
819
820 list_for_each_entry_safe(wblock, next, &wmi_block_list, list) {
821 wdriver = container_of(wblock->dev.dev.driver,
822 struct wmi_driver, driver);
823 if (!wdriver)
824 continue;
825 if (strcmp(driver_name, wdriver->driver.name) == 0)
826 break;
827 }
828
829 if (!wdriver)
830 return -ENODEV;
831
832 /* make sure we're not calling a higher instance than exists*/
833 if (_IOC_NR(cmd) >= wblock->gblock.instance_count)
834 return -EINVAL;
835
836 /* check that required buffer size was declared by driver */
837 if (!wblock->req_buf_size) {
838 dev_err(&wblock->dev.dev, "Required buffer size not set\n");
839 return -EINVAL;
840 }
841 if (get_user(size, &input->length)) {
842 dev_dbg(&wblock->dev.dev, "Read length from user failed\n");
843 return -EFAULT;
844 }
845 /* if it's too small, abort */
846 if (size < wblock->req_buf_size) {
847 dev_err(&wblock->dev.dev,
848 "Buffer %lld too small, need at least %lld\n",
849 size, wblock->req_buf_size);
850 return -EINVAL;
851 }
852 /* if it's too big, warn, driver will only use what is needed */
853 if (size > wblock->req_buf_size)
854 dev_warn(&wblock->dev.dev,
855 "Buffer %lld is bigger than required %lld\n",
856 size, wblock->req_buf_size);
857
858 if (!try_module_get(wdriver->driver.owner))
859 return -EBUSY;
860 if (compat) {

 > 861			if (wdriver->compat_ioctl)

862 ret = wdriver->compat_ioctl(&wblock->dev, cmd, arg);
863 else
864 ret = -ENODEV;
865 } else
866 ret = wdriver->unlocked_ioctl(&wblock->dev, cmd, arg);
867 module_put(wdriver->driver.owner);
868
869 return ret;
870 }
871 static long wmi_unlocked_ioctl(struct file *filp, unsigned int cmd,
872 unsigned long arg)
873 {
874 return match_ioctl(filp, cmd, arg, 0);
875 }
876

---
0-DAY kernel test infrastructure Open Source Technology Center
https://lists.01.org/pipermail/kbuild-all Intel Corporation

#22 lore raw

PATCH v8 15/15 platform/x86: dell-smbios-wmi: introduce userspace interface

In reply to Mario Limonciello

It's important for the driver to provide a R/W ioctl to ensure that two competing userspace processes don't race to provide or read each others data.

This userspace character device will be used to perform SMBIOS calls from any applications.

It provides an ioctl that will allow passing the WMI calling interface buffer between userspace and kernel space.

This character device is intended to deprecate the dcdbas kernel module and the interface that it provides to userspace.

To use the character device the buffer needed for the machine will also be needed. This information is exported to a sysfs attribute by the WMI bus in "required_buffer_size".

The API for interacting with this interface is defined in documentation as well as the WMI uapi header provides the format of the structures.

Not all userspace requests will be accepted. Use the dell-smbios filtering functionality to prevent access to certain tokens and calls.

---
 Documentation/ABI/testing/dell-smbios-wmi | 41 ++++++++++++++++
 drivers/platform/x86/dell-smbios-wmi.c    | 81 ++++++++++++++++++++++++++-----
 drivers/platform/x86/dell-smbios.h        | 11 +----
 include/uapi/linux/wmi.h                  | 26 ++++++++++
 4 files changed, 138 insertions(+), 21 deletions(-)
 create mode 100644 Documentation/ABI/testing/dell-smbios-wmi
Documentation/ABI/testing/dell-smbios-wmi new file +41 -0
new file mode 100644
index 000000000000..572c3eb53c5c
@@ -0,0 +1,41 @@
+What:		/dev/wmi/dell-smbios
+Date:		November 2017
+KernelVersion:	4.15
+Contact:	"Mario Limonciello" <[email protected]>
+Description:
+		Perform SMBIOS calls on supported Dell machines.
+		through the Dell ACPI-WMI interface.
+
+		IOCTL's and buffer formats are defined in:
+		<uapi/linux/wmi.h>
+
+		1) To perform a call from userspace, you'll need to first
+		determine the minimum size of the calling interface buffer
+		for your machine.
+		Platforms that contain larger buffers can return larger
+		objects from the system firmware.
+		Commonly this size is either 4k or 32k.
+
+		To determine the size of the buffer, look in the device's
+		directory in sysfs for a "required_buffer_size" attribute.
+
+		2) After you've determined the minimum size of the calling
+		interface buffer, you can allocate a structure that represents
+		the structure documented above.
+
+		3) In the 'length' object store the size of the buffer you
+		determined above and allocated.
+
+		4) In this buffer object, prepare as necessary for the SMBIOS
+		call you're interested in.  Typically SMBIOS buffers have
+		"class", "select", and "input" defined to values that coincide
+		with the data you are interested in.
+		Documenting class/select/input values is outside of the scope
+		of this documentation. Check with the libsmbios project for
+		further documentation on these values.
+
+		6) Run the call by using ioctl() as described in the header.
+
+		7) The output will be returned in the buffer object.
+
+		8) Be sure to free up your allocated object.
drivers/platform/x86/dell-smbios-wmi.c +70 -11

105 lines not on this page · raw message

drivers/platform/x86/dell-smbios.h +1 -10
index 91b9c615452d..edb9ece06451 100644
@@ -17,6 +17,7 @@
 #define _DELL_SMBIOS_H_
 
 #include <linux/device.h>
+#include <uapi/linux/wmi.h>
 
 /* Common classes and selects*/
 #define CLASS_TOKEN_READ 0
@@ -58,16 +59,6 @@
 
 struct notifier_block;
 
-/* This structure will be modified by the firmware when we enter
- * system management mode, hence the volatiles */
-
-struct calling_interface_buffer {
-	u16 class;
-	u16 select;
-	volatile u32 input[4];
-	volatile u32 output[4];
-} __packed;
-
 struct calling_interface_token {
 	u16 tokenID;
 	u16 location;
include/uapi/linux/wmi.h +26 -0
index 7e52350ac9b3..622e4004bcfc 100644
@@ -10,6 +10,7 @@
 #ifndef _UAPI_LINUX_WMI_H
 #define _UAPI_LINUX_WMI_H
 
+#include <linux/ioctl.h>
 #include <linux/types.h>
 
 /* WMI bus will filter all WMI vendor driver requests through this IOC */
@@ -23,4 +24,29 @@ struct wmi_ioctl_buffer {
 	__u8	data[];
 };
 
+/* This structure may be modified by the firmware when we enter
+ * system management mode through SMM, hence the volatiles
+ */
+struct calling_interface_buffer {
+	__u16 class;
+	__u16 select;
+	volatile __u32 input[4];
+	volatile __u32 output[4];
+} __packed;
+
+struct dell_wmi_extensions {
+	__u32 argattrib;
+	__u32 blength;
+	__u8 data[];
+} __packed;
+
+struct dell_wmi_smbios_buffer {
+	__u64 length;
+	struct calling_interface_buffer std;
+	struct dell_wmi_extensions	ext;
+} __packed;
+
+/* Dell SMBIOS calling IOCTL command used by dell-smbios-wmi */
+#define DELL_WMI_SMBIOS_CMD	_IOWR(WMI_IOC, 0, struct dell_wmi_smbios_buffer)
+
 #endif
Signature · 1 line
2.14.1
Reviewed-by on the v8 series
#23 lore raw
In reply to Mario Limonciello

I like how this series turned out and I think it puts us in a exceedingly better position than the dcdbas path. This series is,

Quoted 272 lines · Mario Limonciello

The existing way that the dell-smbios helper module and associated other drivers (dell-laptop, dell-wmi) communicate with the platform really isn't secure. It requires creating a buffer in physical DMA32 memory space and passing that to the platform via SMM.

Since the platform got a physical memory pointer, you've just got to trust that the platform has only modified (and accessed) memory within that buffer.

Dell Platform designers recognize this security risk and offer a safer way to communicate with the platform over ACPI. This is in turn exposed via a WMI interface to the OS.

When communicating over WMI-ACPI the communication doesn't occur with physical memory pointers. When the ASL is invoked, the fixed length ACPI buffer is copied to a small operating region. The ASL will invoke the SMI, and SMM will only have access to this operating region. When the ASL returns the buffer is copied back for the OS to process.

This method of communication should also deprecate the usage of the dcdbas kernel module and software dependent upon it's interface. Instead offer a character device interface for communicating with this ASL method to allow userspace to use instead.

To faciliate that this patch series introduces a generic way for WMI drivers to be able to create discoverable character devices with a predictable IOCTL interface through the WMI bus when desired. Requiring WMI drivers to explicitly ask for this functionality will act as an effective vendor whitelist to character device creation.

Some of this work is the basis for what will be a proper interpreter of MOF in the kernel and controls for what drivers will be able to do with that MOF.

NOTE: This patch series is intended to go on top of platform-drivers-x86 linux-next.

For convenience the entire series including those is also available here:
https://github.com/superm1/linux/tree/wmi-smbios
changes bweteen v7 and v8:
* fix typo s/desc_buffer/buffer/ in 32k split commit
* Add missing include for <linux/types.h> in uapi
* dell-smbios: initialize correct attribute files
* Output class/select in debug messages in base 10.
* Don't send the u64 length argument to ACPI call length
* Only filter calls that originate from userspace
* Filter kernel calls from userspace
* Add more blacklisting/whitelisting logic per Alan Cox's recommendations
* Adjust tokens attributes to only be accessible to CAP_SYS_ADMIN
* Set default permissions on character device.
* Move token, class, select definitions for items used in drivers to dells-smios.h.
changes between v6 and v7:
* Use deferred probing in any function results needed from dell-wmi-descriptor
* Protect against a list entry disappearing when running an ioctl from WMI bus
* Move ioctl uapi declaration into a common header file for all WMI drivers.
* New patch: create required_buffer_size for method type WMI objects in WMI core rather than vendor driver.
* WSMT patch: Add comment explaining WSMT
* Filtering patch: Add comments explaining what I can about blacklists.
* WMI, dell-smbios-wmi: Add back in compat ioctl, it is needed. My previous test was erroneous in forgetting to copy an updated header into the chroot.
* dell-laptop, dell-wmi: allocate less memory for buffer, page no longer needed
* dell-laptop make the changes (hopefully) more amenable to pali style wise.
* read SMM cmd address in dell-smbios-smm rather than dell-smbios
* shuffle structure definitions for this
changes between v5 and v6:
* Adjust Kconfig for dell-smbios to not depend on anything.
- SMM and WMI drivers will both select dell-smbios
- Technically the module can run on it's own (it's just not useful)
* Add a new tokens sysfs interface
* Rework blacklisting into easily expandable structures
* Lock modules during ioctl call from WMI bus
* drop references to compat ioctl in both WMI and dell-smbios-wmi drivers. (Made sure ioctl worked in both 32 and 64 userspace though)
* dell-smbios-wmi
- s/buffer_size/req_buf_size/ to make it clearer that userspace doesn't get to set this, it's set internally.
- read just buffer length before reading whole structure from userspace
- if buffer length is too big, show a warning
- I tried to rename argument for unlocked_ioctl, but this caused problems in matching initialization lists, so still casting.
- Add comments clarifying everything happening in ioctl
changes between v4 and v5:
* Remove Andy's S suggested by in sysfs tokens patch
* Make some output in dell-wmi-descriptor debug only
* Adjust various Kconfig dependencies as recommended by Darren
* Drop patch to set dell-smbios to default on ACPI_WMI,
it's not needed after the Kconfig dependencies rework
* Move WSMT check patch to after WMI driver is introduced.
* Make common smbios call return value int as there could be errors now with drivers not being loaded.
* Make SMBIOS call methods for all drivers return status
* Reorder patches 2 and 4.
* Don't export symbols for calling functions on dispatchers
* wmi patch:
- use sprintf instead of strcpy
- remove needless bool for tracking found
- adjust logic to look for instance_count - 1, it's zero based not 1 based.
- Pass a callback to unlocked_ioctl instead of full file operations object
- ioctl: Don't fail on no bound WMI driver
- Add missing header for uapi
- Make helper macros include data types
- add compat ioctl
* dell-smbios:
- Add filtering functionality for SMBIOS calling interface
- Use dev_dbg rather than pr_debug where possible
* dell-smbios-wmi:
- test for handle on b1 table
- correct misc flags comment
- drop access checks
- use dev_dbg instead of pr_* calls
- use filtering functionality
- add mutexes around list add/remove
- switch from get_first_device to get_first_priv and inline
- add mutex locking to prevent unloading mid-call.
- update to new ioctl passing
- fix userspace uapi to use __u32 instead of u32
- Don't use a header file for internal only use
- make sure it works with compat ioctl
* dell-laptop: make dell_smbios_send_request local function for boilerplate calls.
* ioctl patch
- Change API to have a simpler structure to pass back and forth
- Rename header file
- Export to sysfs properly
- Add the size of the length variable into the requested buffersize to sysfs, do math in the driver when copying data around.
changes between v3 and v4:
* Make Dell WMI notifications driver fail notifications fail when WMI descriptor driver is unavailable.
* Add a patch to check for Dell OEM string to stop dell-smbios module from being loaded in unsupported systems manually.
* Split Dell WMI descriptor into it's own driver for others to query.
* Test the misc BIOS flags table to decide whether to run in WMI or SMI mode.
* s/dell-wmi-smbios/dell-smbios/ in a few patch titles
* Add missing Suggested-by to a patch from v2 (Sorry Andy S!)
* Adjust cleanup order of wmi character device.
* Fix a remaining reference to /dev/wmi-$driver
* Use get_order to get size for pages
* Split up dell-smbios into 3 drivers:
dell-smbios
-> dell-smbios-smm
-> dell-smbios-wmi
If either of the two dispatcher drivers is unloaded but the other still works, gracefully fall back to that driver
* Remove unneded open and release on file operations in WMI driver
* Switch to misc character device in WMI bus.
* Query the size of the calling interface buffer from WMI descriptor driver.
* Require userspace to use this information to build an appropriately sized buffer.
* Verify the size of buffer passed from userspace matches expectation of buffer processed in kernel.
* Add more documentation about the IOCTL API.
* Add in a recommendation from Andy S about outputing tokens
* Add a patch to test for non-functional SMM due to WSMT
* Define macros for IOCTL's through the WMI bus.
* Pass all IOCTL calls for WMI drivers through WMI bus
WMI bus will guarantee instance count matches and prevent creating too many more IOCTLs.
changes between v2 and v3:
* Drop patches 1-7, they're in Darren's review tree now
* Add missing newline on new Documentation
* Add Reviewed by from Edward O'Callaghan
* Adjust path of character device from /dev/wmi-$driver to /dev/wmi/$driver
* Store wmi_device pointer rather than using a boolean has_wmi to indicate driver is running in WMI mode
* Don't guard free_page from freeing NULL (this is OK)
* New patch: add wmidev_evaluate_method to wmi bus as recommended by Andy L
* Adjust ACPI-WMI interface for this patch change ^
* Add back in sysfs token patch, drop 2nd and 3rd ioctls per discussion on mailing list.
* On sysfs interface: adjust the delimiter to be tabs
* Drop the rename dell-smbios -> dell-wmi-smbios patch
* Remove/move some unnecessary tests for CONFIG_DCDBAS
* Reword s/platform/SMM/ in the WMI-ACPI patch.
* Update Kconfig to recommend using CONFIG_DCDBAS on old machines.
* Allocate buffer to the same pointer regardless of the struct assigned to it. Keep track of the buffer size for cleaning up.
* Explain policy around character device creation in commit message
changes between v1 and v2:
* Introduce another patch to sort the includes in wmi.c
* Introduce another patch to cleanup dell_wmi_check_descriptor_buffer checks.
* Add a commit message to the pr_fmt commit
* Introduce includes to wmi.c in proper location
* Add Reviewed-by to relevant patches from Pali
* Make the WMI introduction patch fallback to legacy SMI
if compiled with CONFIG_DCDBAS
* Separate format of WMI and SMI buffers. WMI buffer supports more arguments and data.
* Adjust the rename patch for changes to fallback
* Drop sysfs token creation patch
* Adjust WMI descriptor check patch for changes to fallback
* introduce another patch to remove needless includes in dell-smbios.c
* Add token ioctl interface to character device.
- Can query number of tokens
- Can query values in all tokens
* Expose format of all buffers and IOCTL commands to uapi header
* Drop the read interface from character device. It doesn't make sense with multiple different ioctl methods.
* Default WMI interface to 32k (This would normally be queried via MOF, but that's not possible yet)
* Create separate buffers for WMI and SMI. If WMI is available, free the SMI buffer.
* Reorder patches so all fixups come first in the series.

Mario Limonciello (15):
platform/x86: wmi: Add new method wmidev_evaluate_method platform/x86: dell-wmi: increase severity of some failures platform/x86: dell-wmi: clean up wmi descriptor check platform/x86: dell-wmi: allow 32k return size in the descriptor platform/x86: dell-wmi-descriptor: split WMI descriptor into it's own
driver
platform/x86: wmi: Don't allow drivers to get each other's GUIDs platform/x86: dell-smbios: only run if proper oem string is detected platform/x86: dell-smbios: Add a sysfs interface for SMBIOS tokens platform/x86: dell-smbios: Introduce dispatcher for SMM calls platform/x86: dell-smbios-wmi: Add new WMI dispatcher driver platform/x86: dell-smbios-smm: test for WSMT
platform/x86: dell-smbios: Add filtering support platform/x86: wmi: Add sysfs attribute for required_buffer_size platform/x86: wmi: create userspace interface for drivers platform/x86: dell-smbios-wmi: introduce userspace interface

 Documentation/ABI/testing/dell-smbios-wmi          |  41 ++
 .../ABI/testing/sysfs-platform-dell-smbios         |  21 +
 MAINTAINERS                                        |  25 +
 drivers/platform/x86/Kconfig                       |  34 +-
 drivers/platform/x86/Makefile                      |   3 +
 drivers/platform/x86/dell-laptop.c                 | 283 +++++-------
 drivers/platform/x86/dell-smbios-smm.c             | 195 ++++++++
 drivers/platform/x86/dell-smbios-wmi.c             | 292 ++++++++++++
 drivers/platform/x86/dell-smbios.c                 | 510 +++++++++++++++++++--
 drivers/platform/x86/dell-smbios.h                 |  68 ++-
 drivers/platform/x86/dell-wmi-descriptor.c         | 162 +++++++
 drivers/platform/x86/dell-wmi-descriptor.h         |  18 +
 drivers/platform/x86/dell-wmi.c                    |  91 +---
 drivers/platform/x86/wmi.c                         | 192 +++++++-
 include/linux/wmi.h                                |  17 +-
 include/uapi/linux/wmi.h                           |  52 +++
 16 files changed, 1655 insertions(+), 349 deletions(-)
 create mode 100644 Documentation/ABI/testing/dell-smbios-wmi
 create mode 100644 Documentation/ABI/testing/sysfs-platform-dell-smbios
 create mode 100644 drivers/platform/x86/dell-smbios-smm.c
 create mode 100644 drivers/platform/x86/dell-smbios-wmi.c
 create mode 100644 drivers/platform/x86/dell-wmi-descriptor.c
 create mode 100644 drivers/platform/x86/dell-wmi-descriptor.h
 create mode 100644 include/uapi/linux/wmi.h

--
2.14.1

#24 lore raw
In reply to Mario Limonciello

Hi! Just a small idea, what about including example userspace application which would use this new API? I think such application can be useful for documentation purpose to see how this new API should be used. And in review process other people can point if there would be some problems with usage.

I do not know if it is requirement or not for introducing new kernel API, but still example code is very useful for developers when they would start to use this new API and correctly.

Signature · 2 lines
Pali Rohár
[email protected]
#25 lore raw
Quoted 17 lines

-----Original Message-----
From: Pali Rohár [mailto:[email protected]]
Sent: Monday, October 16, 2017 2:33 AM
To: Limonciello, Mario <[email protected]>
Cc: [email protected]; Andy Shevchenko <[email protected]>; LKML <[email protected]>; [email protected]; Andy Lutomirski <[email protected]>; [email protected]; [email protected]; [email protected]; [email protected]; Greg KH <[email protected]>; Alan Cox <[email protected]>
Subject: Re: [PATCH v8 00/15] Introduce support for Dell SMBIOS over WMI

Hi! Just a small idea, what about including example userspace application which would use this new API? I think such application can be useful for documentation purpose to see how this new API should be used. And in review process other people can point if there would be some problems with usage.

Quoted 7 lines

I do not know if it is requirement or not for introducing new kernel API, but still example code is very useful for developers when they would start to use this new API and correctly.

--
Pali Rohár
[email protected]

Pali,

I've produced a small sample application available here:
https://github.com/superm1/smbios-wmi-poc

I'm still evaluating whether to update libsmbios to use this API or update individual applications to use it directly. If individual applications will be updated I also have code for fwupd ready:
https://github.com/hughsie/fwupd/pull/277/commits/d01b8ed8e1726dd2ab3d1d9fd46f624ced7a06a2

It won't be merged until:
1) This series is accepted and targeted to -next
2) I decide whether or not to update libsmbios instead

Thanks,

#26 lore raw
Quoted 21 lines · On Monday 16 October 2017 13:23:04 [email protected] wrote:
Quoted 21 lines

-----Original Message-----
From: Pali Rohár [mailto:[email protected]]
Sent: Monday, October 16, 2017 2:33 AM
To: Limonciello, Mario <[email protected]>
Cc: [email protected]; Andy Shevchenko <[email protected]>; LKML <[email protected]>; [email protected]; Andy Lutomirski <[email protected]>; [email protected]; [email protected]; [email protected]; [email protected]; Greg KH <[email protected]>; Alan Cox <[email protected]>
Subject: Re: [PATCH v8 00/15] Introduce support for Dell SMBIOS over WMI

Hi! Just a small idea, what about including example userspace application which would use this new API? I think such application can be useful for documentation purpose to see how this new API should be used. And in review process other people can point if there would be some problems with usage.

I do not know if it is requirement or not for introducing new kernel API, but still example code is very useful for developers when they would start to use this new API and correctly.

Quoted 8 lines
Quoted 3 lines

--
Pali Rohár
[email protected]

Pali,

I've produced a small sample application available here:
https://github.com/superm1/smbios-wmi-poc

Simple one-file example application. Great!

Darren, Greg, Mario, I think it would be better to have this example application in tools/ or in Documentation/... What do you think?

Looking for examples on random github repos is harder and less official as part of linux source tree.

Signature · 2 lines
Pali Rohár
[email protected]
#27 lore raw
Quoted 42 lines

-----Original Message-----
From: Pali Rohár [mailto:[email protected]]
Sent: Monday, October 16, 2017 8:37 AM
To: Limonciello, Mario <[email protected]>
Cc: [email protected]; [email protected]; linux- [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]
Subject: Re: [PATCH v8 00/15] Introduce support for Dell SMBIOS over WMI

Quoted 6 lines · On Monday 16 October 2017 13:23:04 [email protected] wrote:
Quoted 6 lines

-----Original Message-----
From: Pali Rohár [mailto:[email protected]]
Sent: Monday, October 16, 2017 2:33 AM
To: Limonciello, Mario <[email protected]>
Cc: [email protected]; Andy Shevchenko <[email protected]>; LKML <[email protected]>; [email protected];

Andy

Quoted 15 lines
Quoted 15 lines

Lutomirski <[email protected]>; [email protected]; [email protected]; [email protected]; [email protected]; Greg KH <[email protected]>; Alan Cox <[email protected]>
Subject: Re: [PATCH v8 00/15] Introduce support for Dell SMBIOS over WMI

Hi! Just a small idea, what about including example userspace application which would use this new API? I think such application can be useful for documentation purpose to see how this new API should be used. And in review process other people can point if there would be some problems with usage.

I do not know if it is requirement or not for introducing new kernel API, but still example code is very useful for developers when they would start to use this new API and correctly.

Quoted 8 lines
Quoted 3 lines

--
Pali Rohár
[email protected]

Pali,

I've produced a small sample application available here:
https://github.com/superm1/smbios-wmi-poc

Quoted 8 lines

Simple one-file example application. Great!

Darren, Greg, Mario, I think it would be better to have this example application in tools/ or in Documentation/... What do you think?

Looking for examples on random github repos is harder and less official as part of linux source tree.

If others also agree, I'm fine with including it with the kernel. Please advise where it should be located.

It was originally a POC made just for my own testing of this API. I will probably need to clean it up a little though for wider distribution to the kernel so I would prefer to send it in a follow up patch if no other feedback requiring changes to this series as is.

One possible issue is that it currently uses glib. Is that OK?

#28 lore raw
Quoted 54 lines · On Mon, Oct 16, 2017 at 01:48:05PM +0000, [email protected] wrote:
Quoted 42 lines

-----Original Message-----
From: Pali Rohár [mailto:[email protected]]
Sent: Monday, October 16, 2017 8:37 AM
To: Limonciello, Mario <[email protected]>
Cc: [email protected]; [email protected]; linux- [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]
Subject: Re: [PATCH v8 00/15] Introduce support for Dell SMBIOS over WMI

Quoted 6 lines · On Monday 16 October 2017 13:23:04 [email protected] wrote:
Quoted 6 lines

-----Original Message-----
From: Pali Rohár [mailto:[email protected]]
Sent: Monday, October 16, 2017 2:33 AM
To: Limonciello, Mario <[email protected]>
Cc: [email protected]; Andy Shevchenko <[email protected]>; LKML <[email protected]>; [email protected];

Andy

Quoted 15 lines
Quoted 15 lines

Lutomirski <[email protected]>; [email protected]; [email protected]; [email protected]; [email protected]; Greg KH <[email protected]>; Alan Cox <[email protected]>
Subject: Re: [PATCH v8 00/15] Introduce support for Dell SMBIOS over WMI

Hi! Just a small idea, what about including example userspace application which would use this new API? I think such application can be useful for documentation purpose to see how this new API should be used. And in review process other people can point if there would be some problems with usage.

I do not know if it is requirement or not for introducing new kernel API, but still example code is very useful for developers when they would start to use this new API and correctly.

Quoted 8 lines
Quoted 3 lines

--
Pali Rohár
[email protected]

Pali,

I've produced a small sample application available here:
https://github.com/superm1/smbios-wmi-poc

Quoted 8 lines

Simple one-file example application. Great!

Darren, Greg, Mario, I think it would be better to have this example application in tools/ or in Documentation/... What do you think?

Looking for examples on random github repos is harder and less official as part of linux source tree.

If others also agree, I'm fine with including it with the kernel. Please advise where it should be located.

Quoted 6 lines

It was originally a POC made just for my own testing of this API. I will probably need to clean it up a little though for wider distribution to the kernel so I would prefer to send it in a follow up patch if no other feedback requiring changes to this series as is.

One possible issue is that it currently uses glib. Is that OK?

In my opinion, what is important is that there is an open-source userspace consumer of the interface. I don't think it needs to be in the kernel. If this was a more generic interface which could be tested on any hardware, then I think a selftests target would be sensible. As it is, this is a very specific use case, and a simple reference to the smbios-wmi-poc project URL in documentation someplace (or even in the dell-smbios driver comments) seems more than adequate to me.

Signature · 2 lines
Darren Hart
VMware Open Source Technology Center
#29 lore raw
Quoted 75 lines

-----Original Message-----
From: Darren Hart [mailto:[email protected]]
Sent: Monday, October 16, 2017 4:57 PM
To: Limonciello, Mario <[email protected]>
Cc: [email protected]; [email protected]; linux- [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]
Subject: Re: [PATCH v8 00/15] Introduce support for Dell SMBIOS over WMI

Quoted 6 lines · On Mon, Oct 16, 2017 at 01:48:05PM +0000, [email protected] wrote:
Quoted 6 lines

-----Original Message-----
From: Pali Rohár [mailto:[email protected]]
Sent: Monday, October 16, 2017 8:37 AM
To: Limonciello, Mario <[email protected]>
Cc: [email protected]; [email protected]; linux- [email protected]; [email protected];

[email protected];

Quoted 10 lines
Quoted 10 lines

[email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]
Subject: Re: [PATCH v8 00/15] Introduce support for Dell SMBIOS over WMI

Quoted 5 lines · On Monday 16 October 2017 13:23:04 [email protected] wrote:
Quoted 5 lines

-----Original Message-----
From: Pali Rohár [mailto:[email protected]]
Sent: Monday, October 16, 2017 2:33 AM
To: Limonciello, Mario <[email protected]>
Cc: [email protected]; Andy Shevchenko

<[email protected]>;

Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line

LKML <[email protected]>; platform-driver-

[email protected];

Quoted 37 lines
Quoted 25 lines

Andy

Quoted 15 lines
Quoted 15 lines

Lutomirski <[email protected]>; [email protected]; [email protected]; [email protected]; [email protected]; Greg KH <[email protected]>; Alan Cox <[email protected]>
Subject: Re: [PATCH v8 00/15] Introduce support for Dell SMBIOS over WMI

Hi! Just a small idea, what about including example userspace application which would use this new API? I think such application can be useful for documentation purpose to see how this new API should be used. And in review process other people can point if there would be some problems with usage.

I do not know if it is requirement or not for introducing new kernel API, but still example code is very useful for developers when they would start to use this new API and correctly.

Quoted 8 lines
Quoted 3 lines

--
Pali Rohár
[email protected]

Pali,

I've produced a small sample application available here:
https://github.com/superm1/smbios-wmi-poc

Quoted 8 lines

Simple one-file example application. Great!

Darren, Greg, Mario, I think it would be better to have this example application in tools/ or in Documentation/... What do you think?

Looking for examples on random github repos is harder and less official as part of linux source tree.

If others also agree, I'm fine with including it with the kernel. Please advise where it should be located.

Quoted 6 lines

It was originally a POC made just for my own testing of this API. I will probably need to clean it up a little though for wider distribution to the kernel so I would prefer to send it in a follow up patch if no other feedback requiring changes to this series as is.

One possible issue is that it currently uses glib. Is that OK?

Quoted 8 lines

In my opinion, what is important is that there is an open-source userspace consumer of the interface. I don't think it needs to be in the kernel. If this was a more generic interface which could be tested on any hardware, then I think a selftests target would be sensible. As it is, this is a very specific use case, and a simple reference to the smbios-wmi-poc project URL in documentation someplace (or even in the dell-smbios driver comments) seems more than adequate to me.

To Pali's point I noticed stuff like this: https://github.com/torvalds/linux/blob/master/tools/laptop/freefall/freefall.c
which shows how to use /dev/freefall.

I don't mind to switch my tool to drop glib and bring in kernel. I'll plan to bring it in here in a separate patch:
tools/wmi/dell-smbios-example.c

kbuild test robot caught a few other missing includes for certain situations, so I'll be making another change set for that anyway.

Thanks,