From:   Rishit Bansal <rishitbansal0@gmail.com>
To:     Hans de Goede <hdegoede@redhat.com>,
        Mark Gross <markgross@kernel.org>,
        linux-kernel@vger.kernel.org, platform-driver-x86@vger.kernel.org
Cc:     Rishit Bansal <rishitbansal0@gmail.com>
Subject: [PATCH V3] platform/x86: hp-wmi: Support omen backlight control wmi-acpi methods
Date:   Wed,  1 Feb 2023 05:20:27 +0530
Message-Id: <20230131235027.36304-1-rishitbansal0@gmail.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Precedence: bulk

The HP Omen Command Studio application includes a Light Studio feature
which can be used to control various features related to the keyboard
backlight via the 0x20009 command.

The command supports the following queries:

- 0x1: Checks if keyboard lighting is supported
- 0x2: Get the zone colors of each of the 4 zones on the keyboard
- 0x3: Set the zone colors of each of the 4 zones on the keyboard
- 0x4: Gets the state (on/off) of the backlight
- 0x5: Sets the state (on/off) of the backlight

This patch introduces a new sysfs led class called
"hp_omen::kbd_backlight" which can be used to control the state of the
backlight. It also includes a sysfs RW attribute at the following
location:

/sys/class/leds/hp_omen::kbd_backlight/zone_colors

This file contains the color codes for each of the 4 zones of the
keyboard. Each zone's color is represented by R,G and B components, each
of which take a byte. Therefore, the total size of this file is always:

4 (zones) * 3 (components R,G,B) = 12 bytes

An example output from this file is:

$ xxd /sys/class/leds/hp_omen\:\:kbd_backlight/zone_colors
00000000: 01ff 00ff 01ff ffff 01ff 0101            ............

The above output means that each zone has the following hex
color codes:
Zone 1: #01ff00
Zone 2: #ff01ff
Zone 3: #ffff01
Zone 4: #ff0101

Colors can be set on the backlight by writing back to this file by
passing 12 bytes in the exact same format as above.

Additionally this patch also maps the backlight event to the KEY_KBDILLUMTOGGLE
key so it shows the correct notification on userspace.

The patch has been tested on an HP Omen 15-en0037AX (AMD) laptop.

Signed-off-by: Rishit Bansal <rishitbansal0@gmail.com>
---
Changes since v1:
 - Map backlight key to KEY_KBDILLUMTOGGLE

Changes since v2:
 - Changes all str operations to memcpy() to handle null bytes edge
   cases
 - Renamed kbd_rgb to zone_colors, and moved it to inside the
   kbd_backlight directory
 - Added documentation for the zone_colors file
 - Removed KEY_KBDILLUMTOGGLE from the parse-map, and instead emitted
   directly
 - Remove logic to unregister from devm
 - Moved a few constants to #define
 - Updated path description with more details on zone_colors file format
---
 .../ABI/testing/sysfs-platform-hp-wmi         |  33 +++++
 drivers/platform/x86/hp/hp-wmi.c              | 116 ++++++++++++++++++
 2 files changed, 149 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-platform-hp-wmi

diff --git a/Documentation/ABI/testing/sysfs-platform-hp-wmi b/Documentation/ABI/testing/sysfs-platform-hp-wmi
new file mode 100644
index 000000000000..ccf2d29185ee
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-platform-hp-wmi
@@ -0,0 +1,33 @@
+What:		/sys/class/leds/hp_omen::kbd_backlight/zone_colors
+Date:		Feb 2023
+KernelVersion:	6.2
+Contact:	Rishit Bansal <rishitbansal0@gmail.com>
+Description:
+		This file stores the RGB color codes for each of
+		the 4 zones of the backlight on HP omen keyboards.
+
+		Each zone takes R,G,B values. The R,G,B values each can
+		range from 0-255. This means the whole state of the colors
+		can be represented in 12 bytes:
+
+		(4 zones * 3 color components (R,G,B) * 1 byte = 12 bytes)
+
+		Here is an example where we read the file:
+
+			xxd /sys/class/leds/hp_omen\:\:kbd_backlight/zone_colors
+			00000000: 01ff 00ff 01ff ffff 01ff 0101            ............
+
+		The above output means that each zone has the following hex
+		color codes:
+		Zone 1: #01ff00
+		Zone 2: #ff01ff
+		Zone 3: #ffff01
+		Zone 4: #ff0101
+
+		The colors of the each of the zones can be set by writing
+		the same format to this file. For example to set all zones
+		to white, we would do:
+
+			echo -n -e '\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff' | sudo tee /sys/class/leds/hp_omen\:\:kbd_backlight/zone_colors
+
+
diff --git a/drivers/platform/x86/hp/hp-wmi.c b/drivers/platform/x86/hp/hp-wmi.c
index 0a99058be813..f86cb7feaad4 100644
--- a/drivers/platform/x86/hp/hp-wmi.c
+++ b/drivers/platform/x86/hp/hp-wmi.c
@@ -27,6 +27,7 @@
 #include <linux/rfkill.h>
 #include <linux/string.h>
 #include <linux/dmi.h>
+#include <linux/leds.h>
 
 MODULE_AUTHOR("Matthew Garrett <mjg59@srcf.ucam.org>");
 MODULE_DESCRIPTION("HP laptop WMI hotkeys driver");
@@ -136,6 +137,7 @@ enum hp_wmi_command {
 	HPWMI_WRITE	= 0x02,
 	HPWMI_ODM	= 0x03,
 	HPWMI_GM	= 0x20008,
+	HPWMI_KB	= 0x20009,
 };
 
 enum hp_wmi_hardware_mask {
@@ -254,6 +256,9 @@ static const char * const tablet_chassis_types[] = {
 
 #define DEVICE_MODE_TABLET	0x06
 
+#define OMEN_ZONE_COLOR_OFFSET 0x19
+#define OMEN_ZONE_COLOR_LEN 0x0c
+
 /* map output size to the corresponding WMI method id */
 static inline int encode_outsize_for_pvsz(int outsize)
 {
@@ -734,12 +739,56 @@ static ssize_t postcode_store(struct device *dev, struct device_attribute *attr,
 	return count;
 }
 
+static ssize_t zone_colors_show(struct device *dev,
+				    struct device_attribute *attr, char *buf)
+{
+	u8 val[128];
+
+	int ret = hp_wmi_perform_query(HPWMI_HDDTEMP_QUERY, HPWMI_KB, &val,
+				       zero_if_sup(val), sizeof(val));
+
+	if (ret)
+		return ret;
+
+	memcpy(buf, &val[OMEN_ZONE_COLOR_OFFSET], OMEN_ZONE_COLOR_LEN);
+
+	return OMEN_ZONE_COLOR_LEN;
+}
+
+static ssize_t zone_colors_store(struct device *dev,
+				     struct device_attribute *attr,
+				     const char *buf, size_t count)
+{
+	u8 val[128];
+	int ret;
+
+	ret = hp_wmi_perform_query(HPWMI_HDDTEMP_QUERY, HPWMI_KB, &val,
+				   zero_if_sup(val), sizeof(val));
+
+	if (ret)
+		return ret;
+
+	if (count != OMEN_ZONE_COLOR_LEN)
+		return -1;
+
+	memcpy(&val[OMEN_ZONE_COLOR_OFFSET], buf, count);
+
+	ret = hp_wmi_perform_query(HPWMI_ALS_QUERY, HPWMI_KB, &val, sizeof(val),
+				   0);
+
+	if (ret)
+		return ret;
+
+	return OMEN_ZONE_COLOR_LEN;
+}
+
 static DEVICE_ATTR_RO(display);
 static DEVICE_ATTR_RO(hddtemp);
 static DEVICE_ATTR_RW(als);
 static DEVICE_ATTR_RO(dock);
 static DEVICE_ATTR_RO(tablet);
 static DEVICE_ATTR_RW(postcode);
+static DEVICE_ATTR_RW(zone_colors);
 
 static struct attribute *hp_wmi_attrs[] = {
 	&dev_attr_display.attr,
@@ -752,6 +801,12 @@ static struct attribute *hp_wmi_attrs[] = {
 };
 ATTRIBUTE_GROUPS(hp_wmi);
 
+static struct attribute *omen_kbd_led_attrs[] = {
+	&dev_attr_zone_colors.attr,
+	NULL,
+};
+ATTRIBUTE_GROUPS(omen_kbd_led);
+
 static void hp_wmi_notify(u32 value, void *context)
 {
 	struct acpi_buffer response = { ACPI_ALLOCATE_BUFFER, NULL };
@@ -853,6 +908,10 @@ static void hp_wmi_notify(u32 value, void *context)
 	case HPWMI_PROXIMITY_SENSOR:
 		break;
 	case HPWMI_BACKLIT_KB_BRIGHTNESS:
+		input_report_key(hp_wmi_input_dev, KEY_KBDILLUMTOGGLE, true);
+		input_sync(hp_wmi_input_dev);
+		input_report_key(hp_wmi_input_dev, KEY_KBDILLUMTOGGLE, false);
+		input_sync(hp_wmi_input_dev);
 		break;
 	case HPWMI_PEAKSHIFT_PERIOD:
 		break;
@@ -1294,6 +1353,60 @@ static int thermal_profile_setup(void)
 
 static int hp_wmi_hwmon_init(void);
 
+static enum led_brightness get_omen_backlight_brightness(struct led_classdev *cdev)
+{
+	u8 val;
+
+	int ret = hp_wmi_perform_query(HPWMI_HARDWARE_QUERY, HPWMI_KB, &val, zero_if_sup(val), sizeof(val));
+
+	if (ret)
+		return ret;
+
+	return (val & 0x80) ? LED_ON : LED_OFF;
+}
+
+static void set_omen_backlight_brightness(struct led_classdev *cdev, enum led_brightness value)
+{
+	char buffer[4] = { (value == LED_OFF) ? 0x64 : 0xe4, 0, 0, 0 };
+
+	hp_wmi_perform_query(HPWMI_WIRELESS_QUERY, HPWMI_KB, &buffer,
+				       sizeof(buffer), 0);
+}
+
+static struct led_classdev omen_kbd_led = {
+	.name = "hp_omen::kbd_backlight",
+	.brightness_set = set_omen_backlight_brightness,
+	.brightness_get = get_omen_backlight_brightness,
+	.max_brightness = 1,
+	.groups = omen_kbd_led_groups,
+};
+
+static bool is_omen_lighting_supported(void)
+{
+	u8 val;
+
+	int ret = hp_wmi_perform_query(HPWMI_DISPLAY_QUERY, HPWMI_KB, &val, zero_if_sup(val), sizeof(val));
+
+	if (ret)
+		return false;
+
+	return (val & 1) == 1;
+}
+
+static int omen_backlight_init(struct device *dev)
+{
+	int ret;
+
+	input_set_capability(hp_wmi_input_dev, KE_KEY, KEY_KBDILLUMTOGGLE);
+
+	ret = devm_led_classdev_register(dev, &omen_kbd_led);
+
+	if (ret < 0)
+		return -1;
+
+	return 0;
+}
+
 static int __init hp_wmi_bios_setup(struct platform_device *device)
 {
 	int err;
@@ -1321,6 +1434,9 @@ static int __init hp_wmi_bios_setup(struct platform_device *device)
 
 	thermal_profile_setup();
 
+	if (is_omen_lighting_supported())
+		omen_backlight_init(&device->dev);
+
 	return 0;
 }
 
-- 
2.37.2