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;
40 static const struct acpi_device_id device_ids[] = {
44 MODULE_DEVICE_TABLE(acpi, device_ids);
46 // Array of keyboard LED brightness levels
47 static const enum led_brightness kb_levels[] = {
56 // Array of keyboard LED colors in 24-bit RGB format
57 static const int kb_colors[] = {
67 // Get a System76 ACPI device value by name
68 static int system76_get(struct system76_data *data, char *method)
72 unsigned long long ret = 0;
74 handle = acpi_device_handle(data->acpi_dev);
75 status = acpi_evaluate_integer(handle, method, NULL, &ret);
76 if (ACPI_SUCCESS(status))
81 // Get a System76 ACPI device value by name with index
82 static int system76_get_index(struct system76_data *data, char *method, int index)
84 union acpi_object obj;
85 struct acpi_object_list obj_list;
88 unsigned long long ret = 0;
90 obj.type = ACPI_TYPE_INTEGER;
91 obj.integer.value = index;
93 obj_list.pointer = &obj;
95 handle = acpi_device_handle(data->acpi_dev);
96 status = acpi_evaluate_integer(handle, method, &obj_list, &ret);
97 if (ACPI_SUCCESS(status))
102 // Get a System76 ACPI device object by name
103 static int system76_get_object(struct system76_data *data, char *method, union acpi_object **obj)
107 struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER, NULL };
109 handle = acpi_device_handle(data->acpi_dev);
110 status = acpi_evaluate_object(handle, method, NULL, &buf);
111 if (ACPI_SUCCESS(status)) {
119 // Get a name from a System76 ACPI device object
120 static char *system76_name(union acpi_object *obj, int index)
122 if (obj && obj->type == ACPI_TYPE_PACKAGE && index <= obj->package.count) {
123 if (obj->package.elements[index].type == ACPI_TYPE_STRING)
124 return obj->package.elements[index].string.pointer;
130 // Set a System76 ACPI device value by name
131 static int system76_set(struct system76_data *data, char *method, int value)
133 union acpi_object obj;
134 struct acpi_object_list obj_list;
138 obj.type = ACPI_TYPE_INTEGER;
139 obj.integer.value = value;
141 obj_list.pointer = &obj;
142 handle = acpi_device_handle(data->acpi_dev);
143 status = acpi_evaluate_object(handle, method, &obj_list, NULL);
144 if (ACPI_SUCCESS(status))
150 #define BATTERY_THRESHOLD_INVALID 0xFF
157 static ssize_t battery_get_threshold(int which, char *buf)
159 struct acpi_object_list input;
160 union acpi_object param;
163 unsigned long long ret = BATTERY_THRESHOLD_INVALID;
165 handle = ec_get_handle();
170 input.pointer = ¶m;
171 // Start/stop selection
172 param.type = ACPI_TYPE_INTEGER;
173 param.integer.value = which;
175 status = acpi_evaluate_integer(handle, "GBCT", &input, &ret);
176 if (ACPI_FAILURE(status))
178 if (ret == BATTERY_THRESHOLD_INVALID)
181 return sysfs_emit(buf, "%d\n", (int)ret);
184 static ssize_t battery_set_threshold(int which, const char *buf, size_t count)
186 struct acpi_object_list input;
187 union acpi_object params[2];
193 handle = ec_get_handle();
197 ret = kstrtouint(buf, 10, &value);
205 input.pointer = params;
206 // Start/stop selection
207 params[0].type = ACPI_TYPE_INTEGER;
208 params[0].integer.value = which;
210 params[1].type = ACPI_TYPE_INTEGER;
211 params[1].integer.value = value;
213 status = acpi_evaluate_object(handle, "SBCT", &input, NULL);
214 if (ACPI_FAILURE(status))
220 static ssize_t charge_control_start_threshold_show(struct device *dev,
221 struct device_attribute *attr, char *buf)
223 return battery_get_threshold(THRESHOLD_START, buf);
226 static ssize_t charge_control_start_threshold_store(struct device *dev,
227 struct device_attribute *attr, const char *buf, size_t count)
229 return battery_set_threshold(THRESHOLD_START, buf, count);
232 static DEVICE_ATTR_RW(charge_control_start_threshold);
234 static ssize_t charge_control_end_threshold_show(struct device *dev,
235 struct device_attribute *attr, char *buf)
237 return battery_get_threshold(THRESHOLD_END, buf);
240 static ssize_t charge_control_end_threshold_store(struct device *dev,
241 struct device_attribute *attr, const char *buf, size_t count)
243 return battery_set_threshold(THRESHOLD_END, buf, count);
246 static DEVICE_ATTR_RW(charge_control_end_threshold);
248 static struct attribute *system76_battery_attrs[] = {
249 &dev_attr_charge_control_start_threshold.attr,
250 &dev_attr_charge_control_end_threshold.attr,
254 ATTRIBUTE_GROUPS(system76_battery);
256 static int system76_battery_add(struct power_supply *battery)
258 // System76 EC only supports 1 battery
259 if (strcmp(battery->desc->name, "BAT0") != 0)
262 if (device_add_groups(&battery->dev, system76_battery_groups))
268 static int system76_battery_remove(struct power_supply *battery)
270 device_remove_groups(&battery->dev, system76_battery_groups);
274 static struct acpi_battery_hook system76_battery_hook = {
275 .add_battery = system76_battery_add,
276 .remove_battery = system76_battery_remove,
277 .name = "System76 Battery Extension",
280 static void system76_battery_init(void)
284 handle = ec_get_handle();
285 if (handle && acpi_has_method(handle, "GBCT"))
286 battery_hook_register(&system76_battery_hook);
289 static void system76_battery_exit(void)
293 handle = ec_get_handle();
294 if (handle && acpi_has_method(handle, "GBCT"))
295 battery_hook_unregister(&system76_battery_hook);
298 // Get the airplane mode LED brightness
299 static enum led_brightness ap_led_get(struct led_classdev *led)
301 struct system76_data *data;
304 data = container_of(led, struct system76_data, ap_led);
305 value = system76_get(data, "GAPL");
307 return (enum led_brightness)value;
312 // Set the airplane mode LED brightness
313 static int ap_led_set(struct led_classdev *led, enum led_brightness value)
315 struct system76_data *data;
317 data = container_of(led, struct system76_data, ap_led);
318 return system76_set(data, "SAPL", value == LED_OFF ? 0 : 1);
321 // Get the last set keyboard LED brightness
322 static enum led_brightness kb_led_get(struct led_classdev *led)
324 struct system76_data *data;
326 data = container_of(led, struct system76_data, kb_led);
327 return data->kb_brightness;
330 // Set the keyboard LED brightness
331 static int kb_led_set(struct led_classdev *led, enum led_brightness value)
333 struct system76_data *data;
335 data = container_of(led, struct system76_data, kb_led);
336 data->kb_brightness = value;
337 return system76_set(data, "SKBL", (int)data->kb_brightness);
340 // Get the last set keyboard LED color
341 static ssize_t kb_led_color_show(
343 struct device_attribute *dev_attr,
346 struct led_classdev *led;
347 struct system76_data *data;
349 led = (struct led_classdev *)dev->driver_data;
350 data = container_of(led, struct system76_data, kb_led);
351 return sysfs_emit(buf, "%06X\n", data->kb_color);
354 // Set the keyboard LED color
355 static ssize_t kb_led_color_store(
357 struct device_attribute *dev_attr,
361 struct led_classdev *led;
362 struct system76_data *data;
366 led = (struct led_classdev *)dev->driver_data;
367 data = container_of(led, struct system76_data, kb_led);
368 ret = kstrtouint(buf, 16, &val);
373 data->kb_color = (int)val;
374 system76_set(data, "SKBC", data->kb_color);
379 static struct device_attribute dev_attr_kb_led_color = {
384 .show = kb_led_color_show,
385 .store = kb_led_color_store,
388 static struct attribute *system76_kb_led_color_attrs[] = {
389 &dev_attr_kb_led_color.attr,
393 ATTRIBUTE_GROUPS(system76_kb_led_color);
395 // Notify that the keyboard LED was changed by hardware
396 static void kb_led_notify(struct system76_data *data)
398 led_classdev_notify_brightness_hw_changed(
404 // Read keyboard LED brightness as set by hardware
405 static void kb_led_hotkey_hardware(struct system76_data *data)
409 value = system76_get(data, "GKBL");
412 data->kb_brightness = value;
416 // Toggle the keyboard LED
417 static void kb_led_hotkey_toggle(struct system76_data *data)
419 if (data->kb_brightness > 0) {
420 data->kb_toggle_brightness = data->kb_brightness;
421 kb_led_set(&data->kb_led, 0);
423 kb_led_set(&data->kb_led, data->kb_toggle_brightness);
428 // Decrease the keyboard LED brightness
429 static void kb_led_hotkey_down(struct system76_data *data)
433 if (data->kb_brightness > 0) {
434 for (i = ARRAY_SIZE(kb_levels); i > 0; i--) {
435 if (kb_levels[i - 1] < data->kb_brightness) {
436 kb_led_set(&data->kb_led, kb_levels[i - 1]);
441 kb_led_set(&data->kb_led, data->kb_toggle_brightness);
446 // Increase the keyboard LED brightness
447 static void kb_led_hotkey_up(struct system76_data *data)
451 if (data->kb_brightness > 0) {
452 for (i = 0; i < ARRAY_SIZE(kb_levels); i++) {
453 if (kb_levels[i] > data->kb_brightness) {
454 kb_led_set(&data->kb_led, kb_levels[i]);
459 kb_led_set(&data->kb_led, data->kb_toggle_brightness);
464 // Cycle the keyboard LED color
465 static void kb_led_hotkey_color(struct system76_data *data)
469 if (data->kb_color < 0)
471 if (data->kb_brightness > 0) {
472 for (i = 0; i < ARRAY_SIZE(kb_colors); i++) {
473 if (kb_colors[i] == data->kb_color)
477 if (i >= ARRAY_SIZE(kb_colors))
479 data->kb_color = kb_colors[i];
480 system76_set(data, "SKBC", data->kb_color);
482 kb_led_set(&data->kb_led, data->kb_toggle_brightness);
487 static umode_t thermal_is_visible(const void *drvdata, enum hwmon_sensor_types type,
488 u32 attr, int channel)
490 const struct system76_data *data = drvdata;
495 if (system76_name(data->nfan, channel))
500 if (system76_name(data->ntmp, channel))
511 static int thermal_read(struct device *dev, enum hwmon_sensor_types type, u32 attr,
512 int channel, long *val)
514 struct system76_data *data = dev_get_drvdata(dev);
519 if (attr == hwmon_fan_input) {
520 raw = system76_get_index(data, "GFAN", channel);
523 *val = (raw >> 8) & 0xFFFF;
529 if (attr == hwmon_pwm_input) {
530 raw = system76_get_index(data, "GFAN", channel);
539 if (attr == hwmon_temp_input) {
540 raw = system76_get_index(data, "GTMP", channel);
555 static int thermal_read_string(struct device *dev, enum hwmon_sensor_types type, u32 attr,
556 int channel, const char **str)
558 struct system76_data *data = dev_get_drvdata(dev);
562 if (attr == hwmon_fan_label) {
563 *str = system76_name(data->nfan, channel);
570 if (attr == hwmon_temp_label) {
571 *str = system76_name(data->ntmp, channel);
584 static const struct hwmon_ops thermal_ops = {
585 .is_visible = thermal_is_visible,
586 .read = thermal_read,
587 .read_string = thermal_read_string,
590 // Allocate up to 8 fans and temperatures
591 static const struct hwmon_channel_info *thermal_channel_info[] = {
592 HWMON_CHANNEL_INFO(fan,
593 HWMON_F_INPUT | HWMON_F_LABEL,
594 HWMON_F_INPUT | HWMON_F_LABEL,
595 HWMON_F_INPUT | HWMON_F_LABEL,
596 HWMON_F_INPUT | HWMON_F_LABEL,
597 HWMON_F_INPUT | HWMON_F_LABEL,
598 HWMON_F_INPUT | HWMON_F_LABEL,
599 HWMON_F_INPUT | HWMON_F_LABEL,
600 HWMON_F_INPUT | HWMON_F_LABEL),
601 HWMON_CHANNEL_INFO(pwm,
610 HWMON_CHANNEL_INFO(temp,
611 HWMON_T_INPUT | HWMON_T_LABEL,
612 HWMON_T_INPUT | HWMON_T_LABEL,
613 HWMON_T_INPUT | HWMON_T_LABEL,
614 HWMON_T_INPUT | HWMON_T_LABEL,
615 HWMON_T_INPUT | HWMON_T_LABEL,
616 HWMON_T_INPUT | HWMON_T_LABEL,
617 HWMON_T_INPUT | HWMON_T_LABEL,
618 HWMON_T_INPUT | HWMON_T_LABEL),
622 static const struct hwmon_chip_info thermal_chip_info = {
624 .info = thermal_channel_info,
627 static void input_key(struct system76_data *data, unsigned int code)
629 input_report_key(data->input, code, 1);
630 input_sync(data->input);
632 input_report_key(data->input, code, 0);
633 input_sync(data->input);
636 // Handle ACPI notification
637 static void system76_notify(struct acpi_device *acpi_dev, u32 event)
639 struct system76_data *data;
641 data = acpi_driver_data(acpi_dev);
644 kb_led_hotkey_hardware(data);
647 kb_led_hotkey_toggle(data);
650 kb_led_hotkey_down(data);
653 kb_led_hotkey_up(data);
656 kb_led_hotkey_color(data);
659 input_key(data, KEY_SCREENLOCK);
664 // Add a System76 ACPI device
665 static int system76_add(struct acpi_device *acpi_dev)
667 struct system76_data *data;
670 data = devm_kzalloc(&acpi_dev->dev, sizeof(*data), GFP_KERNEL);
673 acpi_dev->driver_data = data;
674 data->acpi_dev = acpi_dev;
676 err = system76_get(data, "INIT");
679 data->ap_led.name = "system76_acpi::airplane";
680 data->ap_led.flags = LED_CORE_SUSPENDRESUME;
681 data->ap_led.brightness_get = ap_led_get;
682 data->ap_led.brightness_set_blocking = ap_led_set;
683 data->ap_led.max_brightness = 1;
684 data->ap_led.default_trigger = "rfkill-none";
685 err = devm_led_classdev_register(&acpi_dev->dev, &data->ap_led);
689 data->kb_led.name = "system76_acpi::kbd_backlight";
690 data->kb_led.flags = LED_BRIGHT_HW_CHANGED | LED_CORE_SUSPENDRESUME;
691 data->kb_led.brightness_get = kb_led_get;
692 data->kb_led.brightness_set_blocking = kb_led_set;
693 if (acpi_has_method(acpi_device_handle(data->acpi_dev), "SKBC")) {
694 data->kb_led.max_brightness = 255;
695 data->kb_led.groups = system76_kb_led_color_groups;
696 data->kb_toggle_brightness = 72;
697 data->kb_color = 0xffffff;
698 system76_set(data, "SKBC", data->kb_color);
700 data->kb_led.max_brightness = 5;
703 err = devm_led_classdev_register(&acpi_dev->dev, &data->kb_led);
707 data->input = devm_input_allocate_device(&acpi_dev->dev);
711 data->input->name = "System76 ACPI Hotkeys";
712 data->input->phys = "system76_acpi/input0";
713 data->input->id.bustype = BUS_HOST;
714 data->input->dev.parent = &acpi_dev->dev;
715 input_set_capability(data->input, EV_KEY, KEY_SCREENLOCK);
717 err = input_register_device(data->input);
721 err = system76_get_object(data, "NFAN", &data->nfan);
725 err = system76_get_object(data, "NTMP", &data->ntmp);
729 data->therm = devm_hwmon_device_register_with_info(&acpi_dev->dev,
730 "system76_acpi", data, &thermal_chip_info, NULL);
731 err = PTR_ERR_OR_ZERO(data->therm);
735 system76_battery_init();
745 // Remove a System76 ACPI device
746 static int system76_remove(struct acpi_device *acpi_dev)
748 struct system76_data *data;
750 data = acpi_driver_data(acpi_dev);
752 system76_battery_exit();
754 devm_led_classdev_unregister(&acpi_dev->dev, &data->ap_led);
755 devm_led_classdev_unregister(&acpi_dev->dev, &data->kb_led);
760 system76_get(data, "FINI");
765 static struct acpi_driver system76_driver = {
766 .name = "System76 ACPI Driver",
771 .remove = system76_remove,
772 .notify = system76_notify,
775 module_acpi_driver(system76_driver);
777 MODULE_DESCRIPTION("System76 ACPI Driver");
778 MODULE_AUTHOR("Jeremy Soller <jeremy@system76.com>");
779 MODULE_LICENSE("GPL");