Hi,

On 2/11/21 9:17 PM, Maximilian Luz wrote:
> Add a driver to provide platform profile support on 5th- and later
> generation Microsoft Surface devices with a Surface System Aggregator
> Module. On those devices, the platform profile can be used to influence
> cooling behavior and power consumption.
> 
> For example, the default 'quiet' profile limits fan noise and in turn
> sacrifices performance of the discrete GPU found on Surface Books. Its
> full performance can only be unlocked on the 'performance' profile.
> 
> Signed-off-by: Maximilian Luz <[email protected]>

Thank you for your patch, I've applied this patch to my review-hans 
branch:
https://git.kernel.org/pub/scm/linux/kernel/git/pdx86/platform-drivers-x86.git/log/?h=review-hans

Note it will show up in my review-hans branch once I've pushed my
local branch there, which might take a while.

Once I've run some tests on this branch the patches there will be
added to the platform-drivers-x86/for-next branch and eventually
will be included in the pdx86 pull-request to Linus for the next
merge-window.

Regards,

Hans



> ---
>  MAINTAINERS                                   |   6 +
>  drivers/platform/surface/Kconfig              |  22 ++
>  drivers/platform/surface/Makefile             |   1 +
>  .../surface/surface_platform_profile.c        | 190 ++++++++++++++++++
>  4 files changed, 219 insertions(+)
>  create mode 100644 drivers/platform/surface/surface_platform_profile.c
> 
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 000a82f59c76..a08d65f8f0df 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -11811,6 +11811,12 @@ L:   [email protected]
>  S:   Maintained
>  F:   drivers/platform/surface/surface_hotplug.c
>  
> +MICROSOFT SURFACE PLATFORM PROFILE DRIVER
> +M:   Maximilian Luz <[email protected]>
> +L:   [email protected]
> +S:   Maintained
> +F:   drivers/platform/surface/surface_platform_profile.c
> +
>  MICROSOFT SURFACE PRO 3 BUTTON DRIVER
>  M:   Chen Yu <[email protected]>
>  L:   [email protected]
> diff --git a/drivers/platform/surface/Kconfig 
> b/drivers/platform/surface/Kconfig
> index 179b8c93d7fd..a045425026ae 100644
> --- a/drivers/platform/surface/Kconfig
> +++ b/drivers/platform/surface/Kconfig
> @@ -132,6 +132,28 @@ config SURFACE_HOTPLUG
>         Select M or Y here, if you want to (fully) support hot-plugging of
>         dGPU devices on the Surface Book 2 and/or 3 during D3cold.
>  
> +config SURFACE_PLATFORM_PROFILE
> +     tristate "Surface Platform Profile Driver"
> +     depends on SURFACE_AGGREGATOR_REGISTRY
> +     select ACPI_PLATFORM_PROFILE
> +     help
> +       Provides support for the ACPI platform profile on 5th- and later
> +       generation Microsoft Surface devices.
> +
> +       More specifically, this driver provides ACPI platform profile support
> +       on Microsoft Surface devices with a Surface System Aggregator Module
> +       (SSAM) connected via the Surface Serial Hub (SSH / SAM-over-SSH). In
> +       other words, this driver provides platform profile support on the
> +       Surface Pro 5, Surface Book 2, Surface Laptop, Surface Laptop Go and
> +       later. On those devices, the platform profile can significantly
> +       influence cooling behavior, e.g. setting it to 'quiet' (default) or
> +       'low-power' can significantly limit performance of the discrete GPU on
> +       Surface Books, while in turn leading to lower power consumption and/or
> +       less fan noise.
> +
> +       Select M or Y here, if you want to include ACPI platform profile
> +       support on the above mentioned devices.
> +
>  config SURFACE_PRO3_BUTTON
>       tristate "Power/home/volume buttons driver for Microsoft Surface Pro 
> 3/4 tablet"
>       depends on INPUT
> diff --git a/drivers/platform/surface/Makefile 
> b/drivers/platform/surface/Makefile
> index 80035ee540bf..99372c427b73 100644
> --- a/drivers/platform/surface/Makefile
> +++ b/drivers/platform/surface/Makefile
> @@ -13,4 +13,5 @@ obj-$(CONFIG_SURFACE_AGGREGATOR_CDEV)       += 
> surface_aggregator_cdev.o
>  obj-$(CONFIG_SURFACE_AGGREGATOR_REGISTRY) += surface_aggregator_registry.o
>  obj-$(CONFIG_SURFACE_GPE)            += surface_gpe.o
>  obj-$(CONFIG_SURFACE_HOTPLUG)                += surface_hotplug.o
> +obj-$(CONFIG_SURFACE_PLATFORM_PROFILE)       += surface_platform_profile.o
>  obj-$(CONFIG_SURFACE_PRO3_BUTTON)    += surfacepro3_button.o
> diff --git a/drivers/platform/surface/surface_platform_profile.c 
> b/drivers/platform/surface/surface_platform_profile.c
> new file mode 100644
> index 000000000000..0081b01a5b0f
> --- /dev/null
> +++ b/drivers/platform/surface/surface_platform_profile.c
> @@ -0,0 +1,190 @@
> +// SPDX-License-Identifier: GPL-2.0+
> +/*
> + * Surface Platform Profile / Performance Mode driver for Surface System
> + * Aggregator Module (thermal subsystem).
> + *
> + * Copyright (C) 2021 Maximilian Luz <[email protected]>
> + */
> +
> +#include <asm/unaligned.h>
> +#include <linux/kernel.h>
> +#include <linux/module.h>
> +#include <linux/platform_profile.h>
> +#include <linux/types.h>
> +
> +#include <linux/surface_aggregator/device.h>
> +
> +enum ssam_tmp_profile {
> +     SSAM_TMP_PROFILE_NORMAL             = 1,
> +     SSAM_TMP_PROFILE_BATTERY_SAVER      = 2,
> +     SSAM_TMP_PROFILE_BETTER_PERFORMANCE = 3,
> +     SSAM_TMP_PROFILE_BEST_PERFORMANCE   = 4,
> +};
> +
> +struct ssam_tmp_profile_info {
> +     __le32 profile;
> +     __le16 unknown1;
> +     __le16 unknown2;
> +} __packed;
> +
> +struct ssam_tmp_profile_device {
> +     struct ssam_device *sdev;
> +     struct platform_profile_handler handler;
> +};
> +
> +static SSAM_DEFINE_SYNC_REQUEST_CL_R(__ssam_tmp_profile_get, struct 
> ssam_tmp_profile_info, {
> +     .target_category = SSAM_SSH_TC_TMP,
> +     .command_id      = 0x02,
> +});
> +
> +static SSAM_DEFINE_SYNC_REQUEST_CL_W(__ssam_tmp_profile_set, __le32, {
> +     .target_category = SSAM_SSH_TC_TMP,
> +     .command_id      = 0x03,
> +});
> +
> +static int ssam_tmp_profile_get(struct ssam_device *sdev, enum 
> ssam_tmp_profile *p)
> +{
> +     struct ssam_tmp_profile_info info;
> +     int status;
> +
> +     status = ssam_retry(__ssam_tmp_profile_get, sdev, &info);
> +     if (status < 0)
> +             return status;
> +
> +     *p = le32_to_cpu(info.profile);
> +     return 0;
> +}
> +
> +static int ssam_tmp_profile_set(struct ssam_device *sdev, enum 
> ssam_tmp_profile p)
> +{
> +     __le32 profile_le = cpu_to_le32(p);
> +
> +     return ssam_retry(__ssam_tmp_profile_set, sdev, &profile_le);
> +}
> +
> +static int convert_ssam_to_profile(struct ssam_device *sdev, enum 
> ssam_tmp_profile p)
> +{
> +     switch (p) {
> +     case SSAM_TMP_PROFILE_NORMAL:
> +             return PLATFORM_PROFILE_BALANCED;
> +
> +     case SSAM_TMP_PROFILE_BATTERY_SAVER:
> +             return PLATFORM_PROFILE_LOW_POWER;
> +
> +     case SSAM_TMP_PROFILE_BETTER_PERFORMANCE:
> +             return PLATFORM_PROFILE_BALANCED_PERFORMANCE;
> +
> +     case SSAM_TMP_PROFILE_BEST_PERFORMANCE:
> +             return PLATFORM_PROFILE_PERFORMANCE;
> +
> +     default:
> +             dev_err(&sdev->dev, "invalid performance profile: %d", p);
> +             return -EINVAL;
> +     }
> +}
> +
> +static int convert_profile_to_ssam(struct ssam_device *sdev, enum 
> platform_profile_option p)
> +{
> +     switch (p) {
> +     case PLATFORM_PROFILE_LOW_POWER:
> +             return SSAM_TMP_PROFILE_BATTERY_SAVER;
> +
> +     case PLATFORM_PROFILE_BALANCED:
> +             return SSAM_TMP_PROFILE_NORMAL;
> +
> +     case PLATFORM_PROFILE_BALANCED_PERFORMANCE:
> +             return SSAM_TMP_PROFILE_BETTER_PERFORMANCE;
> +
> +     case PLATFORM_PROFILE_PERFORMANCE:
> +             return SSAM_TMP_PROFILE_BEST_PERFORMANCE;
> +
> +     default:
> +             /* This should have already been caught by 
> platform_profile_store(). */
> +             WARN(true, "unsupported platform profile");
> +             return -EOPNOTSUPP;
> +     }
> +}
> +
> +static int ssam_platform_profile_get(struct platform_profile_handler *pprof,
> +                                  enum platform_profile_option *profile)
> +{
> +     struct ssam_tmp_profile_device *tpd;
> +     enum ssam_tmp_profile tp;
> +     int status;
> +
> +     tpd = container_of(pprof, struct ssam_tmp_profile_device, handler);
> +
> +     status = ssam_tmp_profile_get(tpd->sdev, &tp);
> +     if (status)
> +             return status;
> +
> +     status = convert_ssam_to_profile(tpd->sdev, tp);
> +     if (status < 0)
> +             return status;
> +
> +     *profile = status;
> +     return 0;
> +}
> +
> +static int ssam_platform_profile_set(struct platform_profile_handler *pprof,
> +                                  enum platform_profile_option profile)
> +{
> +     struct ssam_tmp_profile_device *tpd;
> +     int tp;
> +
> +     tpd = container_of(pprof, struct ssam_tmp_profile_device, handler);
> +
> +     tp = convert_profile_to_ssam(tpd->sdev, profile);
> +     if (tp < 0)
> +             return tp;
> +
> +     return ssam_tmp_profile_set(tpd->sdev, tp);
> +}
> +
> +static int surface_platform_profile_probe(struct ssam_device *sdev)
> +{
> +     struct ssam_tmp_profile_device *tpd;
> +
> +     tpd = devm_kzalloc(&sdev->dev, sizeof(*tpd), GFP_KERNEL);
> +     if (!tpd)
> +             return -ENOMEM;
> +
> +     tpd->sdev = sdev;
> +
> +     tpd->handler.profile_get = ssam_platform_profile_get;
> +     tpd->handler.profile_set = ssam_platform_profile_set;
> +
> +     set_bit(PLATFORM_PROFILE_LOW_POWER, tpd->handler.choices);
> +     set_bit(PLATFORM_PROFILE_BALANCED, tpd->handler.choices);
> +     set_bit(PLATFORM_PROFILE_BALANCED_PERFORMANCE, tpd->handler.choices);
> +     set_bit(PLATFORM_PROFILE_PERFORMANCE, tpd->handler.choices);
> +
> +     platform_profile_register(&tpd->handler);
> +     return 0;
> +}
> +
> +static void surface_platform_profile_remove(struct ssam_device *sdev)
> +{
> +     platform_profile_remove();
> +}
> +
> +static const struct ssam_device_id ssam_platform_profile_match[] = {
> +     { SSAM_SDEV(TMP, 0x01, 0x00, 0x01) },
> +     { },
> +};
> +MODULE_DEVICE_TABLE(ssam, ssam_platform_profile_match);
> +
> +static struct ssam_device_driver surface_platform_profile = {
> +     .probe = surface_platform_profile_probe,
> +     .remove = surface_platform_profile_remove,
> +     .match_table = ssam_platform_profile_match,
> +     .driver = {
> +             .name = "surface_platform_profile",
> +             .probe_type = PROBE_PREFER_ASYNCHRONOUS,
> +     },
> +};
> +module_ssam_device_driver(surface_platform_profile);
> +
> +MODULE_AUTHOR("Maximilian Luz <[email protected]>");
> +MODULE_DESCRIPTION("Platform Profile Support for Surface System Aggregator 
> Module");
> +MODULE_LICENSE("GPL");
> 

Reply via email to