1 // SPDX-License-Identifier: GPL-2.0+ 2 /* 3 * System76 ACPI Driver 4 * 5 * Copyright (C) 2019 System76 6 * 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. 10 */ 11 12 #include <linux/acpi.h> 13 #include <linux/hwmon.h> 14 #include <linux/hwmon-sysfs.h> 15 #include <linux/init.h> 16 #include <linux/kernel.h> 17 #include <linux/leds.h> 18 #include <linux/module.h> 19 #include <linux/pci_ids.h> 20 #include <linux/types.h> 21 22 struct system76_data { 23 struct acpi_device *acpi_dev; 24 struct led_classdev ap_led; 25 struct led_classdev kb_led; 26 enum led_brightness kb_brightness; 27 enum led_brightness kb_toggle_brightness; 28 int kb_color; 29 struct device *therm; 30 union acpi_object *nfan; 31 union acpi_object *ntmp; 32 }; 33 34 static const struct acpi_device_id device_ids[] = { 35 {"17761776", 0}, 36 {"", 0}, 37 }; 38 MODULE_DEVICE_TABLE(acpi, device_ids); 39 40 // Array of keyboard LED brightness levels 41 static const enum led_brightness kb_levels[] = { 42 48, 43 72, 44 96, 45 144, 46 192, 47 255 48 }; 49 50 // Array of keyboard LED colors in 24-bit RGB format 51 static const int kb_colors[] = { 52 0xFFFFFF, 53 0x0000FF, 54 0xFF0000, 55 0xFF00FF, 56 0x00FF00, 57 0x00FFFF, 58 0xFFFF00 59 }; 60 61 // Get a System76 ACPI device value by name 62 static int system76_get(struct system76_data *data, char *method) 63 { 64 acpi_handle handle; 65 acpi_status status; 66 unsigned long long ret = 0; 67 68 handle = acpi_device_handle(data->acpi_dev); 69 status = acpi_evaluate_integer(handle, method, NULL, &ret); 70 if (ACPI_SUCCESS(status)) 71 return ret; 72 return -ENODEV; 73 } 74 75 // Get a System76 ACPI device value by name with index 76 static int system76_get_index(struct system76_data *data, char *method, int index) 77 { 78 union acpi_object obj; 79 struct acpi_object_list obj_list; 80 acpi_handle handle; 81 acpi_status status; 82 unsigned long long ret = 0; 83 84 obj.type = ACPI_TYPE_INTEGER; 85 obj.integer.value = index; 86 obj_list.count = 1; 87 obj_list.pointer = &obj; 88 89 handle = acpi_device_handle(data->acpi_dev); 90 status = acpi_evaluate_integer(handle, method, &obj_list, &ret); 91 if (ACPI_SUCCESS(status)) 92 return ret; 93 return -ENODEV; 94 } 95 96 // Get a System76 ACPI device object by name 97 static int system76_get_object(struct system76_data *data, char *method, union acpi_object **obj) 98 { 99 acpi_handle handle; 100 acpi_status status; 101 struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER, NULL }; 102 103 handle = acpi_device_handle(data->acpi_dev); 104 status = acpi_evaluate_object(handle, method, NULL, &buf); 105 if (ACPI_SUCCESS(status)) { 106 *obj = buf.pointer; 107 return 0; 108 } 109 110 return -ENODEV; 111 } 112 113 // Get a name from a System76 ACPI device object 114 static char *system76_name(union acpi_object *obj, int index) 115 { 116 if (obj && obj->type == ACPI_TYPE_PACKAGE && index <= obj->package.count) { 117 if (obj->package.elements[index].type == ACPI_TYPE_STRING) 118 return obj->package.elements[index].string.pointer; 119 } 120 121 return NULL; 122 } 123 124 // Set a System76 ACPI device value by name 125 static int system76_set(struct system76_data *data, char *method, int value) 126 { 127 union acpi_object obj; 128 struct acpi_object_list obj_list; 129 acpi_handle handle; 130 acpi_status status; 131 132 obj.type = ACPI_TYPE_INTEGER; 133 obj.integer.value = value; 134 obj_list.count = 1; 135 obj_list.pointer = &obj; 136 handle = acpi_device_handle(data->acpi_dev); 137 status = acpi_evaluate_object(handle, method, &obj_list, NULL); 138 if (ACPI_SUCCESS(status)) 139 return 0; 140 else 141 return -1; 142 } 143 144 // Get the airplane mode LED brightness 145 static enum led_brightness ap_led_get(struct led_classdev *led) 146 { 147 struct system76_data *data; 148 int value; 149 150 data = container_of(led, struct system76_data, ap_led); 151 value = system76_get(data, "GAPL"); 152 if (value > 0) 153 return (enum led_brightness)value; 154 else 155 return LED_OFF; 156 } 157 158 // Set the airplane mode LED brightness 159 static int ap_led_set(struct led_classdev *led, enum led_brightness value) 160 { 161 struct system76_data *data; 162 163 data = container_of(led, struct system76_data, ap_led); 164 return system76_set(data, "SAPL", value == LED_OFF ? 0 : 1); 165 } 166 167 // Get the last set keyboard LED brightness 168 static enum led_brightness kb_led_get(struct led_classdev *led) 169 { 170 struct system76_data *data; 171 172 data = container_of(led, struct system76_data, kb_led); 173 return data->kb_brightness; 174 } 175 176 // Set the keyboard LED brightness 177 static int kb_led_set(struct led_classdev *led, enum led_brightness value) 178 { 179 struct system76_data *data; 180 181 data = container_of(led, struct system76_data, kb_led); 182 data->kb_brightness = value; 183 return system76_set(data, "SKBL", (int)data->kb_brightness); 184 } 185 186 // Get the last set keyboard LED color 187 static ssize_t kb_led_color_show( 188 struct device *dev, 189 struct device_attribute *dev_attr, 190 char *buf) 191 { 192 struct led_classdev *led; 193 struct system76_data *data; 194 195 led = (struct led_classdev *)dev->driver_data; 196 data = container_of(led, struct system76_data, kb_led); 197 return sprintf(buf, "%06X\n", data->kb_color); 198 } 199 200 // Set the keyboard LED color 201 static ssize_t kb_led_color_store( 202 struct device *dev, 203 struct device_attribute *dev_attr, 204 const char *buf, 205 size_t size) 206 { 207 struct led_classdev *led; 208 struct system76_data *data; 209 unsigned int val; 210 int ret; 211 212 led = (struct led_classdev *)dev->driver_data; 213 data = container_of(led, struct system76_data, kb_led); 214 ret = kstrtouint(buf, 16, &val); 215 if (ret) 216 return ret; 217 if (val > 0xFFFFFF) 218 return -EINVAL; 219 data->kb_color = (int)val; 220 system76_set(data, "SKBC", data->kb_color); 221 222 return size; 223 } 224 225 static const struct device_attribute kb_led_color_dev_attr = { 226 .attr = { 227 .name = "color", 228 .mode = 0644, 229 }, 230 .show = kb_led_color_show, 231 .store = kb_led_color_store, 232 }; 233 234 // Notify that the keyboard LED was changed by hardware 235 static void kb_led_notify(struct system76_data *data) 236 { 237 led_classdev_notify_brightness_hw_changed( 238 &data->kb_led, 239 data->kb_brightness 240 ); 241 } 242 243 // Read keyboard LED brightness as set by hardware 244 static void kb_led_hotkey_hardware(struct system76_data *data) 245 { 246 int value; 247 248 value = system76_get(data, "GKBL"); 249 if (value < 0) 250 return; 251 data->kb_brightness = value; 252 kb_led_notify(data); 253 } 254 255 // Toggle the keyboard LED 256 static void kb_led_hotkey_toggle(struct system76_data *data) 257 { 258 if (data->kb_brightness > 0) { 259 data->kb_toggle_brightness = data->kb_brightness; 260 kb_led_set(&data->kb_led, 0); 261 } else { 262 kb_led_set(&data->kb_led, data->kb_toggle_brightness); 263 } 264 kb_led_notify(data); 265 } 266 267 // Decrease the keyboard LED brightness 268 static void kb_led_hotkey_down(struct system76_data *data) 269 { 270 int i; 271 272 if (data->kb_brightness > 0) { 273 for (i = ARRAY_SIZE(kb_levels); i > 0; i--) { 274 if (kb_levels[i - 1] < data->kb_brightness) { 275 kb_led_set(&data->kb_led, kb_levels[i - 1]); 276 break; 277 } 278 } 279 } else { 280 kb_led_set(&data->kb_led, data->kb_toggle_brightness); 281 } 282 kb_led_notify(data); 283 } 284 285 // Increase the keyboard LED brightness 286 static void kb_led_hotkey_up(struct system76_data *data) 287 { 288 int i; 289 290 if (data->kb_brightness > 0) { 291 for (i = 0; i < ARRAY_SIZE(kb_levels); i++) { 292 if (kb_levels[i] > data->kb_brightness) { 293 kb_led_set(&data->kb_led, kb_levels[i]); 294 break; 295 } 296 } 297 } else { 298 kb_led_set(&data->kb_led, data->kb_toggle_brightness); 299 } 300 kb_led_notify(data); 301 } 302 303 // Cycle the keyboard LED color 304 static void kb_led_hotkey_color(struct system76_data *data) 305 { 306 int i; 307 308 if (data->kb_color < 0) 309 return; 310 if (data->kb_brightness > 0) { 311 for (i = 0; i < ARRAY_SIZE(kb_colors); i++) { 312 if (kb_colors[i] == data->kb_color) 313 break; 314 } 315 i += 1; 316 if (i >= ARRAY_SIZE(kb_colors)) 317 i = 0; 318 data->kb_color = kb_colors[i]; 319 system76_set(data, "SKBC", data->kb_color); 320 } else { 321 kb_led_set(&data->kb_led, data->kb_toggle_brightness); 322 } 323 kb_led_notify(data); 324 } 325 326 static umode_t thermal_is_visible(const void *drvdata, enum hwmon_sensor_types type, 327 u32 attr, int channel) 328 { 329 const struct system76_data *data = drvdata; 330 331 switch (type) { 332 case hwmon_fan: 333 case hwmon_pwm: 334 if (system76_name(data->nfan, channel)) 335 return 0444; 336 break; 337 338 case hwmon_temp: 339 if (system76_name(data->ntmp, channel)) 340 return 0444; 341 break; 342 343 default: 344 return 0; 345 } 346 347 return 0; 348 } 349 350 static int thermal_read(struct device *dev, enum hwmon_sensor_types type, u32 attr, 351 int channel, long *val) 352 { 353 struct system76_data *data = dev_get_drvdata(dev); 354 int raw; 355 356 switch (type) { 357 case hwmon_fan: 358 if (attr == hwmon_fan_input) { 359 raw = system76_get_index(data, "GFAN", channel); 360 if (raw < 0) 361 return raw; 362 *val = (raw >> 8) & 0xFFFF; 363 return 0; 364 } 365 break; 366 367 case hwmon_pwm: 368 if (attr == hwmon_pwm_input) { 369 raw = system76_get_index(data, "GFAN", channel); 370 if (raw < 0) 371 return raw; 372 *val = raw & 0xFF; 373 return 0; 374 } 375 break; 376 377 case hwmon_temp: 378 if (attr == hwmon_temp_input) { 379 raw = system76_get_index(data, "GTMP", channel); 380 if (raw < 0) 381 return raw; 382 *val = raw * 1000; 383 return 0; 384 } 385 break; 386 387 default: 388 return -EOPNOTSUPP; 389 } 390 391 return -EOPNOTSUPP; 392 } 393 394 static int thermal_read_string(struct device *dev, enum hwmon_sensor_types type, u32 attr, 395 int channel, const char **str) 396 { 397 struct system76_data *data = dev_get_drvdata(dev); 398 399 switch (type) { 400 case hwmon_fan: 401 if (attr == hwmon_fan_label) { 402 *str = system76_name(data->nfan, channel); 403 if (*str) 404 return 0; 405 } 406 break; 407 408 case hwmon_temp: 409 if (attr == hwmon_temp_label) { 410 *str = system76_name(data->ntmp, channel); 411 if (*str) 412 return 0; 413 } 414 break; 415 416 default: 417 return -EOPNOTSUPP; 418 } 419 420 return -EOPNOTSUPP; 421 } 422 423 static const struct hwmon_ops thermal_ops = { 424 .is_visible = thermal_is_visible, 425 .read = thermal_read, 426 .read_string = thermal_read_string, 427 }; 428 429 // Allocate up to 8 fans and temperatures 430 static const struct hwmon_channel_info *thermal_channel_info[] = { 431 HWMON_CHANNEL_INFO(fan, 432 HWMON_F_INPUT | HWMON_F_LABEL, 433 HWMON_F_INPUT | HWMON_F_LABEL, 434 HWMON_F_INPUT | HWMON_F_LABEL, 435 HWMON_F_INPUT | HWMON_F_LABEL, 436 HWMON_F_INPUT | HWMON_F_LABEL, 437 HWMON_F_INPUT | HWMON_F_LABEL, 438 HWMON_F_INPUT | HWMON_F_LABEL, 439 HWMON_F_INPUT | HWMON_F_LABEL), 440 HWMON_CHANNEL_INFO(pwm, 441 HWMON_PWM_INPUT, 442 HWMON_PWM_INPUT, 443 HWMON_PWM_INPUT, 444 HWMON_PWM_INPUT, 445 HWMON_PWM_INPUT, 446 HWMON_PWM_INPUT, 447 HWMON_PWM_INPUT, 448 HWMON_PWM_INPUT), 449 HWMON_CHANNEL_INFO(temp, 450 HWMON_T_INPUT | HWMON_T_LABEL, 451 HWMON_T_INPUT | HWMON_T_LABEL, 452 HWMON_T_INPUT | HWMON_T_LABEL, 453 HWMON_T_INPUT | HWMON_T_LABEL, 454 HWMON_T_INPUT | HWMON_T_LABEL, 455 HWMON_T_INPUT | HWMON_T_LABEL, 456 HWMON_T_INPUT | HWMON_T_LABEL, 457 HWMON_T_INPUT | HWMON_T_LABEL), 458 NULL 459 }; 460 461 static const struct hwmon_chip_info thermal_chip_info = { 462 .ops = &thermal_ops, 463 .info = thermal_channel_info, 464 }; 465 466 // Handle ACPI notification 467 static void system76_notify(struct acpi_device *acpi_dev, u32 event) 468 { 469 struct system76_data *data; 470 471 data = acpi_driver_data(acpi_dev); 472 switch (event) { 473 case 0x80: 474 kb_led_hotkey_hardware(data); 475 break; 476 case 0x81: 477 kb_led_hotkey_toggle(data); 478 break; 479 case 0x82: 480 kb_led_hotkey_down(data); 481 break; 482 case 0x83: 483 kb_led_hotkey_up(data); 484 break; 485 case 0x84: 486 kb_led_hotkey_color(data); 487 break; 488 } 489 } 490 491 // Add a System76 ACPI device 492 static int system76_add(struct acpi_device *acpi_dev) 493 { 494 struct system76_data *data; 495 int err; 496 497 data = devm_kzalloc(&acpi_dev->dev, sizeof(*data), GFP_KERNEL); 498 if (!data) 499 return -ENOMEM; 500 acpi_dev->driver_data = data; 501 data->acpi_dev = acpi_dev; 502 503 err = system76_get(data, "INIT"); 504 if (err) 505 return err; 506 data->ap_led.name = "system76_acpi::airplane"; 507 data->ap_led.flags = LED_CORE_SUSPENDRESUME; 508 data->ap_led.brightness_get = ap_led_get; 509 data->ap_led.brightness_set_blocking = ap_led_set; 510 data->ap_led.max_brightness = 1; 511 data->ap_led.default_trigger = "rfkill-none"; 512 err = devm_led_classdev_register(&acpi_dev->dev, &data->ap_led); 513 if (err) 514 return err; 515 516 data->kb_led.name = "system76_acpi::kbd_backlight"; 517 data->kb_led.flags = LED_BRIGHT_HW_CHANGED | LED_CORE_SUSPENDRESUME; 518 data->kb_led.brightness_get = kb_led_get; 519 data->kb_led.brightness_set_blocking = kb_led_set; 520 if (acpi_has_method(acpi_device_handle(data->acpi_dev), "SKBC")) { 521 data->kb_led.max_brightness = 255; 522 data->kb_toggle_brightness = 72; 523 data->kb_color = 0xffffff; 524 system76_set(data, "SKBC", data->kb_color); 525 } else { 526 data->kb_led.max_brightness = 5; 527 data->kb_color = -1; 528 } 529 err = devm_led_classdev_register(&acpi_dev->dev, &data->kb_led); 530 if (err) 531 return err; 532 533 if (data->kb_color >= 0) { 534 err = device_create_file( 535 data->kb_led.dev, 536 &kb_led_color_dev_attr 537 ); 538 if (err) 539 return err; 540 } 541 542 err = system76_get_object(data, "NFAN", &data->nfan); 543 if (err) 544 goto error; 545 546 err = system76_get_object(data, "NTMP", &data->ntmp); 547 if (err) 548 goto error; 549 550 data->therm = devm_hwmon_device_register_with_info(&acpi_dev->dev, 551 "system76_acpi", data, &thermal_chip_info, NULL); 552 err = PTR_ERR_OR_ZERO(data->therm); 553 if (err) 554 goto error; 555 556 return 0; 557 558 error: 559 kfree(data->ntmp); 560 kfree(data->nfan); 561 return err; 562 } 563 564 // Remove a System76 ACPI device 565 static int system76_remove(struct acpi_device *acpi_dev) 566 { 567 struct system76_data *data; 568 569 data = acpi_driver_data(acpi_dev); 570 if (data->kb_color >= 0) 571 device_remove_file(data->kb_led.dev, &kb_led_color_dev_attr); 572 573 devm_led_classdev_unregister(&acpi_dev->dev, &data->ap_led); 574 devm_led_classdev_unregister(&acpi_dev->dev, &data->kb_led); 575 576 kfree(data->nfan); 577 kfree(data->ntmp); 578 579 system76_get(data, "FINI"); 580 581 return 0; 582 } 583 584 static struct acpi_driver system76_driver = { 585 .name = "System76 ACPI Driver", 586 .class = "hotkey", 587 .ids = device_ids, 588 .ops = { 589 .add = system76_add, 590 .remove = system76_remove, 591 .notify = system76_notify, 592 }, 593 }; 594 module_acpi_driver(system76_driver); 595 596 MODULE_DESCRIPTION("System76 ACPI Driver"); 597 MODULE_AUTHOR("Jeremy Soller <jeremy@system76.com>"); 598 MODULE_LICENSE("GPL"); 599