Introduce support for Dell SMBIOS over WMI
Subsystems (2)
v5 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 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 (14):
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: add filtering capability for requests platform/x86: dell-smbios-wmi: Add new WMI dispatcher driver platform/x86: dell-smbios-smm: test for WSMT
platform/x86: wmi: create character devices when requested by drivers platform/x86: dell-smbios-wmi: introduce userspace interface
Documentation/ABI/testing/dell-smbios-wmi | 41 +++ .../ABI/testing/sysfs-platform-dell-smbios | 16 ++ .../ABI/testing/sysfs-platform-dell-smbios-wmi | 10 + MAINTAINERS | 26 ++ drivers/platform/x86/Kconfig | 35 ++- drivers/platform/x86/Makefile | 3 + drivers/platform/x86/dell-laptop.c | 255 ++++++----------- drivers/platform/x86/dell-smbios-smm.c | 170 +++++++++++ drivers/platform/x86/dell-smbios-wmi.c | 311 +++++++++++++++++++++ drivers/platform/x86/dell-smbios.c | 256 ++++++++++++++--- drivers/platform/x86/dell-smbios.h | 26 +- drivers/platform/x86/dell-wmi-descriptor.c | 162 +++++++++++ drivers/platform/x86/dell-wmi-descriptor.h | 18 ++ drivers/platform/x86/dell-wmi.c | 99 +------ drivers/platform/x86/wmi.c | 130 +++++++-- include/linux/wmi.h | 15 +- include/uapi/linux/dell-smbios.h | 42 +++ include/uapi/linux/wmi.h | 19 ++ 18 files changed, 1302 insertions(+), 332 deletions(-) create mode 100644 Documentation/ABI/testing/dell-smbios-wmi create mode 100644 Documentation/ABI/testing/sysfs-platform-dell-smbios create mode 100644 Documentation/ABI/testing/sysfs-platform-dell-smbios-wmi 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/dell-smbios.h create mode 100644 include/uapi/linux/wmi.h
Signature · 1 line
2.14.1
PATCH v5 1/14 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
@@ -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
@@ -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
PATCH v5 2/14 platform/x86: dell-wmi: increase severity of some failures
In reply to Mario LimoncielloThere 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
@@ -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
PATCH v5 3/14 platform/x86: dell-wmi: clean up wmi descriptor check
In reply to Mario LimoncielloSome 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
@@ -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
PATCH v5 4/14 platform/x86: dell-wmi: allow 32k return size in the descriptor
In reply to Mario LimoncielloSome 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
@@ -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 (desc_buffer[3 ] !=4096 && desc_buffer[3 ] !=32768 )dev_warn (&wdev->dev,"Dell descriptor buffer has invalid buffer length (%u)\n" , buffer[3 ]);
Signature · 1 line
2.14.1
PATCH v5 5/14 platform/x86: dell-wmi-descriptor: split WMI descriptor into it's own driver
In reply to Mario LimoncielloAll 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 | 89 ++-------------- 6 files changed, 198 insertions(+), 82 deletions(-) create mode 100644 drivers/platform/x86/dell-wmi-descriptor.c create mode 100644 drivers/platform/x86/dell-wmi-descriptor.h
MAINTAINERS +5 -0
@@ -4002,6 +4002,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
@@ -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
@@ -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
@@ -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 +7 -82
139 lines not on this page · raw message
Signature · 1 line
2.14.1
PATCH v5 6/14 platform/x86: wmi: Don't allow drivers to get each other's GUIDs
In reply to Mario LimoncielloThe 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
@@ -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
@@ -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
PATCH v5 7/14 platform/x86: dell-smbios: only run if proper oem string is detected
In reply to Mario LimoncielloThe 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
@@ -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_info ("Unable to run on non-Dell system\n" ); +return -ENODEV ; + } +dmi_walk (find_tokens,NULL );if (!da_tokens) {
Signature · 1 line
2.14.1
PATCH v5 8/14 platform/x86: dell-smbios: Add a sysfs interface for SMBIOS tokens
In reply to Mario LimoncielloCurrently 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 root as it can contain sensitive information about the platform's configuration.
MAINTAINERS was missing for this driver. Add myself and Pali to maintainers list for it.
--- .../ABI/testing/sysfs-platform-dell-smbios | 16 ++++++ MAINTAINERS | 7 +++ drivers/platform/x86/dell-smbios.c | 64 ++++++++++++++++++++++ 3 files changed, 87 insertions(+) create mode 100644 Documentation/ABI/testing/sysfs-platform-dell-smbios
Documentation/ABI/testing/sysfs-platform-dell-smbios new file +16 -0
@@ -0,0 +1,16 @@ +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. + + The tokens will be displayed in the following + machine readable format with each token on a + new line: + + ID Location value + + For example token: + 5 5 3
MAINTAINERS +7 -0
@@ -3967,6 +3967,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 +64 -0
91 lines not on this page · raw message
Signature · 1 line
2.14.1
Re: [PATCH v5 08/14] platform/x86: dell-smbios: Add a sysfs interface for SMBIOS tokens
Quoted 33 lines · 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 root as it can contain sensitive information about the platform's configuration.
MAINTAINERSwas missing for this driver. Add myself and Pali to maintainers list for it.Signed-off-by Mario Limonciello <[email protected]>--- .../ABI/testing/sysfs-platform-dell-smbios | 16 ++++++ MAINTAINERS | 7 +++ drivers/platform/x86/dell-smbios.c | 64 ++++++++++++++++++++++ 3 files changed, 87 insertions(+) create mode 100644 Documentation/ABI/testing/sysfs-platform-dell-smbiosDocumentation/ABI/testing/sysfs-platform-dell-smbios new file +6
-0@@ -0,0 +1,16 @@ +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
Documentation/ABI/testing/sysfs-platform-dell-smbios line 16
Quoted 10 lines
Documentation/ABI/testing/sysfs-platform-dell-smbios new file +10
-0+ available on the machine. + + The tokens will be displayed in the following + machine readable format with each token on a + new line: + + ID Location value + + For example token: + 5 5 3
That's more than "one value per file" which is what sysfs requires, so this isn't acceptable, sorry.
Documentation/ABI/testing/sysfs-platform-dell-smbios
Quoted 12 lines
Documentation/ABI/testing/sysfs-platform-dell-smbios new file +12
-0+static ssize_t tokens_show(struct device *dev, + struct device_attribute *attr, char *buf) +{ + size_t off = 0; + int to_print; + int i; + + to_print = min(da_num_tokens, (int)(PAGE_SIZE - 1) / 15); + for (i = 0; i < to_print; i++) { + off += scnprintf(buf+off, PAGE_SIZE-off, "%04x\t%04x\t%04x\n", + da_tokens[i].tokenID, da_tokens[i].location, + da_tokens[i].value);
Huge hint, if you are checking for the max size of the buffer for sysfs, something is really wrong, and you need to redo your design.
thanks,
greg k-h
RE: [PATCH v5 08/14] platform/x86: dell-smbios: Add a sysfs interface for SMBIOS tokens
Quoted 51 lines
-----Original Message-----
From: Greg KH [mailto:[email protected]]
Sent: Saturday, October 7, 2017 1:54 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]; [email protected]
Subject: Re: [PATCH v5 08/14] platform/x86: dell-smbios: Add a sysfs interface for SMBIOS tokensQuoted 14 lines · 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 root as it can contain sensitive information about the platform's configuration.
MAINTAINERSwas missing for this driver. Add myself and Pali to maintainers list for it.Signed-off-by Mario Limonciello <[email protected]>Review
Quoted 8 lines
--- .../ABI/testing/sysfs-platform-dell-smbios | 16 ++++++ MAINTAINERS | 7 +++ drivers/platform/x86/dell-smbios.c | 64 ++++++++++++++++++++++ 3 files changed, 87 insertions(+) create mode 100644 Documentation/ABI/testing/sysfs-platform-dell-smbios(quoted diff) +0
-0b/Documentation/ABI/testing/sysfs-platform-dell-smbios
Quoted 16 lines
new file mode 100644
index 000000000000..d97f4bd5bd91Documentation/ABI/testing/sysfs-platform-dell-smbios new file +11
-0@@ -0,0 +1,16 @@ +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. + + The tokens will be displayed in the following + machine readable format with each token on a + new line:
Quoted 8 lines
Documentation/ABI/testing/sysfs-platform-dell-smbios line 16
Quoted 5 lines
Documentation/ABI/testing/sysfs-platform-dell-smbios new file +5
-0+ + ID Location value + + For example token: + 5 5 3That's more than "one value per file" which is what sysfs requires, so this isn't acceptable, sorry.
What's more acceptable to you to relay this information? Binary sysfs attribute and export the structure format in a uapi?
or a collection of sysfs files?
Eg:
tokens/$x/id
tokens/$x/location
tokens/$s/value
I'm guessing the latter is the better way to go.
Quoted 20 lines
Documentation/ABI/testing/sysfs-platform-dell-smbios
Quoted 13 lines
Documentation/ABI/testing/sysfs-platform-dell-smbios new file +12
-0+static ssize_t tokens_show(struct device *dev, + struct device_attribute *attr, char *buf) +{ + size_t off = 0; + int to_print; + int i; + + to_print = min(da_num_tokens, (int)(PAGE_SIZE - 1) / 15); + for (i = 0; i < to_print; i++) { + off += scnprintf(buf+off, PAGE_SIZE-off, "%04x\t%04x\t%04x\n", + da_tokens[i].tokenID, da_tokens[i].location, + da_tokens[i].value);Huge hint, if you are checking for the max size of the buffer for sysfs, something is really wrong, and you need to redo your design.
thanks,
greg k-h
Re: [PATCH v5 08/14] platform/x86: dell-smbios: Add a sysfs interface for SMBIOS tokens
Quoted 60 lines · On Sat, Oct 07, 2017 at 11:56:04AM +0000, [email protected] wrote:
Quoted 51 lines
-----Original Message-----
From: Greg KH [mailto:[email protected]]
Sent: Saturday, October 7, 2017 1:54 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]; [email protected]
Subject: Re: [PATCH v5 08/14] platform/x86: dell-smbios: Add a sysfs interface for SMBIOS tokensQuoted 14 lines · 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 root as it can contain sensitive information about the platform's configuration.
MAINTAINERSwas missing for this driver. Add myself and Pali to maintainers list for it.Signed-off-by Mario Limonciello <[email protected]>Review
Quoted 8 lines
--- .../ABI/testing/sysfs-platform-dell-smbios | 16 ++++++ MAINTAINERS | 7 +++ drivers/platform/x86/dell-smbios.c | 64 ++++++++++++++++++++++ 3 files changed, 87 insertions(+) create mode 100644 Documentation/ABI/testing/sysfs-platform-dell-smbios(quoted diff) +0
-0b/Documentation/ABI/testing/sysfs-platform-dell-smbios
Quoted 16 lines
new file mode 100644
index 000000000000..d97f4bd5bd91Documentation/ABI/testing/sysfs-platform-dell-smbios new file +11
-0@@ -0,0 +1,16 @@ +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. + + The tokens will be displayed in the following + machine readable format with each token on a + new line:Quoted 8 lines
Documentation/ABI/testing/sysfs-platform-dell-smbios line 16
Quoted 5 lines
Documentation/ABI/testing/sysfs-platform-dell-smbios new file +5
-0+ + ID Location value + + For example token: + 5 5 3That's more than "one value per file" which is what sysfs requires, so this isn't acceptable, sorry.
Quoted 2 lines
What's more acceptable to you to relay this information? Binary sysfs attribute and export the structure format in a uapi?
binary sysfs apis are for passing "raw" data to/from firmware/hardware to userspace, without the kernel knowing anything about the structure or format of the data. Putting the format in a structure in a uapi header kind of defeats that purpose :)
Quoted 7 lines
or a collection of sysfs files?
Eg:
tokens/$x/id
tokens/$x/location
tokens/$s/valueI'm guessing the latter is the better way to go.
Good guess :)
thanks,
greg k-h
PATCH v5 9/14 platform/x86: dell-smbios: Introduce dispatcher for SMM calls
In reply to Mario LimoncielloThis 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.
--- MAINTAINERS | 6 + drivers/platform/x86/Kconfig | 16 ++- drivers/platform/x86/Makefile | 1 + drivers/platform/x86/dell-laptop.c | 255 ++++++++++++--------------------- drivers/platform/x86/dell-smbios-smm.c | 136 ++++++++++++++++++ drivers/platform/x86/dell-smbios.c | 123 ++++++++++------ drivers/platform/x86/dell-smbios.h | 13 +- drivers/platform/x86/dell-wmi.c | 11 +- 8 files changed, 338 insertions(+), 223 deletions(-) create mode 100644 drivers/platform/x86/dell-smbios-smm.c
MAINTAINERS +6 -0
@@ -3974,6 +3974,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 +12 -4
@@ -93,12 +93,20 @@ config ASUS_LAPTOP config DELL_SMBIOS tristate - select DCDBAS + depends on DELL_SMBIOS_SMM + +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
@@ -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 +89 -166
506 lines not on this page · raw message
drivers/platform/x86/dell-smbios-smm.c new file +136 -0
136 lines not on this page · raw message
drivers/platform/x86/dell-smbios.c +79 -44
178 lines not on this page · raw message
drivers/platform/x86/dell-smbios.h +8 -5
@@ -16,6 +16,8 @@#ifndef _DELL_SMBIOS_H_#define _DELL_SMBIOS_H_ +#include <linux/device.h> +struct notifier_block ;/* This structure will be modified by the firmware when we enter
@@ -37,12 +39,13 @@ struct calling_interface_token { }; }; -int dell_smbios_error (int value); -struct calling_interface_buffer *dell_smbios_get_buffer (void ); -void dell_smbios_clear_buffer (void ); -void dell_smbios_release_buffer (void ); -void dell_smbios_send_request (int class,int select); +int dell_smbios_register_device (struct device *d,void *call_fn); +void dell_smbios_unregister_device (struct device *d); + +void dell_smbios_get_smm_address (int *address,int *command); +int dell_smbios_error (int value); +int dell_smbios_call (struct calling_interface_buffer *buffer);struct calling_interface_token *dell_smbios_find_token (int tokenid);
drivers/platform/x86/dell-wmi.c +7 -4
@@ -641,13 +641,16 @@ static int dell_wmi_events_set_enabled(bool enable)struct calling_interface_buffer *buffer;int ret; - buffer =dell_smbios_get_buffer (); + buffer = (void *)get_zeroed_page (GFP_KERNEL ); + buffer->class =17 ; + buffer->select =3 ; 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 ]; +free_page ((unsigned long )buffer);return dell_smbios_error (ret); }
Signature · 1 line
2.14.1
Re: [PATCH v5 09/14] platform/x86: dell-smbios: Introduce dispatcher for SMM calls
Quoted 17 lines · Mario Limonciello
This splits up the dell-smbios driver into two drivers:
* dell-smbios
* dell-smbios-smmdell-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.
config
DELL_SMBIOS
tristate
drivers/platform/x86/Kconfig config ASUS_LAPTOP · line 97
Quoted 2 lines
drivers/platform/x86/Kconfig +2
-0+ depends on DELL_SMBIOS_SMM +
If the above dependency is true (which I'm quite sure not) this split should never happen.
Quoted 12 lines
drivers/platform/x86/Kconfig +10
-0+config DELL_SMBIOS_SMM + tristate "Dell SMBIOS calling interface (SMM implementation)" + depends on DCDBAS + default DCDBAS + select DELL_SMBIOS ---help--- + This provides an implementation for the Dell SMBIOS calling interface + communicated over SMI/SMM. + 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.
Signature · 2 lines
With Best Regards, Andy Shevchenko
Re: [PATCH v5 09/14] platform/x86: dell-smbios: Introduce dispatcher for SMM calls
Quoted 16 lines · Andy Shevchenko
Quoted 13 lines · Mario Limonciello
This splits up the dell-smbios driver into two drivers:
* dell-smbios
* dell-smbios-smmdell-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.
Quoted 8 lines
drivers/platform/x86/Kconfig config ASUS_LAPTOP · line 97
Quoted 5 lines
config
DELL_SMBIOS
tristatedrivers/platform/x86/Kconfig +2
-0+ depends on DELL_SMBIOS_SMM +If the above dependency is true (which I'm quite sure not) this split should never happen.
Hmm... One more thought here.
Which is library and which is not? IOW the question is "can DELL_SMBIOS be a standalone working module"?
Quoted 13 lines
Quoted 13 lines
drivers/platform/x86/Kconfig +10
-0+config DELL_SMBIOS_SMM + tristate "Dell SMBIOS calling interface (SMM implementation)" + depends on DCDBAS + default DCDBAS + select DELL_SMBIOS ---help--- + This provides an implementation for the Dell SMBIOS calling interface + communicated over SMI/SMM. + 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.
Signature · 2 lines
With Best Regards, Andy Shevchenko
RE: [PATCH v5 09/14] platform/x86: dell-smbios: Introduce dispatcher for SMM calls
Quoted 36 lines
-----Original Message-----
From: Andy Shevchenko [mailto:[email protected]]
Sent: Sunday, October 8, 2017 1:13 PM
To: Limonciello, Mario <[email protected]>
Cc: [email protected]; LKML <[email protected]>; Platform Driver <[email protected]>; Andy Lutomirski <[email protected]>; [email protected]; Pali Rohár <[email protected]>; Rafael J. Wysocki <[email protected]>; [email protected]; Christoph Hellwig <[email protected]>; Greg KH <[email protected]>
Subject: Re: [PATCH v5 09/14] platform/x86: dell-smbios: Introduce dispatcher for SMM callsQuoted 22 lines · Andy Shevchenko
Quoted 19 lines · Mario Limonciello
This splits up the dell-smbios driver into two drivers:
* dell-smbios
* dell-smbios-smmdell-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.
config
DELL_SMBIOS
tristatedrivers/platform/x86/Kconfig +2
-0+ depends on DELL_SMBIOS_SMM +
Quoted 8 lines
Quoted 2 lines
If the above dependency is true (which I'm quite sure not) this split should never happen.
Hmm... One more thought here.
Which is library and which is not? IOW the question is "can
DELL_SMBIOSbe a standalone working module"?
It can technically be compiled as a standalone module, but it won't do anything as a standalone module as of this patch.
After the sysfs tokens patch it could be used to provide token information without the SMM or WMI drivers.
(although this interface will have to change based upon Greg's most recent feedback).
In terms of transitioning people moving from older kernels to new, it makes most sense to me that it's automatically selecting DELL_SMBIOS_SMM if you had it selected previously, but I'll defer to you judgement if the dependency should be dropped since it can be a standalone module that just doesn't do anything.
Quoted 18 lines
Quoted 10 lines
Quoted 10 lines
drivers/platform/x86/Kconfig +7
-0+config DELL_SMBIOS_SMM + tristate "Dell SMBIOS calling interface (SMM implementation)" + depends on DCDBAS + default DCDBAS + select DELL_SMBIOS ---help--- + This provides an implementation for the Dell SMBIOS calling interface + communicated over SMI/SMM.Quoted 3 lines
drivers/platform/x86/Kconfig config ASUS_LAPTOP · line 109
Quoted 3 lines
drivers/platform/x86/Kconfig +3
-0+ 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.--
With Best Regards,
Andy Shevchenko
Re: [PATCH v5 09/14] platform/x86: dell-smbios: Introduce dispatcher for SMM calls
Quoted 23 lines · On Mon, Oct 9, 2017 at 12:45 AM, <[email protected]> wrote:
Quoted 6 lines
Quoted 6 lines
Quoted 5 lines
config
DELL_SMBIOS
tristatedrivers/platform/x86/Kconfig +2
-0+ depends on DELL_SMBIOS_SMM +Quoted 8 lines
Quoted 2 lines
If the above dependency is true (which I'm quite sure not) this split should never happen.
Hmm... One more thought here.
Which is library and which is not? IOW the question is "can
DELL_SMBIOSbe a standalone working module"?It can technically be compiled as a standalone module, but it won't do anything as a standalone module as of this patch.
After the sysfs tokens patch it could be used to provide token information without the SMM or WMI drivers.
(although this interface will have to change based upon Greg's most recent feedback).
Quoted 5 lines
In terms of transitioning people moving from older kernels to new, it makes most sense to me that it's automatically selecting
DELL_SMBIOS_SMMif you had it selected previously, but I'll defer to you judgement if the dependency should be dropped since it can be a standalone module that just doesn't do anything.
Okay, if we can call it "a library" then remove the reverse dependency as I mentioned in first comment.
Signature · 2 lines
With Best Regards, Andy Shevchenko
PATCH v5 10/14 platform/x86: dell-smbios: add filtering capability for requests
In reply to Mario LimoncielloThere are some categories of tokens and SMBIOS calls that it makes sense to protect userspace from accessing. These are calls that may write to one time use fields or activate hardware debugging capabilities. They are not intended for general purpose use.
This same functionality may be be later extended to also intercept calls that may cause kernel functionality to get out of sync if the same functions are used by other drivers.
--- drivers/platform/x86/dell-smbios.c | 76 ++++++++++++++++++++++++++++++++++++++ drivers/platform/x86/dell-smbios.h | 2 + 2 files changed, 78 insertions(+)
drivers/platform/x86/dell-smbios.c +76 -0
@@ -32,6 +32,7 @@ struct calling_interface_structure {struct calling_interface_token tokens[]; } __packed; +static u32 da_supported_commands;static int da_command_address;static int da_command_code;static int da_num_tokens;
@@ -45,6 +46,14 @@ struct smbios_device {int (*call_fn)(struct calling_interface_buffer *); }; +static u32 token_black[] = { +0x0175 ,0x0176 ,0x0195 ,0x0196 ,0x0197 ,0x01DC ,0x01DD ,0x027D ,0x027E , +0x027F ,0x0280 ,0x0281 ,0x0282 ,0x0283 ,0x0284 ,0x02E3 ,0x02FF ,0x0300 , +0x0301 ,0x0302 ,0x0325 ,0x0326 ,0x0332 ,0x0333 ,0x0334 ,0x0335 ,0x0350 , +0x0363 ,0x0368 ,0x03F6 ,0x03F7 ,0x049E ,0x049F ,0x04A0 ,0x04A1 ,0x04A2 , +0x04A3 ,0x04E6 ,0x04E7 ,0x9000 ,0x9001 +}; +static LIST_HEAD (smbios_device_list);void dell_smbios_get_smm_address (int *address,int *code)
@@ -104,6 +113,65 @@ 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) +{ +int i; +int j; +u32 t; + +/* can't make calls over 30 */ +if (buffer->class >30 ) { +dev_dbg (d,"buffer->class too big: %d\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 ; + } + +/* diagonstics, debugging information or write once */ +if ((buffer->class ==01 && buffer->select ==07 ) || + (buffer->class ==06 && buffer->select ==05 ) || + (buffer->class ==11 && buffer->select ==03 ) || + (buffer->class ==11 && buffer->select ==07 ) || + (buffer->class ==11 && buffer->select ==11 ) || + buffer->class ==19 ) { +dev_dbg (d,"blacklisted command: %d/%d\n" , + buffer->class, buffer->select); +return -EINVAL ; + } + +/* reading/writing tokens*/ +if ((buffer->class ==0 && buffer->select <3 ) || + (buffer->class ==1 && buffer->select <3 )) { +for (i =0 ; i < da_num_tokens; i++) { +if (da_tokens[i].location != buffer->input[0 ]) +continue ; +/*blacklist reading and writing these */ + t = da_tokens[i].tokenID; +if ((t >=0x4000 && t <=0x7FFF ) || + (t >=0xA000 && t <=0xBFFF ) || + (t >=0xEFF0 && t <=0xEFFF )) +return -EINVAL ; +for (j =0 ; j <ARRAY_SIZE (token_black); j++) +if (t == token_black[j]) +return -EINVAL ; +/* token exists and is OK */ +return 0 ; + } +/* token didn't exist */ +dev_dbg (d,"token at location %u doesn't exist\n" , + buffer->input[0 ]); +return -EINVAL ; + } +return 0 ; +} +EXPORT_SYMBOL_GPL (dell_smbios_call_filter); +int dell_smbios_call (struct calling_interface_buffer *buffer) {int (*call_fn)(struct calling_interface_buffer *) =NULL ;
@@ -127,6 +195,13 @@ int dell_smbios_call(struct calling_interface_buffer *buffer) goto out_smbios_call; } +if (dell_smbios_call_filter (selected_dev, buffer)) { + ret = -EINVAL ; +dev_err (selected_dev,"Invalid call %d/%d:%8x\n" , + buffer->class, buffer->select, buffer->input[0 ]); + goto out_smbios_call; + } + ret =call_fn (buffer); out_smbios_call:
@@ -184,6 +259,7 @@ static void __init parse_da_table(const struct dmi_header *dm) da_command_address = table->cmdIOAddress; da_command_code = table->cmdIOCode; + da_supported_commands = table->supportedCmds; new_da_tokens = krealloc(da_tokens, (da_num_tokens + tokens) * sizeof(struct calling_interface_token),
drivers/platform/x86/dell-smbios.h +2 -0
@@ -45,6 +45,8 @@ void dell_smbios_unregister_device(struct device *d);void dell_smbios_get_smm_address (int *address,int *command);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
Re: [PATCH v5 10/14] platform/x86: dell-smbios: add filtering capability for requests
Quoted 28 lines · Mario Limonciello
There are some categories of tokens and SMBIOS calls that it makes sense to protect userspace from accessing. These are calls that may write to one time use fields or activate hardware debugging capabilities. They are not intended for general purpose use.
This same functionality may be be later extended to also intercept calls that may cause kernel functionality to get out of sync if the same functions are used by other drivers.
Signed-off-by Mario Limonciello <[email protected]>--- drivers/platform/x86/dell-smbios.c | 76 ++++++++++++++++++++++++++++++++++++++ drivers/platform/x86/dell-smbios.h | 2 + 2 files changed, 78 insertions(+)drivers/platform/x86/dell-smbios.c +1
-0@@ -32,6 +32,7 @@ struct calling_interface_structure {struct calling_interface_token tokens[]; } __packed; +static u32 da_supported_commands;static int da_command_address;static int da_command_code;static int da_num_tokens;
drivers/platform/x86/dell-smbios.c struct smbios_device { · line 55
Quoted 10 lines
drivers/platform/x86/dell-smbios.c +7
-0@@ -45,6 +46,14 @@ struct smbios_device {int (*call_fn)(struct calling_interface_buffer *); }; +static u32 token_black[] = { +0x0175 ,0x0176 ,0x0195 ,0x0196 ,0x0197 ,0x01DC ,0x01DD ,0x027D ,0x027E , +0x027F ,0x0280 ,0x0281 ,0x0282 ,0x0283 ,0x0284 ,0x02E3 ,0x02FF ,0x0300 , +0x0301 ,0x0302 ,0x0325 ,0x0326 ,0x0332 ,0x0333 ,0x0334 ,0x0335 ,0x0350 , +0x0363 ,0x0368 ,0x03F6 ,0x03F7 ,0x049E ,0x049F ,0x04A0 ,0x04A1 ,0x04A2 , +0x04A3 ,0x04E6 ,0x04E7 ,0x9000 ,0x9001 +};
Any hint as to what these values represent?
Quoted 24 lines
drivers/platform/x86/dell-smbios.c +17
-0static LIST_HEAD (smbios_device_list);void dell_smbios_get_smm_address (int *address,int *code)@@ -104,6 +113,65 @@ 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) +{ +int i; +int j; +u32 t; + +/* can't make calls over 30 */ +if (buffer->class >30 ) { +dev_dbg (d,"buffer->class too big: %d\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);
drivers/platform/x86/dell-smbios.c void dell_smbios_unregister_device(struct device *d) · line 142
Quoted 10 lines
drivers/platform/x86/dell-smbios.c +10
-0+return -EINVAL ; + } + +/* diagonstics, debugging information or write once */ +if ((buffer->class ==01 && buffer->select ==07 ) || + (buffer->class ==06 && buffer->select ==05 ) || + (buffer->class ==11 && buffer->select ==03 ) || + (buffer->class ==11 && buffer->select ==07 ) || + (buffer->class ==11 && buffer->select ==11 ) || + buffer->class ==19 ) {
A structure of class/select that is not allowed might be easier to maintain over time, right?
drivers/platform/x86/dell-smbios.c void dell_smbios_unregister_device(struct device *d) · line 154
Quoted 12 lines
drivers/platform/x86/dell-smbios.c +12
-0+dev_dbg (d,"blacklisted command: %d/%d\n" , + buffer->class, buffer->select); +return -EINVAL ; + } + +/* reading/writing tokens*/ +if ((buffer->class ==0 && buffer->select <3 ) || + (buffer->class ==1 && buffer->select <3 )) { +for (i =0 ; i < da_num_tokens; i++) { +if (da_tokens[i].location != buffer->input[0 ]) +continue ; +/*blacklist reading and writing these */
"/* " ???
thanks,
greg k-h
PATCH v5 11/14 platform/x86: dell-smbios-wmi: Add new WMI dispatcher driver
In reply to Mario LimoncielloThe 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 | 16 ++- drivers/platform/x86/Makefile | 1 + drivers/platform/x86/dell-smbios-wmi.c | 229 +++++++++++++++++++++++++++++++++ 4 files changed, 251 insertions(+), 1 deletion(-) create mode 100644 drivers/platform/x86/dell-smbios-wmi.c
MAINTAINERS +6 -0
@@ -3980,6 +3980,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 +15 -1
@@ -93,7 +93,21 @@ config ASUS_LAPTOP config DELL_SMBIOS tristate - depends on DELL_SMBIOS_SMM + depends on DELL_SMBIOS_WMI || DELL_SMBIOS_SMM + +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)"
drivers/platform/x86/Makefile +1 -0
@@ -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 +229 -0
229 lines not on this page · raw message
Signature · 1 line
2.14.1
PATCH v5 12/14 platform/x86: dell-smbios-smm: test for WSMT
In reply to Mario LimoncielloWSMT 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 | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+)
drivers/platform/x86/dell-smbios-smm.c +34 -0
@@ -25,6 +25,8 @@ static struct calling_interface_buffer *buffer;struct platform_device *platform_device;static DEFINE_MUTEX (smm_mutex); +#define WSMT_EN_TOKEN 0x04EC +static const struct dmi_system_id dell_device_table[]__initconst = { { .ident ="Dell laptop" ,
@@ -76,6 +78,30 @@ int dell_smbios_smm_call(struct calling_interface_buffer *input)return 0 ; } +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 =0 ; + buffer->select =0 ; +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;
@@ -88,6 +114,13 @@ static int __init dell_smbios_smm_init(void)return -ENOMEM ;dell_smbios_get_smm_address (&da_command_address, &da_command_code); + 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 ;
@@ -111,6 +144,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;
Signature · 1 line
2.14.1
PATCH v5 13/14 platform/x86: wmi: create character devices when requested by drivers
In reply to Mario LimoncielloFor 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 | 85 ++++++++++++++++++++++++++++++++++++++++++++++ include/linux/wmi.h | 5 +++ include/uapi/linux/wmi.h | 19 +++++++++++ 4 files changed, 110 insertions(+) create mode 100644 include/uapi/linux/wmi.h
MAINTAINERS +1 -0
@@ -372,6 +372,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 +85 -0
115 lines not on this page · raw message
include/linux/wmi.h +5 -0
@@ -18,6 +18,7 @@#include <linux/device.h> #include <linux/acpi.h> +#include <uapi/linux/wmi.h> struct wmi_device {struct device dev;
@@ -47,6 +48,10 @@ 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); +long (*compat_ioctl)(struct wmi_device *wdev,unsigned int cmd, +unsigned long arg); }; extern int __must_check __wmi_driver_register(struct wmi_driver *driver,
include/uapi/linux/wmi.h new file +19 -0
@@ -0,0 +1,19 @@ +/* +* 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 + +#define WMI_IOC 'W' +#define WMI_IO (instance) _IO(WMI_IOC, instance) +#define WMI_IOR (instance, type) _IOR(WMI_IOC, instance, type) +#define WMI_IOW (instance, type) _IOW(WMI_IOC, instance, type) +#define WMI_IOWR (instance, type) _IOWR(WMI_IOC, instance, type) + +#endif
Signature · 1 line
2.14.1
Re: [PATCH v5 13/14] platform/x86: wmi: create character devices when requested by drivers
Quoted 25 lines · 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_driverthe WMI bus driver will create a character device that maps to that function.That character device will correspond to this path:
/dev/wmi/$driverThe 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_deviceswill need to be all handled by the samewmi_driverif the same character device is used.
Quoted 5 lines
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.
What prevents the vendor driver from being unloaded while the ioctl is being called in it? I don't see any protection here from that at all :(
drivers/platform/x86/wmi.c static int wmi_dev_match(struct device *dev, struct device_driver *driver) · line 820
Quoted 11 lines
drivers/platform/x86/wmi.c +11
-0+static long wmi_unlocked_ioctl (struct file *filp,unsigned int cmd, +unsigned long arg) +{ +return match_ioctl (filp, cmd, arg,0 ); +} + +static long wmi_compat_ioctl (struct file *filp,unsigned int cmd, +unsigned long arg) +{ +return match_ioctl (filp, cmd, arg,1 ); +}
Why a compat ioctl at all? That's for older interfaces, not for brand new ones where you design the ioctl structures "correctly" to work on both 32 and 64 bits at the same time. That should not be needed at all.
thanks,
greg k-h
RE: [PATCH v5 13/14] platform/x86: wmi: create character devices when requested by drivers
Quoted 39 lines
-----Original Message-----
From: Greg KH [mailto:[email protected]]
Sent: Saturday, October 7, 2017 2:35 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]; [email protected]
Subject: Re: [PATCH v5 13/14] platform/x86: wmi: create character devices when requested by driversQuoted 25 lines · 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_driverthe WMI bus driver will create a character device that maps to that function.That character device will correspond to this path:
/dev/wmi/$driverThe 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_deviceswill need to be all handled by the samewmi_driverif the same character device is used.
Quoted 9 lines
Quoted 5 lines
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.
What prevents the vendor driver from being unloaded while the ioctl is being called in it? I don't see any protection here from that at all :(
In my driver I take a mutex that blocks unloading while running ioctl, but you mean you want one in the bus driver more generally, OK.
Quoted 16 lines
drivers/platform/x86/wmi.c static int wmi_dev_match(struct device *dev, struct device_driver *driver) · line 820
Quoted 11 lines
drivers/platform/x86/wmi.c +11
-0+static long wmi_unlocked_ioctl (struct file *filp,unsigned int cmd, +unsigned long arg) +{ +return match_ioctl (filp, cmd, arg,0 ); +} + +static long wmi_compat_ioctl (struct file *filp,unsigned int cmd, +unsigned long arg) +{ +return match_ioctl (filp, cmd, arg,1 ); +}Why a compat ioctl at all? That's for older interfaces, not for brand new ones where you design the ioctl structures "correctly" to work on both 32 and 64 bits at the same time. That should not be needed at all.
Quoted 3 lines
thanks,
greg k-h
I was trying to make sure that any other future vendor drivers had it for an
option. I wasn't aware that new code shouldn't use it. OK, I'll remove it.
Re: [PATCH v5 13/14] platform/x86: wmi: create character devices when requested by drivers
Quoted 45 lines · On Sat, Oct 07, 2017 at 11:59:52AM +0000, [email protected] wrote:
Quoted 45 lines
-----Original Message-----
From: Greg KH [mailto:[email protected]]
Sent: Saturday, October 7, 2017 2:35 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]; [email protected]
Subject: Re: [PATCH v5 13/14] platform/x86: wmi: create character devices when requested by driversQuoted 30 lines · 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_driverthe WMI bus driver will create a character device that maps to that function.That character device will correspond to this path:
/dev/wmi/$driverThe 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_deviceswill need to be all handled by the samewmi_driverif 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.
Quoted 6 lines
Quoted 3 lines
What prevents the vendor driver from being unloaded while the ioctl is being called in it? I don't see any protection here from that at all :(
In my driver I take a mutex that blocks unloading while running ioctl, but you mean you want one in the bus driver more generally, OK.
No, you need to increment the module reference count before calling into it, which prevents anyone from even attempting to unload it. Much simpler than trying to rely on a mutex that is not obviously documented that this is what it does (hint, sharing a mutex across modules is not a good idea...)
thanks,
greg k-h
PATCH v5 14/14 platform/x86: dell-smbios-wmi: introduce userspace interface
In reply to Mario LimoncielloIt'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.
The API for interacting with this interface is defined in documentation as well as a uapi header provides the format of the structures.
--- Documentation/ABI/testing/dell-smbios-wmi | 41 ++++++++ .../ABI/testing/sysfs-platform-dell-smbios-wmi | 10 ++ MAINTAINERS | 1 + drivers/platform/x86/dell-smbios-wmi.c | 104 ++++++++++++++++++--- drivers/platform/x86/dell-smbios.h | 11 +-- include/uapi/linux/dell-smbios.h | 42 +++++++++ 6 files changed, 188 insertions(+), 21 deletions(-) create mode 100644 Documentation/ABI/testing/dell-smbios-wmi create mode 100644 Documentation/ABI/testing/sysfs-platform-dell-smbios-wmi create mode 100644 include/uapi/linux/dell-smbios.h
Documentation/ABI/testing/dell-smbios-wmi new file +41 -0
@@ -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/dell-smbios.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, refer to: + sysfs-platform-dell-smbios-wmi + + 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.
Documentation/ABI/testing/sysfs-platform-dell-smbios-wmi new file +10 -0
@@ -0,0 +1,10 @@ +What: /sys/devices/platform/<platform>/buffer_size +Date: November 2017 +KernelVersion: 4.15 +Contact: "Mario Limonciello" <[email protected]> +Description: + A read-only description of the size of a calling + interface buffer that can be passed to Dell + firmware. + + Commonly this size is either 4k or 32k.
MAINTAINERS +1 -0
@@ -3986,6 +3986,7 @@ M: Mario Limonciello <[email protected]> L: [email protected] S: Maintained F: drivers/platform/x86/dell-smbios-wmi.c +F: include/uapi/linux/dell-smbios.h DELL LAPTOP DRIVER M: Matthew Garrett <[email protected]>
drivers/platform/x86/dell-smbios-wmi.c +93 -11
154 lines not on this page · raw message
drivers/platform/x86/dell-smbios.h +1 -10
@@ -17,19 +17,10 @@#define _DELL_SMBIOS_H_#include <linux/device.h> +#include <uapi/linux/dell-smbios.h> 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/dell-smbios.h new file +42 -0
42 lines not on this page · raw message
Signature · 1 line
2.14.1
Re: [PATCH v5 14/14] platform/x86: dell-smbios-wmi: introduce userspace interface
Quoted 141 lines · 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.
The API for interacting with this interface is defined in documentation as well as a uapi header provides the format of the structures.
Signed-off-by Mario Limonciello <[email protected]>--- Documentation/ABI/testing/dell-smbios-wmi | 41 ++++++++ .../ABI/testing/sysfs-platform-dell-smbios-wmi | 10 ++ MAINTAINERS | 1 + drivers/platform/x86/dell-smbios-wmi.c | 104 ++++++++++++++++++--- drivers/platform/x86/dell-smbios.h | 11 +-- include/uapi/linux/dell-smbios.h | 42 +++++++++ 6 files changed, 188 insertions(+), 21 deletions(-) create mode 100644 Documentation/ABI/testing/dell-smbios-wmi create mode 100644 Documentation/ABI/testing/sysfs-platform-dell-smbios-wmi create mode 100644 include/uapi/linux/dell-smbios.hDocumentation/ABI/testing/dell-smbios-wmi new file +41
-0@@ -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/dell-smbios.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, refer to: + sysfs-platform-dell-smbios-wmi + + 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.Documentation/ABI/testing/sysfs-platform-dell-smbios-wmi new file +10
-0@@ -0,0 +1,10 @@ +What: /sys/devices/platform/<platform>/buffer_size +Date: November 2017 +KernelVersion: 4.15 +Contact: "Mario Limonciello" <[email protected]> +Description: + A read-only description of the size of a calling + interface buffer that can be passed to Dell + firmware. + + Commonly this size is either 4k or 32k.MAINTAINERS +1
-0@@ -3986,6 +3986,7 @@ M: Mario Limonciello <[email protected]> L: [email protected] S: Maintained F: drivers/platform/x86/dell-smbios-wmi.c +F: include/uapi/linux/dell-smbios.h DELL LAPTOP DRIVER M: Matthew Garrett <[email protected]>drivers/platform/x86/dell-smbios-wmi.c +2
-11@@ -15,6 +15,7 @@#include <linux/mutex.h> #include <linux/uaccess.h> #include <linux/wmi.h> +#include <uapi/linux/dell-smbios.h> #include "dell-smbios.h" #include "dell-wmi-descriptor.h" static DEFINE_MUTEX (call_mutex);@@ -29,19 +30,9 @@ struct misc_bios_flags_structure {#define DELL_WMI_SMBIOS_GUID "A80593CE-A997-11DA-B012-B622A1EF5492" -struct wmi_extensions { -__u32 argattrib; -__u32 blength; -__u8 data[]; -} __packed; - -struct wmi_smbios_buffer { -struct calling_interface_buffer std; -struct wmi_extensions ext; -} __packed; -struct wmi_smbios_priv {struct wmi_smbios_buffer *buf; +struct device_attribute buffer_size_attr;struct list_head list;struct wmi_device *wdev;struct device *child;
drivers/platform/x86/dell-smbios-wmi.c int dell_smbios_wmi_call(struct calling_interface_buffer *buffer) · line 111
Quoted 8 lines
drivers/platform/x86/dell-smbios-wmi.c +5
-0@@ -113,6 +104,78 @@ int dell_smbios_wmi_call(struct calling_interface_buffer *buffer)return ret; } +static long dell_smbios_wmi_ioctl (struct wmi_device *wdev,unsigned int cmd, +unsigned long arg) +{ +struct wmi_smbios_buffer __user *input = + (struct wmi_smbios_buffer __user *) arg;
Why not just always define arg as "struct wmi_smbios_buffer __user *"? No need to pass down a vague type here, right?
Unless you need to better name your structure to show that it is a dell type only :)
Quoted 14 lines
drivers/platform/x86/dell-smbios-wmi.c +14
-0+struct wmi_smbios_priv *priv; +int ret =0 ; +size_t size; + +switch (cmd) { +case DELL_WMI_SMBIOS_CMD : + priv =dev_get_drvdata (&wdev->dev); +if (!priv) +return -ENODEV ; + size =sizeof (struct wmi_smbios_buffer ); +mutex_lock (&call_mutex); +if (copy_from_user (priv->buf, input, size)) { +dev_dbg (&wdev->dev,"Copy %lu from user failed\n" , + size);
drivers/platform/x86/dell-smbios-wmi.c int dell_smbios_wmi_call(struct calling_interface_buffer *buffer) · line 135
Quoted 10 lines
drivers/platform/x86/dell-smbios-wmi.c +10
-0+ ret = -EFAULT ; + goto fail_smbios_cmd; + } +if (priv->buf->length < priv->buffer_size) { +dev_err (&wdev->dev, +"Buffer %lld too small, need at least %d\n" , + priv->buf->length, priv->buffer_size); + ret = -EINVAL ; + goto fail_smbios_cmd; + }
No checking for too big of a length? Any other fields you should check for validity? Like too small?
drivers/platform/x86/dell-smbios-wmi.c int dell_smbios_wmi_call(struct calling_interface_buffer *buffer) · line 143
Quoted 8 lines
drivers/platform/x86/dell-smbios-wmi.c +8
-0+if (dell_smbios_call_filter (&wdev->dev, &priv->buf->std)) { +dev_err (&wdev->dev,"Invalid call %d/%d:%8x\n" , + priv->buf->std.class, priv->buf->std.select, + priv->buf->std.input[0 ]); + ret = -EFAULT ; + goto fail_smbios_cmd; + } + size = priv->buffer_size -sizeof (struct wmi_smbios_buffer );
What if size just went too small and wrapped around? :(
Remember, "All input is evil". Go print that out and put it on the wall when you are designing this user/kernel api. You can trust no one, you have to validate _everything_.
Quoted 18 lines
include/uapi/linux/dell-smbios.h new file +15
-0@@ -0,0 +1,42 @@ +/* +* User API for WMI methods for use with dell-smbios +* +* 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_DELL_SMBIOS_H_ +#define _UAPI_DELL_SMBIOS_H_ + +#include <linux/ioctl.h> +#include <linux/wmi.h>
include/uapi/linux/dell-smbios.h line 25
Quoted 10 lines
include/uapi/linux/dell-smbios.h new file +10
-0+ +/* 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;
I still don't buy the use of volatile, but oh well, I'm assuming you properly tested this?
include/uapi/linux/dell-smbios.h line 37
Quoted 11 lines
include/uapi/linux/dell-smbios.h new file +11
-0+struct wmi_extensions { +__u32 argattrib; +__u32 blength; +__u8 data[]; +} __packed; + +struct wmi_smbios_buffer { +__u64 length; +struct calling_interface_buffer std; +struct wmi_extensions ext; +} __packed;
Much better, right? Now why do you feel you need a compat ioctl for this structure? If you do, where is that logic?
And I still didn't see where you were verifying the list of commands in this structure, was that in some other patch?
thanks,
greg k-h
Re: [PATCH v5 14/14] platform/x86: dell-smbios-wmi: introduce userspace interface
Quoted 2 lines · Greg KH
And I still didn't see where you were verifying the list of commands in this structure, was that in some other patch?
Oh nevermind, that was a different patch, found it...
RE: [PATCH v5 14/14] platform/x86: dell-smbios-wmi: introduce userspace interface
In reply to Greg KHQuoted 172 lines
-----Original Message-----
From: Greg KH [mailto:[email protected]]
Sent: Saturday, October 7, 2017 2:42 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]; [email protected]
Subject: Re: [PATCH v5 14/14] platform/x86: dell-smbios-wmi: introduce userspace interfaceQuoted 20 lines · 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.
The API for interacting with this interface is defined in documentation as well as a uapi header provides the format of the structures.
Signed-off-by Mario Limonciello <[email protected]>Quoted 10 lines
--- Documentation/ABI/testing/dell-smbios-wmi | 41 ++++++++ .../ABI/testing/sysfs-platform-dell-smbios-wmi | 10 ++ MAINTAINERS | 1 + drivers/platform/x86/dell-smbios-wmi.c | 104 ++++++++++++++++++--- drivers/platform/x86/dell-smbios.h | 11 +-- include/uapi/linux/dell-smbios.h | 42 +++++++++ 6 files changed, 188 insertions(+), 21 deletions(-) create mode 100644 Documentation/ABI/testing/dell-smbios-wmi create mode 100644 Documentation/ABI/testing/sysfs-platform-dell-smbios-wmi
Review
Quoted 3 lines
create mode 100644 include/uapi/linux/dell-smbios.h(quoted diff) +0
-0b/Documentation/ABI/testing/dell-smbios-wmi
Review
Quoted 47 lines
new file mode 100644
index 000000000000..e067e955fcc9Documentation/ABI/testing/dell-smbios-wmi new file +41
-0@@ -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/dell-smbios.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, refer to: + sysfs-platform-dell-smbios-wmi + + 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.(quoted diff) +0
-0b/Documentation/ABI/testing/sysfs-platform-dell-smbios-wmi
Review
Quoted 28 lines
new file mode 100644
index 000000000000..6a0513703a3cDocumentation/ABI/testing/sysfs-platform-dell-smbios-wmi new file +10
-0@@ -0,0 +1,10 @@ +What: /sys/devices/platform/<platform>/buffer_size +Date: November 2017 +KernelVersion: 4.15 +Contact: "Mario Limonciello" <[email protected]> +Description: + A read-only description of the size of a calling + interface buffer that can be passed to Dell + firmware. + + Commonly this size is either 4k or 32k.MAINTAINERS +1
-0@@ -3986,6 +3986,7 @@ M: Mario Limonciello <[email protected]> L: [email protected] S: Maintained F: drivers/platform/x86/dell-smbios-wmi.c +F: include/uapi/linux/dell-smbios.h DELL LAPTOP DRIVER M: Matthew Garrett <[email protected]>(quoted diff) +0
-0
b/drivers/platform/x86/dell-smbios-wmi.cQuoted 12 lines
index
3de8abea38f8..2b78aba68755100644drivers/platform/x86/dell-smbios-wmi.c +1
-0@@ -15,6 +15,7 @@#include <linux/mutex.h> #include <linux/uaccess.h> #include <linux/wmi.h> +#include <uapi/linux/dell-smbios.h> #include "dell-smbios.h" #include "dell-wmi-descriptor.h" static DEFINE_MUTEX (call_mutex);drivers/platform/x86/dell-smbios-wmi.c struct misc_bios_flags_structure { · line 31
Quoted 2 lines
drivers/platform/x86/dell-smbios-wmi.c +0
-0@@ -29,19 +30,9 @@ struct misc_bios_flags_structure {#define DELL_WMI_SMBIOS_GUID "A80593CE-A997-11DA-B012-B622A1EF5492"
drivers/platform/x86/dell-smbios-wmi.c int dell_smbios_wmi_call(struct
Quoted 19 lines
drivers/platform/x86/dell-smbios-wmi.c +1
-11-struct wmi_extensions { -__u32 argattrib; -__u32 blength; -__u8 data[]; -} __packed; - -struct wmi_smbios_buffer { -struct calling_interface_buffer std; -struct wmi_extensions ext; -} __packed; -struct wmi_smbios_priv {struct wmi_smbios_buffer *buf; +struct device_attribute buffer_size_attr;struct list_head list;struct wmi_device *wdev;struct device *child;@@ -113,6 +104,78 @@ int dell_smbios_wmi_call(struct
calling_interface_buffer*buffer)drivers/platform/x86/dell-smbios-wmi.c int dell_smbios_wmi_call(struct calling_interface_buffer *buffer)
Quoted 4 lines
drivers/platform/x86/dell-smbios-wmi.c +1
-0return ret; } +static long dell_smbios_wmi_ioctl(struct wmi_device *wdev, unsigned intcmd,
drivers/platform/x86/dell-smbios-wmi.c int dell_smbios_wmi_call(struct calling_interface_buffer *buffer) · line 111
Quoted 4 lines
drivers/platform/x86/dell-smbios-wmi.c +4
-0+ unsigned long arg) +{ +struct wmi_smbios_buffer __user *input = + (struct wmi_smbios_buffer __user *) arg;Why not just always define arg as "struct
wmi_smbios_buffer__user*"? No need to pass down a vague type here, right?
Quoted 2 lines
Unless you need to better name your structure to show that it is a dell type only :)
Great idea thanks.
Quoted 20 lines
Quoted 20 lines
drivers/platform/x86/dell-smbios-wmi.c +19
-0+struct wmi_smbios_priv *priv; +int ret =0 ; +size_t size; + +switch (cmd) { +case DELL_WMI_SMBIOS_CMD : + priv =dev_get_drvdata (&wdev->dev); +if (!priv) +return -ENODEV ; + size =sizeof (struct wmi_smbios_buffer ); +mutex_lock (&call_mutex); +if (copy_from_user (priv->buf, input, size)) { +dev_dbg (&wdev->dev,"Copy %lu from user failed\n" , + size); + ret = -EFAULT ; + goto fail_smbios_cmd; + } +if (priv->buf->length < priv->buffer_size) { + dev_err(&wdev->dev,
Quoted 8 lines
drivers/platform/x86/dell-smbios-wmi.c int dell_smbios_wmi_call(struct calling_interface_buffer *buffer) · line 135
Quoted 5 lines
drivers/platform/x86/dell-smbios-wmi.c +5
-0+"Buffer %lld too small, need at least %d\n" , + priv->buf->length, priv->buffer_size); + ret = -EINVAL ; + goto fail_smbios_cmd; + }No checking for too big of a length? Any other fields you should check for validity? Like too small?
Too big is actually intentionally ignored.
I split the copy into two segments to check for this.
1. First copy the size of the structure
(if userspace didn't allocate at least sizeof(struct wmi_smbios_buffer) that's a problem)
2. Verify the size claimed is "at least" what we internally are looking for.
3. Copy the rest of the size internally needed. If userspace sent more it's just not copied.
4. When sending it back I only send back up to the "at least" internal size.
Quoted 12 lines
drivers/platform/x86/dell-smbios-wmi.c int dell_smbios_wmi_call(struct calling_interface_buffer *buffer) · line 143
Quoted 9 lines
drivers/platform/x86/dell-smbios-wmi.c +8
-0+if (dell_smbios_call_filter (&wdev->dev, &priv->buf->std)) { +dev_err (&wdev->dev,"Invalid call %d/%d:%8x\n" , + priv->buf->std.class, priv->buf->std.select, + priv->buf->std.input[0 ]); + ret = -EFAULT ; + goto fail_smbios_cmd; + } + size = priv->buffer_size -sizeof (struct wmi_smbios_buffer );What if size just went too small and wrapped around? :(
Quoted 3 lines
Remember, "All input is evil". Go print that out and put it on the wall when you are designing this user/kernel api. You can trust no one, you have to validate _everything_.
priv->buffer_size can't be set by userspace.
Quoted 24 lines
Quoted 24 lines
include/uapi/linux/dell-smbios.h new file +20
-0@@ -0,0 +1,42 @@ +/* +* User API for WMI methods for use with dell-smbios +* +* 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_DELL_SMBIOS_H_ +#define _UAPI_DELL_SMBIOS_H_ + +#include <linux/ioctl.h> +#include <linux/wmi.h> + +/* This structure may be modified by the firmware when we enter +* system management mode through SMM, hence the volatiles +*/ +struct calling_interface_buffer {
Quoted 8 lines
include/uapi/linux/dell-smbios.h line 25
Quoted 5 lines
include/uapi/linux/dell-smbios.h new file +5
-0+__u16 class; +__u16 select; +volatile __u32 input[4 ]; +volatile __u32 output[4 ]; +} __packed;I still don't buy the use of volatile, but oh well, I'm assuming you properly tested this?
If I wasn't hanging onto the SMM legacy driver I'd drop this, but it's used when the SMM driver works on this structure.
I've tested it with both the SMM and WMI drivers though, yes.
Quoted 15 lines
include/uapi/linux/dell-smbios.h line 37
Quoted 12 lines
include/uapi/linux/dell-smbios.h new file +11
-0+struct wmi_extensions { +__u32 argattrib; +__u32 blength; +__u8 data[]; +} __packed; + +struct wmi_smbios_buffer { +__u64 length; +struct calling_interface_buffer std; +struct wmi_extensions ext; +} __packed;Much better, right? Now why do you feel you need a compat ioctl for this structure? If you do, where is that logic?
Yes, thank you this is much cleaner.
Other "newish" drivers provide both stubs even if they point to the same function.
Eg:
https://github.com/torvalds/linux/commit/2521ea3e0d1b285cea371a38772d3eefa0490c71
I did check that as things are in v5 it works both in 32 and 64 applications.
Re: [PATCH v5 14/14] platform/x86: dell-smbios-wmi: introduce userspace interface
Quoted 4 lines · On Sat, Oct 07, 2017 at 12:15:18PM +0000, [email protected] wrote:
Quoted 4 lines
Quoted 4 lines
drivers/platform/x86/dell-smbios-wmi.c +4
-0+struct wmi_smbios_priv *priv; +int ret =0 ; +size_t size; +
Quoted 8 lines
Quoted 8 lines
drivers/platform/x86/dell-smbios-wmi.c int dell_smbios_wmi_call(struct calling_interface_buffer *buffer) · line 123
Quoted 8 lines
drivers/platform/x86/dell-smbios-wmi.c +8
-0+switch (cmd) { +case DELL_WMI_SMBIOS_CMD : + priv =dev_get_drvdata (&wdev->dev); +if (!priv) +return -ENODEV ; + size =sizeof (struct wmi_smbios_buffer ); +mutex_lock (&call_mutex); +if (copy_from_user (priv->buf, input, size)) {
Wait, how do you know that input is size big?
Quoted 16 lines
Quoted 7 lines
Quoted 7 lines
drivers/platform/x86/dell-smbios-wmi.c +7
-0+dev_dbg (&wdev->dev,"Copy %lu from user failed\n" , + size); + ret = -EFAULT ; + goto fail_smbios_cmd; + } +if (priv->buf->length < priv->buffer_size) { + dev_err(&wdev->dev,Quoted 8 lines
drivers/platform/x86/dell-smbios-wmi.c int dell_smbios_wmi_call(struct calling_interface_buffer *buffer) · line 135
Quoted 5 lines
drivers/platform/x86/dell-smbios-wmi.c +5
-0+"Buffer %lld too small, need at least %d\n" , + priv->buf->length, priv->buffer_size); + ret = -EINVAL ; + goto fail_smbios_cmd; + }No checking for too big of a length? Any other fields you should check for validity? Like too small?
Quoted 1 line
Too big is actually intentionally ignored.
That seems "odd"...
Quoted 6 lines
I split the copy into two segments to check for this.
1. First copy the size of the structure
(if userspace didn't allocate at leastsizeof(struct wmi_smbios_buffer)that's a problem)
2. Verify the size claimed is "at least" what we internally are looking for.
3. Copy the rest of the size internally needed. If userspace sent more it's just not copied.
4. When sending it back I only send back up to the "at least" internal size.
That feels strange, are you sure this is correct? Why the odd two step process here?
What if 'length' is set to an invalid value (too big or small), will you catch that correctly here?
Quoted 11 lines
Quoted 11 lines
drivers/platform/x86/dell-smbios-wmi.c int dell_smbios_wmi_call(struct calling_interface_buffer *buffer) · line 143
Quoted 8 lines
drivers/platform/x86/dell-smbios-wmi.c +8
-0+if (dell_smbios_call_filter (&wdev->dev, &priv->buf->std)) { +dev_err (&wdev->dev,"Invalid call %d/%d:%8x\n" , + priv->buf->std.class, priv->buf->std.select, + priv->buf->std.input[0 ]); + ret = -EFAULT ; + goto fail_smbios_cmd; + } + size = priv->buffer_size -sizeof (struct wmi_smbios_buffer );What if size just went too small and wrapped around? :(
Quoted 5 lines
Quoted 3 lines
Remember, "All input is evil". Go print that out and put it on the wall when you are designing this user/kernel api. You can trust no one, you have to validate _everything_.
priv->buffer_sizecan't be set by userspace.
Who sets it? Your structure naming here doesn't make it obvious which data is from the kernel and which from userspace, making this very hard to audit :(
thanks,
greg k-h
RE: [PATCH v5 14/14] platform/x86: dell-smbios-wmi: introduce userspace interface
Quoted 12 lines
-----Original Message-----
From: Greg KH [mailto:[email protected]]
Sent: Saturday, October 7, 2017 7: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]
Subject: Re: [PATCH v5 14/14] platform/x86: dell-smbios-wmi: introduce userspace interfaceOn Sat, Oct 07, 2017 at 12:15:18PM +0000, [email protected] wrote:
Quoted 14 lines
Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
drivers/platform/x86/dell-smbios-wmi.c +4
-0+struct wmi_smbios_priv *priv; +int ret =0 ; +size_t size; +Quoted 8 lines
Quoted 8 lines
drivers/platform/x86/dell-smbios-wmi.c int dell_smbios_wmi_call(struct calling_interface_buffer *buffer) · line 123
Quoted 8 lines
drivers/platform/x86/dell-smbios-wmi.c +8
-0+switch (cmd) { +case DELL_WMI_SMBIOS_CMD : + priv =dev_get_drvdata (&wdev->dev); +if (!priv) +return -ENODEV ; + size =sizeof (struct wmi_smbios_buffer ); +mutex_lock (&call_mutex); +if (copy_from_user (priv->buf, input, size)) {Wait, how do you know that input is size big?
How can you check this? I guess just read the first u64 for the data first (where length is stored). Or is there a better way?
Quoted 27 lines
Quoted 17 lines
Quoted 16 lines
drivers/platform/x86/dell-smbios-wmi.c int dell_smbios_wmi_call(struct calling_interface_buffer *buffer) · line 135
Quoted 13 lines
drivers/platform/x86/dell-smbios-wmi.c +12
-0+dev_dbg (&wdev->dev,"Copy %lu from user failed\n" , + size); + ret = -EFAULT ; + goto fail_smbios_cmd; + } +if (priv->buf->length < priv->buffer_size) { +dev_err (&wdev->dev, +"Buffer %lld too small, need at least %d\n" , + priv->buf->length, priv->buffer_size); + ret = -EINVAL ; + goto fail_smbios_cmd; + }No checking for too big of a length? Any other fields you should check for validity? Like too small?
Quoted 1 line
Too big is actually intentionally ignored.
That seems "odd"...
Quoted 3 lines
I split the copy into two segments to check for this.
1. First copy the size of the structure
(if userspace didn't allocate at leastsizeof(struct wmi_smbios_buffer)that's aproblem)
Quoted 2 lines
2. Verify the size claimed is "at least" what we internally are looking for.
3. Copy the rest of the size internally needed. If userspace sent more it's just
Quoted 8 lines
not copied.
Quoted 1 line
4. When sending it back I only send back up to the "at least" internal size.
That feels strange, are you sure this is correct? Why the odd two step process here?
What if 'length' is set to an invalid value (too big or small), will you catch that correctly here?
Too small is definitely caught, too big won't cause problems due to above logic.
The remaining problem is if length doesn't really represent how much memory Userspace allocated. I'm not sure how you can actually check that.
Quoted 16 lines
Quoted 16 lines
Quoted 15 lines
drivers/platform/x86/dell-smbios-wmi.c int dell_smbios_wmi_call(struct calling_interface_buffer *buffer) · line 143
Quoted 9 lines
drivers/platform/x86/dell-smbios-wmi.c +8
-0+if (dell_smbios_call_filter (&wdev->dev, &priv->buf->std)) { +dev_err (&wdev->dev,"Invalid call %d/%d:%8x\n" , + priv->buf->std.class, priv->buf->std.select, + priv->buf->std.input[0 ]); + ret = -EFAULT ; + goto fail_smbios_cmd; + } + size = priv->buffer_size -sizeof (struct wmi_smbios_buffer );What if size just went too small and wrapped around? :(
Remember, "All input is evil". Go print that out and put it on the wall when you are designing this user/kernel api. You can trust no one, you have to validate _everything_.
Quoted 5 lines
Quoted 1 line
priv->buffer_sizecan't be set by userspace.Who sets it? Your structure naming here doesn't make it obvious which data is from the kernel and which from userspace, making this very hard to audit :(
It's set during the probe routine. I'll rename it to something more obvious. I'll also add some comments to the ioctl so it's more apparent.