1 // SPDX-License-Identifier: GPL-2.0+
5 * Copyright (C) 2019 System76
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
12 #include <linux/acpi.h>
13 #include <linux/hwmon.h>
14 #include <linux/hwmon-sysfs.h>
15 #include <linux/init.h>
16 #include <linux/input.h>
17 #include <linux/kernel.h>
18 #include <linux/leds.h>
19 #include <linux/module.h>
20 #include <linux/pci_ids.h>
21 #include <linux/power_supply.h>
22 #include <linux/sysfs.h>
23 #include <linux/types.h>
25 #include <acpi/battery.h>
27 struct system76_data {
28 struct acpi_device *acpi_dev;
29 struct led_classdev ap_led;
30 struct led_classdev kb_led;
31 enum led_brightness kb_brightness;
32 enum led_brightness kb_toggle_brightness;
35 union acpi_object *nfan;
36 union acpi_object *ntmp;
37 struct input_dev *input;
41 static const struct acpi_device_id device_ids[] = {
45 MODULE_DEVICE_TABLE(acpi, device_ids);
47 // Array of keyboard LED brightness levels
48 static const enum led_brightness kb_levels[] = {
57 // Array of keyboard LED colors in 24-bit RGB format
58 static const int kb_colors[] = {
68 // Get a System76 ACPI device value by name
69 static int system76_get(struct system76_data *data, char *method)
73 unsigned long long ret = 0;
75 handle = acpi_device_handle(data->acpi_dev);
76 status = acpi_evaluate_integer(handle, method, NULL, &ret);
77 if (ACPI_SUCCESS(status))
82 // Get a System76 ACPI device value by name with index
83 static int system76_get_index(struct system76_data *data, char *method, int index)
85 union acpi_object obj;
86 struct acpi_object_list obj_list;
89 unsigned long long ret = 0;
91 obj.type = ACPI_TYPE_INTEGER;
92 obj.integer.value = index;
94 obj_list.pointer = &obj;
96 handle = acpi_device_handle(data->acpi_dev);
97 status = acpi_evaluate_integer(handle, method, &obj_list, &ret);
98 if (ACPI_SUCCESS(status))
103 // Get a System76 ACPI device object by name
104 static int system76_get_object(struct system76_data *data, char *method, union acpi_object **obj)
108 struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER, NULL };
110 handle = acpi_device_handle(data->acpi_dev);
111 status = acpi_evaluate_object(handle, method, NULL, &buf);
112 if (ACPI_SUCCESS(status)) {
120 // Get a name from a System76 ACPI device object
121 static char *system76_name(union acpi_object *obj, int index)
123 if (obj && obj->type == ACPI_TYPE_PACKAGE && index <= obj->package.count) {
124 if (obj->package.elements[index].type == ACPI_TYPE_STRING)
125 return obj->package.elements[index].string.pointer;
131 // Set a System76 ACPI device value by name
132 static int system76_set(struct system76_data *data, char *method, int value)
134 union acpi_object obj;
135 struct acpi_object_list obj_list;
139 obj.type = ACPI_TYPE_INTEGER;
140 obj.integer.value = value;
142 obj_list.pointer = &obj;
143 handle = acpi_device_handle(data->acpi_dev);
144 status = acpi_evaluate_object(handle, method, &obj_list, NULL);
145 if (ACPI_SUCCESS(status))
151 #define BATTERY_THRESHOLD_INVALID 0xFF
158 static ssize_t battery_get_threshold(int which, char *buf)
160 struct acpi_object_list input;
161 union acpi_object param;
164 unsigned long long ret = BATTERY_THRESHOLD_INVALID;
166 handle = ec_get_handle();
171 input.pointer = ¶m;
172 // Start/stop selection
173 param.type = ACPI_TYPE_INTEGER;
174 param.integer.value = which;
176 status = acpi_evaluate_integer(handle, "GBCT", &input, &ret);
177 if (ACPI_FAILURE(status))
179 if (ret == BATTERY_THRESHOLD_INVALID)
182 return sysfs_emit(buf, "%d\n", (int)ret);
185 static ssize_t battery_set_threshold(int which, const char *buf, size_t count)
187 struct acpi_object_list input;
188 union acpi_object params[2];
194 handle = ec_get_handle();
198 ret = kstrtouint(buf, 10, &value);
206 input.pointer = params;
207 // Start/stop selection
208 params[0].type = ACPI_TYPE_INTEGER;
209 params[0].integer.value = which;
211 params[1].type = ACPI_TYPE_INTEGER;
212 params[1].integer.value = value;
214 status = acpi_evaluate_object(handle, "SBCT", &input, NULL);
215 if (ACPI_FAILURE(status))
221 static ssize_t charge_control_start_threshold_show(struct device *dev,
222 struct device_attribute *attr, char *buf)
224 return battery_get_threshold(THRESHOLD_START, buf);
227 static ssize_t charge_control_start_threshold_store(struct device *dev,
228 struct device_attribute *attr, const char *buf, size_t count)
230 return battery_set_threshold(THRESHOLD_START, buf, count);
233 static DEVICE_ATTR_RW(charge_control_start_threshold);
235 static ssize_t charge_control_end_threshold_show(struct device *dev,
236 struct device_attribute *attr, char *buf)
238 return battery_get_threshold(THRESHOLD_END, buf);
241 static ssize_t charge_control_end_threshold_store(struct device *dev,
242 struct device_attribute *attr, const char *buf, size_t count)
244 return battery_set_threshold(THRESHOLD_END, buf, count);
247 static DEVICE_ATTR_RW(charge_control_end_threshold);
249 static struct attribute *system76_battery_attrs[] = {
250 &dev_attr_charge_control_start_threshold.attr,
251 &dev_attr_charge_control_end_threshold.attr,
255 ATTRIBUTE_GROUPS(system76_battery);
257 static int system76_battery_add(struct power_supply *battery)
259 // System76 EC only supports 1 battery
260 if (strcmp(battery->desc->name, "BAT0") != 0)
263 if (device_add_groups(&battery->dev, system76_battery_groups))
269 static int system76_battery_remove(struct power_supply *battery)
271 device_remove_groups(&battery->dev, system76_battery_groups);
275 static struct acpi_battery_hook system76_battery_hook = {
276 .add_battery = system76_battery_add,
277 .remove_battery = system76_battery_remove,
278 .name = "System76 Battery Extension",
281 static void system76_battery_init(void)
283 battery_hook_register(&system76_battery_hook);
286 static void system76_battery_exit(void)
288 battery_hook_unregister(&system76_battery_hook);
291 // Get the airplane mode LED brightness
292 static enum led_brightness ap_led_get(struct led_classdev *led)
294 struct system76_data *data;
297 data = container_of(led, struct system76_data, ap_led);
298 value = system76_get(data, "GAPL");
300 return (enum led_brightness)value;
305 // Set the airplane mode LED brightness
306 static int ap_led_set(struct led_classdev *led, enum led_brightness value)
308 struct system76_data *data;
310 data = container_of(led, struct system76_data, ap_led);
311 return system76_set(data, "SAPL", value == LED_OFF ? 0 : 1);
314 // Get the last set keyboard LED brightness
315 static enum led_brightness kb_led_get(struct led_classdev *led)
317 struct system76_data *data;
319 data = container_of(led, struct system76_data, kb_led);
320 return data->kb_brightness;
323 // Set the keyboard LED brightness
324 static int kb_led_set(struct led_classdev *led, enum led_brightness value)
326 struct system76_data *data;
328 data = container_of(led, struct system76_data, kb_led);
329 data->kb_brightness = value;
330 return system76_set(data, "SKBL", (int)data->kb_brightness);
333 // Get the last set keyboard LED color
334 static ssize_t kb_led_color_show(
336 struct device_attribute *dev_attr,
339 struct led_classdev *led;
340 struct system76_data *data;
342 led = dev_get_drvdata(dev);
343 data = container_of(led, struct system76_data, kb_led);
344 return sysfs_emit(buf, "%06X\n", data->kb_color);
347 // Set the keyboard LED color
348 static ssize_t kb_led_color_store(
350 struct device_attribute *dev_attr,
354 struct led_classdev *led;
355 struct system76_data *data;
359 led = dev_get_drvdata(dev);
360 data = container_of(led, struct system76_data, kb_led);
361 ret = kstrtouint(buf, 16, &val);
366 data->kb_color = (int)val;
367 system76_set(data, "SKBC", data->kb_color);
372 static struct device_attribute dev_attr_kb_led_color = {
377 .show = kb_led_color_show,
378 .store = kb_led_color_store,
381 static struct attribute *system76_kb_led_color_attrs[] = {
382 &dev_attr_kb_led_color.attr,
386 ATTRIBUTE_GROUPS(system76_kb_led_color);
388 // Notify that the keyboard LED was changed by hardware
389 static void kb_led_notify(struct system76_data *data)
391 led_classdev_notify_brightness_hw_changed(
397 // Read keyboard LED brightness as set by hardware
398 static void kb_led_hotkey_hardware(struct system76_data *data)
402 value = system76_get(data, "GKBL");
405 data->kb_brightness = value;
409 // Toggle the keyboard LED
410 static void kb_led_hotkey_toggle(struct system76_data *data)
412 if (data->kb_brightness > 0) {
413 data->kb_toggle_brightness = data->kb_brightness;
414 kb_led_set(&data->kb_led, 0);
416 kb_led_set(&data->kb_led, data->kb_toggle_brightness);
421 // Decrease the keyboard LED brightness
422 static void kb_led_hotkey_down(struct system76_data *data)
426 if (data->kb_brightness > 0) {
427 for (i = ARRAY_SIZE(kb_levels); i > 0; i--) {
428 if (kb_levels[i - 1] < data->kb_brightness) {
429 kb_led_set(&data->kb_led, kb_levels[i - 1]);
434 kb_led_set(&data->kb_led, data->kb_toggle_brightness);
439 // Increase the keyboard LED brightness
440 static void kb_led_hotkey_up(struct system76_data *data)
444 if (data->kb_brightness > 0) {
445 for (i = 0; i < ARRAY_SIZE(kb_levels); i++) {
446 if (kb_levels[i] > data->kb_brightness) {
447 kb_led_set(&data->kb_led, kb_levels[i]);
452 kb_led_set(&data->kb_led, data->kb_toggle_brightness);
457 // Cycle the keyboard LED color
458 static void kb_led_hotkey_color(struct system76_data *data)
462 if (data->kb_color < 0)
464 if (data->kb_brightness > 0) {
465 for (i = 0; i < ARRAY_SIZE(kb_colors); i++) {
466 if (kb_colors[i] == data->kb_color)
470 if (i >= ARRAY_SIZE(kb_colors))
472 data->kb_color = kb_colors[i];
473 system76_set(data, "SKBC", data->kb_color);
475 kb_led_set(&data->kb_led, data->kb_toggle_brightness);
480 static umode_t thermal_is_visible(const void *drvdata, enum hwmon_sensor_types type,
481 u32 attr, int channel)
483 const struct system76_data *data = drvdata;
488 if (system76_name(data->nfan, channel))
493 if (system76_name(data->ntmp, channel))
504 static int thermal_read(struct device *dev, enum hwmon_sensor_types type, u32 attr,
505 int channel, long *val)
507 struct system76_data *data = dev_get_drvdata(dev);
512 if (attr == hwmon_fan_input) {
513 raw = system76_get_index(data, "GFAN", channel);
516 *val = (raw >> 8) & 0xFFFF;
522 if (attr == hwmon_pwm_input) {
523 raw = system76_get_index(data, "GFAN", channel);
532 if (attr == hwmon_temp_input) {
533 raw = system76_get_index(data, "GTMP", channel);
548 static int thermal_read_string(struct device *dev, enum hwmon_sensor_types type, u32 attr,
549 int channel, const char **str)
551 struct system76_data *data = dev_get_drvdata(dev);
555 if (attr == hwmon_fan_label) {
556 *str = system76_name(data->nfan, channel);
563 if (attr == hwmon_temp_label) {
564 *str = system76_name(data->ntmp, channel);
577 static const struct hwmon_ops thermal_ops = {
578 .is_visible = thermal_is_visible,
579 .read = thermal_read,
580 .read_string = thermal_read_string,
583 // Allocate up to 8 fans and temperatures
584 static const struct hwmon_channel_info *thermal_channel_info[] = {
585 HWMON_CHANNEL_INFO(fan,
586 HWMON_F_INPUT | HWMON_F_LABEL,
587 HWMON_F_INPUT | HWMON_F_LABEL,
588 HWMON_F_INPUT | HWMON_F_LABEL,
589 HWMON_F_INPUT | HWMON_F_LABEL,
590 HWMON_F_INPUT | HWMON_F_LABEL,
591 HWMON_F_INPUT | HWMON_F_LABEL,
592 HWMON_F_INPUT | HWMON_F_LABEL,
593 HWMON_F_INPUT | HWMON_F_LABEL),
594 HWMON_CHANNEL_INFO(pwm,
603 HWMON_CHANNEL_INFO(temp,
604 HWMON_T_INPUT | HWMON_T_LABEL,
605 HWMON_T_INPUT | HWMON_T_LABEL,
606 HWMON_T_INPUT | HWMON_T_LABEL,
607 HWMON_T_INPUT | HWMON_T_LABEL,
608 HWMON_T_INPUT | HWMON_T_LABEL,
609 HWMON_T_INPUT | HWMON_T_LABEL,
610 HWMON_T_INPUT | HWMON_T_LABEL,
611 HWMON_T_INPUT | HWMON_T_LABEL),
615 static const struct hwmon_chip_info thermal_chip_info = {
617 .info = thermal_channel_info,
620 static void input_key(struct system76_data *data, unsigned int code)
622 input_report_key(data->input, code, 1);
623 input_sync(data->input);
625 input_report_key(data->input, code, 0);
626 input_sync(data->input);
629 // Handle ACPI notification
630 static void system76_notify(struct acpi_device *acpi_dev, u32 event)
632 struct system76_data *data;
634 data = acpi_driver_data(acpi_dev);
637 kb_led_hotkey_hardware(data);
640 kb_led_hotkey_toggle(data);
643 kb_led_hotkey_down(data);
646 kb_led_hotkey_up(data);
649 kb_led_hotkey_color(data);
652 input_key(data, KEY_SCREENLOCK);
657 // Add a System76 ACPI device
658 static int system76_add(struct acpi_device *acpi_dev)
660 struct system76_data *data;
663 data = devm_kzalloc(&acpi_dev->dev, sizeof(*data), GFP_KERNEL);
666 acpi_dev->driver_data = data;
667 data->acpi_dev = acpi_dev;
669 // Some models do not run open EC firmware. Check for an ACPI method
670 // that only exists on open EC to guard functionality specific to it.
671 data->has_open_ec = acpi_has_method(acpi_device_handle(data->acpi_dev), "NFAN");
673 err = system76_get(data, "INIT");
676 data->ap_led.name = "system76_acpi::airplane";
677 data->ap_led.flags = LED_CORE_SUSPENDRESUME;
678 data->ap_led.brightness_get = ap_led_get;
679 data->ap_led.brightness_set_blocking = ap_led_set;
680 data->ap_led.max_brightness = 1;
681 data->ap_led.default_trigger = "rfkill-none";
682 err = devm_led_classdev_register(&acpi_dev->dev, &data->ap_led);
686 data->kb_led.name = "system76_acpi::kbd_backlight";
687 data->kb_led.flags = LED_BRIGHT_HW_CHANGED | LED_CORE_SUSPENDRESUME;
688 data->kb_led.brightness_get = kb_led_get;
689 data->kb_led.brightness_set_blocking = kb_led_set;
690 if (acpi_has_method(acpi_device_handle(data->acpi_dev), "SKBC")) {
691 data->kb_led.max_brightness = 255;
692 data->kb_led.groups = system76_kb_led_color_groups;
693 data->kb_toggle_brightness = 72;
694 data->kb_color = 0xffffff;
695 system76_set(data, "SKBC", data->kb_color);
697 data->kb_led.max_brightness = 5;
700 err = devm_led_classdev_register(&acpi_dev->dev, &data->kb_led);
704 data->input = devm_input_allocate_device(&acpi_dev->dev);
708 data->input->name = "System76 ACPI Hotkeys";
709 data->input->phys = "system76_acpi/input0";
710 data->input->id.bustype = BUS_HOST;
711 data->input->dev.parent = &acpi_dev->dev;
712 input_set_capability(data->input, EV_KEY, KEY_SCREENLOCK);
714 err = input_register_device(data->input);
718 if (data->has_open_ec) {
719 err = system76_get_object(data, "NFAN", &data->nfan);
723 err = system76_get_object(data, "NTMP", &data->ntmp);
727 data->therm = devm_hwmon_device_register_with_info(&acpi_dev->dev,
728 "system76_acpi", data, &thermal_chip_info, NULL);
729 err = PTR_ERR_OR_ZERO(data->therm);
733 system76_battery_init();
739 if (data->has_open_ec) {
746 // Remove a System76 ACPI device
747 static int system76_remove(struct acpi_device *acpi_dev)
749 struct system76_data *data;
751 data = acpi_driver_data(acpi_dev);
753 if (data->has_open_ec) {
754 system76_battery_exit();
759 devm_led_classdev_unregister(&acpi_dev->dev, &data->ap_led);
760 devm_led_classdev_unregister(&acpi_dev->dev, &data->kb_led);
762 system76_get(data, "FINI");
767 static struct acpi_driver system76_driver = {
768 .name = "System76 ACPI Driver",
773 .remove = system76_remove,
774 .notify = system76_notify,
777 module_acpi_driver(system76_driver);
779 MODULE_DESCRIPTION("System76 ACPI Driver");
781 MODULE_LICENSE("GPL");