| Message ID | 20220809025054.1626339-4-luke@ljones.dev (mailing list archive) |
|---|---|
| State | Changes Requested, archived |
| Headers | show |
| Series | asus-wmi: Add support for RGB keyboards | expand |
On Tue, Aug 9, 2022 at 4:51 AM Luke D. Jones <luke@ljones.dev> wrote: > > Adds support for setting various power states of TUF keyboards. > These states are combinations of: > - boot, set if a boot animation is shown on keyboard > - awake, set if the keyboard LEDs are visible while laptop is on > - sleep, set if an animation is displayed while the laptop is suspended > - keyboard (unknown effect) > > Adds two sysfs attributes to asus-nb-wmi: > - keyboard_rgb_state > - keyboard_rgb_state_index ... > until the keyboard_rgb_save attribute is set (write-only): > * 0 - slow > * 1 - medium > - * 2 - fast > \ No newline at end of file ^^^ > + * 2 - fast > + > +What: /sys/devices/platform/<platform>/keyboard_rgb_state > +Date: Aug 2022 > +KernelVersion: 6.1 > +Contact: "Luke Jones" <luke@ljones.dev> > +Description: > + Set some RGB keyboard power states (write-only). > + > + The accepted input is "boot awake sleep keyboard", where "n n n n n" > + options are: > + * save - 0 or 1, if 0 then settings are not retained on boot > + * boot - 0 or 1, controls if a boot animation is shown > + * awake - 0 or 1, controls if the keyboard LED are on during awake > + * sleep - 0 or 1, controls if a suspended animation is shown. > + This is only active if the AC is connected. > + * keyboard - 0 or 1, unknown what effect this really has > \ No newline at end of file ^^^ Be sure of not repeating the same mistake. I.e. add a newline as suggested. > + flags = 0; Seems you ignored my comment here... > + if (sscanf(buf, "%hhd %hhd %hhd %hhd %hhd", &save, &boot, &awake, &sleep, &keyboard) != 5 > + return -EINVAL; > + save = save == 0 ? 0x0100 : 0x0000; ...and here... > + if (boot) > + flags |= 0x02; > + if (awake) > + flags |= 0x08; > + if (sleep) > + flags |= 0x20; > + if (keyboard) > + flags |= 0x80; ...and here. ... > + err = asus_wmi_evaluate_method3(ASUS_WMI_METHODID_DEVS, > + ASUS_WMI_DEVID_TUF_RGB_STATE, 0xBD | save | (flags << 16), 0, &ret); > + if (err) > + return err; Also see another comment about how ret is supposed to be used.
Hi Andy, On Tue, Aug 9 2022 at 10:52:21 +0200, Andy Shevchenko <andy.shevchenko@gmail.com> wrote: > On Tue, Aug 9, 2022 at 4:51 AM Luke D. Jones <luke@ljones.dev> wrote: >> >> Adds support for setting various power states of TUF keyboards. >> These states are combinations of: >> - boot, set if a boot animation is shown on keyboard >> - awake, set if the keyboard LEDs are visible while laptop is on >> - sleep, set if an animation is displayed while the laptop is >> suspended >> - keyboard (unknown effect) >> >> Adds two sysfs attributes to asus-nb-wmi: >> - keyboard_rgb_state >> - keyboard_rgb_state_index > > ... > >> until the keyboard_rgb_save attribute is set >> (write-only): >> * 0 - slow >> * 1 - medium >> - * 2 - fast >> \ No newline at end of file > > ^^^ > >> + * 2 - fast >> + >> +What: /sys/devices/platform/<platform>/keyboard_rgb_state >> +Date: Aug 2022 >> +KernelVersion: 6.1 >> +Contact: "Luke Jones" <luke@ljones.dev> >> +Description: >> + Set some RGB keyboard power states (write-only). >> + >> + The accepted input is "boot awake sleep keyboard", >> where "n n n n n" >> + options are: >> + * save - 0 or 1, if 0 then settings are not >> retained on boot >> + * boot - 0 or 1, controls if a boot >> animation is shown >> + * awake - 0 or 1, controls if the keyboard >> LED are on during awake >> + * sleep - 0 or 1, controls if a suspended >> animation is shown. >> + This is only active >> if the AC is connected. >> + * keyboard - 0 or 1, unknown what effect >> this really has >> \ No newline at end of file > > ^^^ > > Be sure of not repeating the same mistake. I.e. add a newline as > suggested. > > >> + flags = 0; > > Seems you ignored my comment here... > >> + if (sscanf(buf, "%hhd %hhd %hhd %hhd %hhd", &save, &boot, >> &awake, &sleep, &keyboard) != 5 >> + return -EINVAL; > >> + save = save == 0 ? 0x0100 : 0x0000; > > ...and here... > >> + if (boot) >> + flags |= 0x02; >> + if (awake) >> + flags |= 0x08; >> + if (sleep) >> + flags |= 0x20; >> + if (keyboard) >> + flags |= 0x80; > > ...and here. > Umm... I know for sure I fixed all those. I must have screwed up a git rebase :( I'll fix again.
diff --git a/Documentation/ABI/testing/sysfs-platform-asus-wmi b/Documentation/ABI/testing/sysfs-platform-asus-wmi index a9128fa5cc65..3e3f2dcf9bfa 100644 --- a/Documentation/ABI/testing/sysfs-platform-asus-wmi +++ b/Documentation/ABI/testing/sysfs-platform-asus-wmi @@ -86,4 +86,20 @@ Description: until the keyboard_rgb_save attribute is set (write-only): * 0 - slow * 1 - medium - * 2 - fast \ No newline at end of file + * 2 - fast + +What: /sys/devices/platform/<platform>/keyboard_rgb_state +Date: Aug 2022 +KernelVersion: 6.1 +Contact: "Luke Jones" <luke@ljones.dev> +Description: + Set some RGB keyboard power states (write-only). + + The accepted input is "boot awake sleep keyboard", where "n n n n n" + options are: + * save - 0 or 1, if 0 then settings are not retained on boot + * boot - 0 or 1, controls if a boot animation is shown + * awake - 0 or 1, controls if the keyboard LED are on during awake + * sleep - 0 or 1, controls if a suspended animation is shown. + This is only active if the AC is connected. + * keyboard - 0 or 1, unknown what effect this really has \ No newline at end of file diff --git a/drivers/platform/x86/asus-wmi.c b/drivers/platform/x86/asus-wmi.c index fa0cc2895a66..719223804c0e 100644 --- a/drivers/platform/x86/asus-wmi.c +++ b/drivers/platform/x86/asus-wmi.c @@ -246,6 +246,7 @@ struct asus_wmi { bool dgpu_disable_available; bool dgpu_disable; + bool keyboard_rgb_state_available; bool keyboard_rgb_mode_available; struct keyboard_rgb_led keyboard_rgb_led; @@ -845,6 +846,66 @@ static ssize_t keyboard_rgb_speed_store(struct device *device, } static DEVICE_ATTR_WO(keyboard_rgb_speed); +/* TUF Laptop Keyboard RGB States *********************************************/ +static int keyboard_rgb_state_check_present(struct asus_wmi *asus) +{ + u32 result; + int err; + + asus->keyboard_rgb_state_available = false; + + err = asus_wmi_get_devstate(asus, ASUS_WMI_DEVID_TUF_RGB_STATE, &result); + if (err) { + if (err == -ENODEV) + return 0; + return err; + } + + if (result & ASUS_WMI_DSTS_PRESENCE_BIT) + asus->keyboard_rgb_state_available = true; + + return 0; +} + +static ssize_t keyboard_rgb_state_store(struct device *dev, + struct device_attribute *attr, + const char *buf, size_t count) +{ + u8 flags, save, boot, awake, sleep, keyboard; + int err; + u32 ret; + + flags = 0; + if (sscanf(buf, "%hhd %hhd %hhd %hhd %hhd", &save, &boot, &awake, &sleep, &keyboard) != 5) + return -EINVAL; + + save = save == 0 ? 0x0100 : 0x0000; + if (boot) + flags |= 0x02; + if (awake) + flags |= 0x08; + if (sleep) + flags |= 0x20; + if (keyboard) + flags |= 0x80; + + err = asus_wmi_evaluate_method3(ASUS_WMI_METHODID_DEVS, + ASUS_WMI_DEVID_TUF_RGB_STATE, 0xBD | save | (flags << 16), 0, &ret); + if (err) + return err; + + return count; +} +static DEVICE_ATTR_WO(keyboard_rgb_state); + +static ssize_t keyboard_rgb_state_index_show(struct device *device, + struct device_attribute *attr, + char *buf) +{ + return sysfs_emit(buf, "%s\n", "save boot awake sleep keyboard"); +} +static DEVICE_ATTR_RO(keyboard_rgb_state_index); + /* Battery ********************************************************************/ /* The battery maximum charging percentage */ @@ -3438,6 +3499,8 @@ static struct attribute *platform_attributes[] = { &dev_attr_keyboard_rgb_save.attr, &dev_attr_keyboard_rgb_mode.attr, &dev_attr_keyboard_rgb_speed.attr, + &dev_attr_keyboard_rgb_state.attr, + &dev_attr_keyboard_rgb_state_index.attr, &dev_attr_lid_resume.attr, &dev_attr_als_enable.attr, &dev_attr_fan_boost_mode.attr, @@ -3474,6 +3537,10 @@ static umode_t asus_sysfs_is_visible(struct kobject *kobj, ok = asus->keyboard_rgb_mode_available; else if (attr == &dev_attr_keyboard_rgb_speed.attr) ok = asus->keyboard_rgb_mode_available; + else if (attr == &dev_attr_keyboard_rgb_state.attr) + ok = asus->keyboard_rgb_state_available; + else if (attr == &dev_attr_keyboard_rgb_state_index.attr) + ok = asus->keyboard_rgb_state_available; else if (attr == &dev_attr_fan_boost_mode.attr) ok = asus->fan_boost_mode_available; else if (attr == &dev_attr_throttle_thermal_policy.attr) @@ -3747,6 +3814,10 @@ static int asus_wmi_add(struct platform_device *pdev) if (err) goto fail_keyboard_rgb_mode; + err = keyboard_rgb_state_check_present(asus); + if (err) + goto fail_keyboard_rgb_state; + err = fan_boost_mode_check_present(asus); if (err) goto fail_fan_boost_mode; @@ -3862,6 +3933,7 @@ static int asus_wmi_add(struct platform_device *pdev) fail_egpu_enable: fail_dgpu_disable: fail_keyboard_rgb_mode: +fail_keyboard_rgb_state: fail_platform: fail_panel_od: kfree(asus); diff --git a/include/linux/platform_data/x86/asus-wmi.h b/include/linux/platform_data/x86/asus-wmi.h index d63c9945a17d..b5c966798ef8 100644 --- a/include/linux/platform_data/x86/asus-wmi.h +++ b/include/linux/platform_data/x86/asus-wmi.h @@ -100,6 +100,8 @@ /* TUF laptop RGB control */ #define ASUS_WMI_DEVID_TUF_RGB_MODE 0x00100056 +/* TUF laptop RGB state control */ +#define ASUS_WMI_DEVID_TUF_RGB_STATE 0x00100057 /* DSTS masks */ #define ASUS_WMI_DSTS_STATUS_BIT 0x00000001
Adds support for setting various power states of TUF keyboards. These states are combinations of: - boot, set if a boot animation is shown on keyboard - awake, set if the keyboard LEDs are visible while laptop is on - sleep, set if an animation is displayed while the laptop is suspended - keyboard (unknown effect) Adds two sysfs attributes to asus-nb-wmi: - keyboard_rgb_state - keyboard_rgb_state_index Signed-off-by: Luke D. Jones <luke@ljones.dev> --- .../ABI/testing/sysfs-platform-asus-wmi | 18 ++++- drivers/platform/x86/asus-wmi.c | 72 +++++++++++++++++++ include/linux/platform_data/x86/asus-wmi.h | 2 + 3 files changed, 91 insertions(+), 1 deletion(-)