1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  * lenovo-ymc.c - Lenovo Yoga Mode Control driver
4  *
5  * Copyright © 2022 Gergo Koteles <soyer@irl.hu>
6  */
7 
8 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
9 
10 #include <linux/acpi.h>
11 #include <linux/dmi.h>
12 #include <linux/input.h>
13 #include <linux/input/sparse-keymap.h>
14 #include <linux/wmi.h>
15 #include "ideapad-laptop.h"
16 
17 #define LENOVO_YMC_EVENT_GUID	"06129D99-6083-4164-81AD-F092F9D773A6"
18 #define LENOVO_YMC_QUERY_GUID	"09B0EE6E-C3FD-4243-8DA1-7911FF80BB8C"
19 
20 #define LENOVO_YMC_QUERY_INSTANCE 0
21 #define LENOVO_YMC_QUERY_METHOD 0x01
22 
23 static bool ec_trigger __read_mostly;
24 module_param(ec_trigger, bool, 0444);
25 MODULE_PARM_DESC(ec_trigger, "Enable EC triggering work-around to force emitting tablet mode events");
26 
27 static bool force;
28 module_param(force, bool, 0444);
29 MODULE_PARM_DESC(force, "Force loading on boards without a convertible DMI chassis-type");
30 
31 static const struct dmi_system_id ec_trigger_quirk_dmi_table[] = {
32 	{
33 		/* Lenovo Yoga 7 14ARB7 */
34 		.matches = {
35 			DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
36 			DMI_MATCH(DMI_PRODUCT_NAME, "82QF"),
37 		},
38 	},
39 	{
40 		/* Lenovo Yoga 7 14ACN6 */
41 		.matches = {
42 			DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
43 			DMI_MATCH(DMI_PRODUCT_NAME, "82N7"),
44 		},
45 	},
46 	{ }
47 };
48 
49 static const struct dmi_system_id allowed_chasis_types_dmi_table[] = {
50 	{
51 		.matches = {
52 			DMI_EXACT_MATCH(DMI_CHASSIS_TYPE, "31" /* Convertible */),
53 		},
54 	},
55 	{
56 		.matches = {
57 			DMI_EXACT_MATCH(DMI_CHASSIS_TYPE, "32" /* Detachable */),
58 		},
59 	},
60 	{ }
61 };
62 
63 struct lenovo_ymc_private {
64 	struct input_dev *input_dev;
65 	struct acpi_device *ec_acpi_dev;
66 };
67 
68 static void lenovo_ymc_trigger_ec(struct wmi_device *wdev, struct lenovo_ymc_private *priv)
69 {
70 	int err;
71 
72 	if (!priv->ec_acpi_dev)
73 		return;
74 
75 	err = write_ec_cmd(priv->ec_acpi_dev->handle, VPCCMD_W_YMC, 1);
76 	if (err)
77 		dev_warn(&wdev->dev, "Could not write YMC: %d\n", err);
78 }
79 
80 static const struct key_entry lenovo_ymc_keymap[] = {
81 	/* Ignore the uninitialized state */
82 	{ KE_IGNORE, 0x00 },
83 	/* Laptop */
84 	{ KE_SW, 0x01, { .sw = { SW_TABLET_MODE, 0 } } },
85 	/* Tablet */
86 	{ KE_SW, 0x02, { .sw = { SW_TABLET_MODE, 1 } } },
87 	/* Drawing Board */
88 	{ KE_SW, 0x03, { .sw = { SW_TABLET_MODE, 1 } } },
89 	/* Tent */
90 	{ KE_SW, 0x04, { .sw = { SW_TABLET_MODE, 1 } } },
91 	{ KE_END },
92 };
93 
94 static void lenovo_ymc_notify(struct wmi_device *wdev, union acpi_object *data)
95 {
96 	struct lenovo_ymc_private *priv = dev_get_drvdata(&wdev->dev);
97 	u32 input_val = 0;
98 	struct acpi_buffer input = { sizeof(input_val), &input_val };
99 	struct acpi_buffer output = { ACPI_ALLOCATE_BUFFER, NULL };
100 	union acpi_object *obj;
101 	acpi_status status;
102 	int code;
103 
104 	status = wmi_evaluate_method(LENOVO_YMC_QUERY_GUID,
105 				LENOVO_YMC_QUERY_INSTANCE,
106 				LENOVO_YMC_QUERY_METHOD,
107 				&input, &output);
108 
109 	if (ACPI_FAILURE(status)) {
110 		dev_warn(&wdev->dev,
111 			"Failed to evaluate query method: %s\n",
112 			acpi_format_exception(status));
113 		return;
114 	}
115 
116 	obj = output.pointer;
117 
118 	if (obj->type != ACPI_TYPE_INTEGER) {
119 		dev_warn(&wdev->dev,
120 			"WMI event data is not an integer\n");
121 		goto free_obj;
122 	}
123 	code = obj->integer.value;
124 
125 	if (!sparse_keymap_report_event(priv->input_dev, code, 1, true))
126 		dev_warn(&wdev->dev, "Unknown key %d pressed\n", code);
127 
128 free_obj:
129 	kfree(obj);
130 	lenovo_ymc_trigger_ec(wdev, priv);
131 }
132 
133 static void acpi_dev_put_helper(void *p) { acpi_dev_put(p); }
134 
135 static int lenovo_ymc_probe(struct wmi_device *wdev, const void *ctx)
136 {
137 	struct lenovo_ymc_private *priv;
138 	struct input_dev *input_dev;
139 	int err;
140 
141 	if (!dmi_check_system(allowed_chasis_types_dmi_table)) {
142 		if (force)
143 			dev_info(&wdev->dev, "Force loading Lenovo YMC support\n");
144 		else
145 			return -ENODEV;
146 	}
147 
148 	ec_trigger |= dmi_check_system(ec_trigger_quirk_dmi_table);
149 
150 	priv = devm_kzalloc(&wdev->dev, sizeof(*priv), GFP_KERNEL);
151 	if (!priv)
152 		return -ENOMEM;
153 
154 	if (ec_trigger) {
155 		pr_debug("Lenovo YMC enable EC triggering.\n");
156 		priv->ec_acpi_dev = acpi_dev_get_first_match_dev("VPC2004", NULL, -1);
157 
158 		if (!priv->ec_acpi_dev) {
159 			dev_err(&wdev->dev, "Could not find EC ACPI device.\n");
160 			return -ENODEV;
161 		}
162 		err = devm_add_action_or_reset(&wdev->dev,
163 				acpi_dev_put_helper, priv->ec_acpi_dev);
164 		if (err) {
165 			dev_err(&wdev->dev,
166 				"Could not clean up EC ACPI device: %d\n", err);
167 			return err;
168 		}
169 	}
170 
171 	input_dev = devm_input_allocate_device(&wdev->dev);
172 	if (!input_dev)
173 		return -ENOMEM;
174 
175 	input_dev->name = "Lenovo Yoga Tablet Mode Control switch";
176 	input_dev->phys = LENOVO_YMC_EVENT_GUID "/input0";
177 	input_dev->id.bustype = BUS_HOST;
178 	input_dev->dev.parent = &wdev->dev;
179 	err = sparse_keymap_setup(input_dev, lenovo_ymc_keymap, NULL);
180 	if (err) {
181 		dev_err(&wdev->dev,
182 			"Could not set up input device keymap: %d\n", err);
183 		return err;
184 	}
185 
186 	err = input_register_device(input_dev);
187 	if (err) {
188 		dev_err(&wdev->dev,
189 			"Could not register input device: %d\n", err);
190 		return err;
191 	}
192 
193 	priv->input_dev = input_dev;
194 	dev_set_drvdata(&wdev->dev, priv);
195 
196 	/* Report the state for the first time on probe */
197 	lenovo_ymc_trigger_ec(wdev, priv);
198 	lenovo_ymc_notify(wdev, NULL);
199 	return 0;
200 }
201 
202 static const struct wmi_device_id lenovo_ymc_wmi_id_table[] = {
203 	{ .guid_string = LENOVO_YMC_EVENT_GUID },
204 	{ }
205 };
206 MODULE_DEVICE_TABLE(wmi, lenovo_ymc_wmi_id_table);
207 
208 static struct wmi_driver lenovo_ymc_driver = {
209 	.driver = {
210 		.name = "lenovo-ymc",
211 	},
212 	.id_table = lenovo_ymc_wmi_id_table,
213 	.probe = lenovo_ymc_probe,
214 	.notify = lenovo_ymc_notify,
215 };
216 
217 module_wmi_driver(lenovo_ymc_driver);
218 
219 MODULE_AUTHOR("Gergo Koteles <soyer@irl.hu>");
220 MODULE_DESCRIPTION("Lenovo Yoga Mode Control driver");
221 MODULE_LICENSE("GPL");
222