On Tue, 29 Oct 2024, Kurt Borja wrote: > Implements platform profile support for Dell laptops with new WMAX thermal > interface, present on some Alienware X-Series, Alienware M-Series and > Dell's G-Series laptops. This interface is suspected to be used by > Alienware Command Center (AWCC), which is not available for linux > systems, to manage thermal profiles. > > This implementation makes use of three WMI methods, namely > THERMAL_CONTROL, THERMAL_INFORMATION and GAME_SHIFT_STATUS, which take > u32 as input and output arguments. Each method has a set of supported > operations specified in their respective enums. > > Not all models with WMAX WMI interface support these methods. Because of > this, models have to manually declare support through new quirks > `thermal` for THERMAL_CONTROL and THERMAL_INFORMATION and `gmode` for > GAME_SHIFT_STATUS. > > Wrappers written for these methods support multiple operations. > > THERMAL_CONTROL switches thermal modes through operation > ACTIVATE_PROFILE. Available thermal codes are auto-detected at runtime > and matched against a list of known thermal codes: > > Thermal Table "User Selectable Thermal Tables" (USTT): > BALANCED 0xA0 > BALANCED_PERFORMANCE 0xA1 > COOL 0xA2 > QUIET 0xA3 > PERFORMANCE 0xA4 > LOW_POWER 0xA5 > > Thermal Table Basic: > QUIET 0x96 > BALANCED 0x97 > BALANCED_PERFORMANCE 0x98 > PERFORMANCE 0x99 > > Devices are known to implement only one of these tables without mixing > their thermal codes. > > The fact that the least significant digit of every thermal code is > consecutive of one another is exploited to efficiently match codes > through arrays. > > Autodetection of available codes is done through operation LIST_IDS of > method THERMAL_INFORMATION. This operation lists fan IDs, CPU sensor ID, > GPU sensor ID and available thermal profile codes, *in that order*. As > number of fans and thermal codes is very model dependent, almost every > ID is scanned and matched based on conditions found on > is_wmax_thermal_code(). The known upper bound for the number of IDs is > 13, corresponding to a device that have 4 fans, 2 sensors and 7 thermal > codes. > > Additionally G-Series laptops have a key called G-key, which (with AWCC > proprietary driver) switches the thermal mode to an special mode named > GMODE with code 0xAB and changes Game Shift Status to 1. Game Shift is a > mode the manufacturer claims, increases gaming performance. > > GAME_SHIFT_STATUS method is used to mimic this behavior when selecting > PLATFORM_PROFILE_PERFORMANCE option. > > All of these profiles are known to only change fan speed profiles, > although there are untested claims that some of them also change power > profiles. > > Activating a thermal mode with method THERMAL_CONTROL may cause short > hangs. This is a known problem present on every platform. > > Signed-off-by: Kurt Borja <kuurtb@xxxxxxxxx> > Reviewed-by: Ilpo Järvinen <ilpo.jarvinen@xxxxxxxxxxxxxxx> > --- > v10: > - Corrected THERMAL_MODE_BASIC_BALANCED -> THERMAL_MODE_BASIC_QUIET in > is_wmax_thermal_code() logic > - `thermal` and `gmode` quirks now have to be manually selected, > because not all Dell devices posses the new WMI thermal methods. > - Because of the above reason, errors in create_thermal_profile are now > propagated > v9: > - Bool comparisons are now coherent with their type > v8: > - Fixed alignment in wmax_mode_to_platform_profile[] > - Quirk thermal and gmode changed from u8 -> bool > - Autodetected quirk entries are not initialized > - is_wmax_thermal_code refactored to increase readibility > - is_wmax_thermal_code now covers all possibilities > - Better commit message > v7: > - Method operations are now clearly listed as separate enums > - wmax_thermal_modes are now listed without codes in order to support > autodetection, as well as getting and setting thermal profiles > cleanly through arrays > - Added wmax_mode_to_platform_profile[] > - Added struct wmax_u32_args to replace bit mask approach of > constructing arguments for wmax methods > - create_thermal_profile now autodetects available thermal codes > through operation 0x03 of THERMAL_INFORMATION method. These are > codes are stored in supported_thermal_profiles[] > - thermal_profile_get now uses wmax_mode_to_platform_profile[] instead of > switch-case approach > - thermal_profile_set now uses supported_thermal_profiles[] instead of > switch-case approach > - When gmode is autodetected, thermal_profile_set also sets Game Shift > status accordingly > v6: > - Fixed alignment on some function definitions > - Fixed braces on if statment > - Removed quirk thermal_ustt > - Now quirk thermal can take values defined in enum WMAX_THERMAL_TABLE. > - Proper removal of thermal_profile > --- > drivers/platform/x86/dell/Kconfig | 1 + > drivers/platform/x86/dell/alienware-wmi.c | 306 ++++++++++++++++++++++ > 2 files changed, 307 insertions(+) > > diff --git a/drivers/platform/x86/dell/Kconfig b/drivers/platform/x86/dell/Kconfig > index 68a49788a..b06d634cd 100644 > --- a/drivers/platform/x86/dell/Kconfig > +++ b/drivers/platform/x86/dell/Kconfig > @@ -21,6 +21,7 @@ config ALIENWARE_WMI > depends on LEDS_CLASS > depends on NEW_LEDS > depends on ACPI_WMI > + select ACPI_PLATFORM_PROFILE > help > This is a driver for controlling Alienware BIOS driven > features. It exposes an interface for controlling the AlienFX > diff --git a/drivers/platform/x86/dell/alienware-wmi.c b/drivers/platform/x86/dell/alienware-wmi.c > index b27f3b64c..1d62c2ce7 100644 > --- a/drivers/platform/x86/dell/alienware-wmi.c > +++ b/drivers/platform/x86/dell/alienware-wmi.c > @@ -8,8 +8,11 @@ > #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt > > #include <linux/acpi.h> > +#include <linux/bitfield.h> > +#include <linux/bits.h> > #include <linux/module.h> > #include <linux/platform_device.h> > +#include <linux/platform_profile.h> > #include <linux/dmi.h> > #include <linux/leds.h> > > @@ -25,6 +28,13 @@ > #define WMAX_METHOD_AMPLIFIER_CABLE 0x6 > #define WMAX_METHOD_DEEP_SLEEP_CONTROL 0x0B > #define WMAX_METHOD_DEEP_SLEEP_STATUS 0x0C > +#define WMAX_METHOD_THERMAL_INFORMATION 0x14 > +#define WMAX_METHOD_THERMAL_CONTROL 0x15 > +#define WMAX_METHOD_GAME_SHIFT_STATUS 0x25 > + > +#define WMAX_THERMAL_MODE_GMODE 0xAB > + > +#define WMAX_FAILURE_CODE 0xFFFFFFFF > > MODULE_AUTHOR("Mario Limonciello <mario.limonciello@xxxxxxxxxxx>"); > MODULE_DESCRIPTION("Alienware special feature control"); > @@ -49,11 +59,59 @@ enum WMAX_CONTROL_STATES { > WMAX_SUSPEND = 3, > }; > > +enum WMAX_THERMAL_INFORMATION_OPERATIONS { > + WMAX_OPERATION_LIST_IDS = 0x03, > + WMAX_OPERATION_CURRENT_PROFILE = 0x0B, > +}; > + > +enum WMAX_THERMAL_CONTROL_OPERATIONS { > + WMAX_OPERATION_ACTIVATE_PROFILE = 0x01, > +}; > + > +enum WMAX_GAME_SHIFT_STATUS_OPERATIONS { > + WMAX_OPERATION_TOGGLE_GAME_SHIFT = 0x01, > + WMAX_OPERATION_GET_GAME_SHIFT_STATUS = 0x02, > +}; > + > +enum WMAX_THERMAL_TABLES { > + WMAX_THERMAL_TABLE_BASIC = 0x90, > + WMAX_THERMAL_TABLE_USTT = 0xA0, > +}; > + > +enum wmax_thermal_mode { > + THERMAL_MODE_USTT_BALANCED, > + THERMAL_MODE_USTT_BALANCED_PERFORMANCE, > + THERMAL_MODE_USTT_COOL, > + THERMAL_MODE_USTT_QUIET, > + THERMAL_MODE_USTT_PERFORMANCE, > + THERMAL_MODE_USTT_LOW_POWER, > + THERMAL_MODE_BASIC_QUIET, > + THERMAL_MODE_BASIC_BALANCED, > + THERMAL_MODE_BASIC_BALANCED_PERFORMANCE, > + THERMAL_MODE_BASIC_PERFORMANCE, > + THERMAL_MODE_LAST, > +}; > + > +static const enum platform_profile_option wmax_mode_to_platform_profile[THERMAL_MODE_LAST] = { > + [THERMAL_MODE_USTT_BALANCED] = PLATFORM_PROFILE_BALANCED, > + [THERMAL_MODE_USTT_BALANCED_PERFORMANCE] = PLATFORM_PROFILE_BALANCED_PERFORMANCE, > + [THERMAL_MODE_USTT_COOL] = PLATFORM_PROFILE_COOL, > + [THERMAL_MODE_USTT_QUIET] = PLATFORM_PROFILE_QUIET, > + [THERMAL_MODE_USTT_PERFORMANCE] = PLATFORM_PROFILE_PERFORMANCE, > + [THERMAL_MODE_USTT_LOW_POWER] = PLATFORM_PROFILE_LOW_POWER, > + [THERMAL_MODE_BASIC_QUIET] = PLATFORM_PROFILE_QUIET, > + [THERMAL_MODE_BASIC_BALANCED] = PLATFORM_PROFILE_BALANCED, > + [THERMAL_MODE_BASIC_BALANCED_PERFORMANCE] = PLATFORM_PROFILE_BALANCED_PERFORMANCE, > + [THERMAL_MODE_BASIC_PERFORMANCE] = PLATFORM_PROFILE_PERFORMANCE, > +}; > + > struct quirk_entry { > u8 num_zones; > u8 hdmi_mux; > u8 amplifier; > u8 deepslp; > + bool thermal; > + bool gmode; > }; > > static struct quirk_entry *quirks; > @@ -64,6 +122,8 @@ static struct quirk_entry quirk_inspiron5675 = { > .hdmi_mux = 0, > .amplifier = 0, > .deepslp = 0, > + .thermal = false, > + .gmode = false, > }; > > static struct quirk_entry quirk_unknown = { > @@ -71,6 +131,8 @@ static struct quirk_entry quirk_unknown = { > .hdmi_mux = 0, > .amplifier = 0, > .deepslp = 0, > + .thermal = false, > + .gmode = false, > }; > > static struct quirk_entry quirk_x51_r1_r2 = { > @@ -78,6 +140,8 @@ static struct quirk_entry quirk_x51_r1_r2 = { > .hdmi_mux = 0, > .amplifier = 0, > .deepslp = 0, > + .thermal = false, > + .gmode = false, > }; > > static struct quirk_entry quirk_x51_r3 = { > @@ -85,6 +149,8 @@ static struct quirk_entry quirk_x51_r3 = { > .hdmi_mux = 0, > .amplifier = 1, > .deepslp = 0, > + .thermal = false, > + .gmode = false, > }; > > static struct quirk_entry quirk_asm100 = { > @@ -92,6 +158,8 @@ static struct quirk_entry quirk_asm100 = { > .hdmi_mux = 1, > .amplifier = 0, > .deepslp = 0, > + .thermal = false, > + .gmode = false, > }; > > static struct quirk_entry quirk_asm200 = { > @@ -99,6 +167,8 @@ static struct quirk_entry quirk_asm200 = { > .hdmi_mux = 1, > .amplifier = 0, > .deepslp = 1, > + .thermal = false, > + .gmode = false, > }; > > static struct quirk_entry quirk_asm201 = { > @@ -106,6 +176,17 @@ static struct quirk_entry quirk_asm201 = { > .hdmi_mux = 1, > .amplifier = 1, > .deepslp = 1, > + .thermal = false, > + .gmode = false, > +}; > + > +static struct quirk_entry quirk_x_series = { > + .num_zones = 2, > + .hdmi_mux = 0, > + .amplifier = 0, > + .deepslp = 0, > + .thermal = true, > + .gmode = false, > }; So now gmode is always false unless the module parameter from patch 4 is given? -- i. > static int __init dmi_matched(const struct dmi_system_id *dmi) > @@ -178,6 +259,15 @@ static const struct dmi_system_id alienware_quirks[] __initconst = { > }, > .driver_data = &quirk_inspiron5675, > }, > + { > + .callback = dmi_matched, > + .ident = "Alienware x15 R1", > + .matches = { > + DMI_MATCH(DMI_SYS_VENDOR, "Alienware"), > + DMI_MATCH(DMI_PRODUCT_NAME, "Alienware x15 R1"), > + }, > + .driver_data = &quirk_x_series, > + }, > {} > }; > > @@ -214,10 +304,19 @@ struct wmax_led_args { > u8 state; > } __packed; > > +struct wmax_u32_args { > + u8 operation; > + u8 arg1; > + u8 arg2; > + u8 arg3; > +}; > + > static struct platform_device *platform_device; > static struct device_attribute *zone_dev_attrs; > static struct attribute **zone_attrs; > static struct platform_zone *zone_data; > +static struct platform_profile_handler pp_handler; > +static enum wmax_thermal_mode supported_thermal_profiles[PLATFORM_PROFILE_LAST]; > > static struct platform_driver platform_driver = { > .driver = { > @@ -761,6 +860,204 @@ static int create_deepsleep(struct platform_device *dev) > return ret; > } > > +/* > + * Thermal Profile control > + * - Provides thermal profile control through the Platform Profile API > + */ > +#define WMAX_THERMAL_TABLE_MASK GENMASK(7, 4) > +#define WMAX_THERMAL_MODE_MASK GENMASK(3, 0) > +#define WMAX_SENSOR_ID_MASK BIT(8) > + > +static bool is_wmax_thermal_code(u32 code) > +{ > + if (code & WMAX_SENSOR_ID_MASK) > + return false; > + > + if ((code & WMAX_THERMAL_MODE_MASK) >= THERMAL_MODE_LAST) > + return false; > + > + if ((code & WMAX_THERMAL_TABLE_MASK) == WMAX_THERMAL_TABLE_BASIC && > + (code & WMAX_THERMAL_MODE_MASK) >= THERMAL_MODE_BASIC_QUIET) > + return true; > + > + if ((code & WMAX_THERMAL_TABLE_MASK) == WMAX_THERMAL_TABLE_USTT && > + (code & WMAX_THERMAL_MODE_MASK) <= THERMAL_MODE_USTT_LOW_POWER) > + return true; > + > + return false; > +} > + > +static int wmax_thermal_information(u8 operation, u8 arg, u32 *out_data) > +{ > + acpi_status status; > + struct wmax_u32_args in_args = { > + .operation = operation, > + .arg1 = arg, > + .arg2 = 0, > + .arg3 = 0, > + }; > + > + status = alienware_wmax_command(&in_args, sizeof(in_args), > + WMAX_METHOD_THERMAL_INFORMATION, > + out_data); > + > + if (ACPI_FAILURE(status)) > + return -EIO; > + > + if (*out_data == WMAX_FAILURE_CODE) > + return -EBADRQC; > + > + return 0; > +} > + > +static int wmax_thermal_control(u8 profile) > +{ > + acpi_status status; > + struct wmax_u32_args in_args = { > + .operation = WMAX_OPERATION_ACTIVATE_PROFILE, > + .arg1 = profile, > + .arg2 = 0, > + .arg3 = 0, > + }; > + u32 out_data; > + > + status = alienware_wmax_command(&in_args, sizeof(in_args), > + WMAX_METHOD_THERMAL_CONTROL, > + &out_data); > + > + if (ACPI_FAILURE(status)) > + return -EIO; > + > + if (out_data == WMAX_FAILURE_CODE) > + return -EBADRQC; > + > + return 0; > +} > + > +static int wmax_game_shift_status(u8 operation, u32 *out_data) > +{ > + acpi_status status; > + struct wmax_u32_args in_args = { > + .operation = operation, > + .arg1 = 0, > + .arg2 = 0, > + .arg3 = 0, > + }; > + > + status = alienware_wmax_command(&in_args, sizeof(in_args), > + WMAX_METHOD_GAME_SHIFT_STATUS, > + out_data); > + > + if (ACPI_FAILURE(status)) > + return -EIO; > + > + if (*out_data == WMAX_FAILURE_CODE) > + return -EOPNOTSUPP; > + > + return 0; > +} > + > +static int thermal_profile_get(struct platform_profile_handler *pprof, > + enum platform_profile_option *profile) > +{ > + u32 out_data; > + int ret; > + > + ret = wmax_thermal_information(WMAX_OPERATION_CURRENT_PROFILE, > + 0, &out_data); > + > + if (ret < 0) > + return ret; > + > + if (out_data == WMAX_THERMAL_MODE_GMODE) { > + *profile = PLATFORM_PROFILE_PERFORMANCE; > + return 0; > + } > + > + if (!is_wmax_thermal_code(out_data)) > + return -ENODATA; > + > + out_data &= WMAX_THERMAL_MODE_MASK; > + *profile = wmax_mode_to_platform_profile[out_data]; > + > + return 0; > +} > + > +static int thermal_profile_set(struct platform_profile_handler *pprof, > + enum platform_profile_option profile) > +{ > + if (quirks->gmode) { > + u32 gmode_status; > + int ret; > + > + ret = wmax_game_shift_status(WMAX_OPERATION_GET_GAME_SHIFT_STATUS, > + &gmode_status); > + > + if (ret < 0) > + return ret; > + > + if ((profile == PLATFORM_PROFILE_PERFORMANCE && !gmode_status) || > + (profile != PLATFORM_PROFILE_PERFORMANCE && gmode_status)) { > + ret = wmax_game_shift_status(WMAX_OPERATION_TOGGLE_GAME_SHIFT, > + &gmode_status); > + > + if (ret < 0) > + return ret; > + } > + } > + > + return wmax_thermal_control(supported_thermal_profiles[profile]); > +} > + > +static int create_thermal_profile(void) > +{ > + u32 out_data; > + enum wmax_thermal_mode mode; > + enum platform_profile_option profile; > + int ret; > + > + for (u8 i = 0x2; i <= 0xD; i++) { > + ret = wmax_thermal_information(WMAX_OPERATION_LIST_IDS, > + i, &out_data); > + > + if (ret == -EIO) > + return ret; > + > + if (ret == -EBADRQC) > + break; > + > + if (!is_wmax_thermal_code(out_data)) > + continue; > + > + mode = out_data & WMAX_THERMAL_MODE_MASK; > + profile = wmax_mode_to_platform_profile[mode]; > + supported_thermal_profiles[profile] = out_data; > + > + set_bit(profile, pp_handler.choices); > + } > + > + if (bitmap_empty(pp_handler.choices, PLATFORM_PROFILE_LAST)) > + return -ENODEV; > + > + if (quirks->gmode) { > + supported_thermal_profiles[PLATFORM_PROFILE_PERFORMANCE] = > + WMAX_THERMAL_MODE_GMODE; > + > + set_bit(PLATFORM_PROFILE_PERFORMANCE, pp_handler.choices); > + } > + > + pp_handler.profile_get = thermal_profile_get; > + pp_handler.profile_set = thermal_profile_set; > + > + return platform_profile_register(&pp_handler); > +} > + > +static void remove_thermal_profile(void) > +{ > + if (quirks->thermal) > + platform_profile_remove(); > +} > + > static int __init alienware_wmi_init(void) > { > int ret; > @@ -808,6 +1105,12 @@ static int __init alienware_wmi_init(void) > goto fail_prep_deepsleep; > } > > + if (quirks->thermal) { > + ret = create_thermal_profile(); > + if (ret) > + goto fail_prep_thermal_profile; > + } > + > ret = alienware_zone_init(platform_device); > if (ret) > goto fail_prep_zones; > @@ -816,6 +1119,8 @@ static int __init alienware_wmi_init(void) > > fail_prep_zones: > alienware_zone_exit(platform_device); > + remove_thermal_profile(); > +fail_prep_thermal_profile: > fail_prep_deepsleep: > fail_prep_amplifier: > fail_prep_hdmi: > @@ -835,6 +1140,7 @@ static void __exit alienware_wmi_exit(void) > if (platform_device) { > alienware_zone_exit(platform_device); > remove_hdmi(platform_device); > + remove_thermal_profile(); > platform_device_unregister(platform_device); > platform_driver_unregister(&platform_driver); > } >