1 // SPDX-License-Identifier: GPL-2.0+
3 * Platform driver for OneXPlayer, AOK ZOE, and Aya Neo Handhelds that expose
4 * fan reading and control via hwmon sysfs.
6 * Old OXP boards have the same DMI strings and they are told apart by
7 * the boot cpu vendor (Intel/AMD). Currently only AMD boards are
8 * supported but the code is made to be simple to add other handheld
9 * boards in the future.
10 * Fan control is provided via pwm interface in the range [0-255].
11 * Old AMD boards use [0-100] as range in the EC, the written value is
12 * scaled to accommodate for that. Newer boards like the mini PRO and
13 * AOK ZOE are not scaled but have the same EC layout.
15 * Copyright (C) 2022 Joaquín I. Aramendía <samsagax@gmail.com>
18 #include <linux/acpi.h>
19 #include <linux/dmi.h>
20 #include <linux/hwmon.h>
21 #include <linux/init.h>
22 #include <linux/kernel.h>
23 #include <linux/module.h>
24 #include <linux/platform_device.h>
25 #include <linux/processor.h>
27 /* Handle ACPI lock mechanism */
30 #define ACPI_LOCK_DELAY_MS 500
32 static bool lock_global_acpi_lock(void)
34 return ACPI_SUCCESS(acpi_acquire_global_lock(ACPI_LOCK_DELAY_MS, &oxp_mutex));
37 static bool unlock_global_acpi_lock(void)
39 return ACPI_SUCCESS(acpi_release_global_lock(oxp_mutex));
53 static enum oxp_board board;
55 /* Fan reading and PWM */
56 #define OXP_SENSOR_FAN_REG 0x76 /* Fan reading is 2 registers long */
57 #define OXP_SENSOR_PWM_ENABLE_REG 0x4A /* PWM enable is 1 register long */
58 #define OXP_SENSOR_PWM_REG 0x4B /* PWM reading is 1 register long */
60 /* Turbo button takeover function
61 * Older boards have different values and EC registers
62 * for the same function
64 #define OXP_OLD_TURBO_SWITCH_REG 0x1E
65 #define OXP_OLD_TURBO_TAKE_VAL 0x01
66 #define OXP_OLD_TURBO_RETURN_VAL 0x00
68 #define OXP_TURBO_SWITCH_REG 0xF1
69 #define OXP_TURBO_TAKE_VAL 0x40
70 #define OXP_TURBO_RETURN_VAL 0x00
72 static const struct dmi_system_id dmi_table[] = {
75 DMI_MATCH(DMI_BOARD_VENDOR, "AOKZOE"),
76 DMI_EXACT_MATCH(DMI_BOARD_NAME, "AOKZOE A1 AR07"),
78 .driver_data = (void *)aok_zoe_a1,
82 DMI_MATCH(DMI_BOARD_VENDOR, "AOKZOE"),
83 DMI_EXACT_MATCH(DMI_BOARD_NAME, "AOKZOE A1 Pro"),
85 .driver_data = (void *)aok_zoe_a1,
89 DMI_MATCH(DMI_BOARD_VENDOR, "AYANEO"),
90 DMI_EXACT_MATCH(DMI_BOARD_NAME, "AYANEO 2"),
92 .driver_data = (void *)aya_neo_2,
96 DMI_MATCH(DMI_BOARD_VENDOR, "AYANEO"),
97 DMI_EXACT_MATCH(DMI_BOARD_NAME, "AIR"),
99 .driver_data = (void *)aya_neo_air,
103 DMI_MATCH(DMI_BOARD_VENDOR, "AYANEO"),
104 DMI_EXACT_MATCH(DMI_BOARD_NAME, "AIR Pro"),
106 .driver_data = (void *)aya_neo_air_pro,
110 DMI_MATCH(DMI_BOARD_VENDOR, "AYANEO"),
111 DMI_EXACT_MATCH(DMI_BOARD_NAME, "GEEK"),
113 .driver_data = (void *)aya_neo_geek,
117 DMI_MATCH(DMI_BOARD_VENDOR, "ONE-NETBOOK"),
118 DMI_EXACT_MATCH(DMI_BOARD_NAME, "ONE XPLAYER"),
120 .driver_data = (void *)oxp_mini_amd,
124 DMI_MATCH(DMI_BOARD_VENDOR, "ONE-NETBOOK"),
125 DMI_EXACT_MATCH(DMI_BOARD_NAME, "ONEXPLAYER mini A07"),
127 .driver_data = (void *)oxp_mini_amd_a07,
131 DMI_MATCH(DMI_BOARD_VENDOR, "ONE-NETBOOK"),
132 DMI_EXACT_MATCH(DMI_BOARD_NAME, "ONEXPLAYER Mini Pro"),
134 .driver_data = (void *)oxp_mini_amd_pro,
139 /* Helper functions to handle EC read/write */
140 static int read_from_ec(u8 reg, int size, long *val)
146 if (!lock_global_acpi_lock())
150 for (i = 0; i < size; i++) {
151 ret = ec_read(reg + i, &buffer);
158 if (!unlock_global_acpi_lock())
164 static int write_to_ec(u8 reg, u8 value)
168 if (!lock_global_acpi_lock())
171 ret = ec_write(reg, value);
173 if (!unlock_global_acpi_lock())
179 /* Turbo button toggle functions */
180 static int tt_toggle_enable(void)
186 case oxp_mini_amd_a07:
187 reg = OXP_OLD_TURBO_SWITCH_REG;
188 val = OXP_OLD_TURBO_TAKE_VAL;
190 case oxp_mini_amd_pro:
192 reg = OXP_TURBO_SWITCH_REG;
193 val = OXP_TURBO_TAKE_VAL;
198 return write_to_ec(reg, val);
201 static int tt_toggle_disable(void)
207 case oxp_mini_amd_a07:
208 reg = OXP_OLD_TURBO_SWITCH_REG;
209 val = OXP_OLD_TURBO_RETURN_VAL;
211 case oxp_mini_amd_pro:
213 reg = OXP_TURBO_SWITCH_REG;
214 val = OXP_TURBO_RETURN_VAL;
219 return write_to_ec(reg, val);
222 /* Callbacks for turbo toggle attribute */
223 static umode_t tt_toggle_is_visible(struct kobject *kobj,
224 struct attribute *attr, int n)
228 case oxp_mini_amd_a07:
229 case oxp_mini_amd_pro:
237 static ssize_t tt_toggle_store(struct device *dev,
238 struct device_attribute *attr, const char *buf,
244 rval = kstrtobool(buf, &value);
249 rval = tt_toggle_enable();
251 rval = tt_toggle_disable();
259 static ssize_t tt_toggle_show(struct device *dev,
260 struct device_attribute *attr, char *buf)
267 case oxp_mini_amd_a07:
268 reg = OXP_OLD_TURBO_SWITCH_REG;
270 case oxp_mini_amd_pro:
272 reg = OXP_TURBO_SWITCH_REG;
278 retval = read_from_ec(reg, 1, &val);
282 return sysfs_emit(buf, "%d\n", !!val);
285 static DEVICE_ATTR_RW(tt_toggle);
287 /* PWM enable/disable functions */
288 static int oxp_pwm_enable(void)
290 return write_to_ec(OXP_SENSOR_PWM_ENABLE_REG, 0x01);
293 static int oxp_pwm_disable(void)
295 return write_to_ec(OXP_SENSOR_PWM_ENABLE_REG, 0x00);
298 /* Callbacks for hwmon interface */
299 static umode_t oxp_ec_hwmon_is_visible(const void *drvdata,
300 enum hwmon_sensor_types type, u32 attr, int channel)
312 static int oxp_platform_read(struct device *dev, enum hwmon_sensor_types type,
313 u32 attr, int channel, long *val)
320 case hwmon_fan_input:
321 return read_from_ec(OXP_SENSOR_FAN_REG, 2, val);
328 case hwmon_pwm_input:
329 ret = read_from_ec(OXP_SENSOR_PWM_REG, 1, val);
335 case aya_neo_air_pro:
338 case oxp_mini_amd_a07:
339 *val = (*val * 255) / 100;
341 case oxp_mini_amd_pro:
347 case hwmon_pwm_enable:
348 return read_from_ec(OXP_SENSOR_PWM_ENABLE_REG, 1, val);
359 static int oxp_platform_write(struct device *dev, enum hwmon_sensor_types type,
360 u32 attr, int channel, long val)
365 case hwmon_pwm_enable:
367 return oxp_pwm_enable();
369 return oxp_pwm_disable();
371 case hwmon_pwm_input:
372 if (val < 0 || val > 255)
377 case aya_neo_air_pro:
380 case oxp_mini_amd_a07:
381 val = (val * 100) / 255;
384 case oxp_mini_amd_pro:
388 return write_to_ec(OXP_SENSOR_PWM_REG, val);
399 /* Known sensors in the OXP EC controllers */
400 static const struct hwmon_channel_info * const oxp_platform_sensors[] = {
401 HWMON_CHANNEL_INFO(fan,
403 HWMON_CHANNEL_INFO(pwm,
404 HWMON_PWM_INPUT | HWMON_PWM_ENABLE),
408 static struct attribute *oxp_ec_attrs[] = {
409 &dev_attr_tt_toggle.attr,
413 static struct attribute_group oxp_ec_attribute_group = {
414 .is_visible = tt_toggle_is_visible,
415 .attrs = oxp_ec_attrs,
418 static const struct attribute_group *oxp_ec_groups[] = {
419 &oxp_ec_attribute_group,
423 static const struct hwmon_ops oxp_ec_hwmon_ops = {
424 .is_visible = oxp_ec_hwmon_is_visible,
425 .read = oxp_platform_read,
426 .write = oxp_platform_write,
429 static const struct hwmon_chip_info oxp_ec_chip_info = {
430 .ops = &oxp_ec_hwmon_ops,
431 .info = oxp_platform_sensors,
434 /* Initialization logic */
435 static int oxp_platform_probe(struct platform_device *pdev)
437 const struct dmi_system_id *dmi_entry;
438 struct device *dev = &pdev->dev;
439 struct device *hwdev;
442 * Have to check for AMD processor here because DMI strings are the
443 * same between Intel and AMD boards, the only way to tell them apart
445 * Intel boards seem to have different EC registers and values to
448 dmi_entry = dmi_first_match(dmi_table);
449 if (!dmi_entry || boot_cpu_data.x86_vendor != X86_VENDOR_AMD)
452 board = (enum oxp_board)(unsigned long)dmi_entry->driver_data;
454 hwdev = devm_hwmon_device_register_with_info(dev, "oxpec", NULL,
455 &oxp_ec_chip_info, NULL);
457 return PTR_ERR_OR_ZERO(hwdev);
460 static struct platform_driver oxp_platform_driver = {
462 .name = "oxp-platform",
463 .dev_groups = oxp_ec_groups,
465 .probe = oxp_platform_probe,
468 static struct platform_device *oxp_platform_device;
470 static int __init oxp_platform_init(void)
472 oxp_platform_device =
473 platform_create_bundle(&oxp_platform_driver,
474 oxp_platform_probe, NULL, 0, NULL, 0);
476 return PTR_ERR_OR_ZERO(oxp_platform_device);
479 static void __exit oxp_platform_exit(void)
481 platform_device_unregister(oxp_platform_device);
482 platform_driver_unregister(&oxp_platform_driver);
485 MODULE_DEVICE_TABLE(dmi, dmi_table);
487 module_init(oxp_platform_init);
488 module_exit(oxp_platform_exit);
490 MODULE_AUTHOR("Joaquín Ignacio Aramendía <samsagax@gmail.com>");
491 MODULE_DESCRIPTION("Platform driver that handles EC sensors of OneXPlayer devices");
492 MODULE_LICENSE("GPL");