10e27a11fSEnric Balletbo i Serra // SPDX-License-Identifier: GPL-2.0+ 20e27a11fSEnric Balletbo i Serra // Keyboard backlight LED driver for ChromeOS 30e27a11fSEnric Balletbo i Serra // 40e27a11fSEnric Balletbo i Serra // Copyright (C) 2012 Google, Inc. 5492ef782SSimon Que 6492ef782SSimon Que #include <linux/acpi.h> 7492ef782SSimon Que #include <linux/delay.h> 8492ef782SSimon Que #include <linux/err.h> 9492ef782SSimon Que #include <linux/init.h> 10492ef782SSimon Que #include <linux/kernel.h> 11337eac8fSTzung-Bi Shih #include <linux/leds.h> 12337eac8fSTzung-Bi Shih #include <linux/module.h> 13*fd1e8054STzung-Bi Shih #include <linux/of.h> 14492ef782SSimon Que #include <linux/platform_device.h> 15*fd1e8054STzung-Bi Shih #include <linux/property.h> 16492ef782SSimon Que #include <linux/slab.h> 17492ef782SSimon Que 186b1e5ba3STzung-Bi Shih /** 196b1e5ba3STzung-Bi Shih * struct keyboard_led_drvdata - keyboard LED driver data. 206b1e5ba3STzung-Bi Shih * @init: Init function. 216b1e5ba3STzung-Bi Shih * @brightness_get: Get LED brightness level. 226b1e5ba3STzung-Bi Shih * @brightness_set: Set LED brightness level. Must not sleep. 236b1e5ba3STzung-Bi Shih * @brightness_set_blocking: Set LED brightness level. It can block the 246b1e5ba3STzung-Bi Shih * caller for the time required for accessing a 256b1e5ba3STzung-Bi Shih * LED device register 266b1e5ba3STzung-Bi Shih * @max_brightness: Maximum brightness. 276b1e5ba3STzung-Bi Shih * 286b1e5ba3STzung-Bi Shih * See struct led_classdev in include/linux/leds.h for more details. 296b1e5ba3STzung-Bi Shih */ 306b1e5ba3STzung-Bi Shih struct keyboard_led_drvdata { 316b1e5ba3STzung-Bi Shih int (*init)(struct platform_device *pdev); 326b1e5ba3STzung-Bi Shih 336b1e5ba3STzung-Bi Shih enum led_brightness (*brightness_get)(struct led_classdev *led_cdev); 346b1e5ba3STzung-Bi Shih 356b1e5ba3STzung-Bi Shih void (*brightness_set)(struct led_classdev *led_cdev, 366b1e5ba3STzung-Bi Shih enum led_brightness brightness); 376b1e5ba3STzung-Bi Shih int (*brightness_set_blocking)(struct led_classdev *led_cdev, 386b1e5ba3STzung-Bi Shih enum led_brightness brightness); 396b1e5ba3STzung-Bi Shih 406b1e5ba3STzung-Bi Shih enum led_brightness max_brightness; 416b1e5ba3STzung-Bi Shih }; 426b1e5ba3STzung-Bi Shih 436b1e5ba3STzung-Bi Shih #ifdef CONFIG_ACPI 446b1e5ba3STzung-Bi Shih 45492ef782SSimon Que /* Keyboard LED ACPI Device must be defined in firmware */ 46492ef782SSimon Que #define ACPI_KEYBOARD_BACKLIGHT_DEVICE "\\_SB.KBLT" 47492ef782SSimon Que #define ACPI_KEYBOARD_BACKLIGHT_READ ACPI_KEYBOARD_BACKLIGHT_DEVICE ".KBQC" 48492ef782SSimon Que #define ACPI_KEYBOARD_BACKLIGHT_WRITE ACPI_KEYBOARD_BACKLIGHT_DEVICE ".KBCM" 49492ef782SSimon Que 50492ef782SSimon Que #define ACPI_KEYBOARD_BACKLIGHT_MAX 100 51492ef782SSimon Que 526b1e5ba3STzung-Bi Shih static void keyboard_led_set_brightness_acpi(struct led_classdev *cdev, 53492ef782SSimon Que enum led_brightness brightness) 54492ef782SSimon Que { 55492ef782SSimon Que union acpi_object param; 56492ef782SSimon Que struct acpi_object_list input; 57492ef782SSimon Que acpi_status status; 58492ef782SSimon Que 59492ef782SSimon Que param.type = ACPI_TYPE_INTEGER; 60492ef782SSimon Que param.integer.value = brightness; 61492ef782SSimon Que input.count = 1; 62492ef782SSimon Que input.pointer = ¶m; 63492ef782SSimon Que 64492ef782SSimon Que status = acpi_evaluate_object(NULL, ACPI_KEYBOARD_BACKLIGHT_WRITE, 65492ef782SSimon Que &input, NULL); 66492ef782SSimon Que if (ACPI_FAILURE(status)) 67492ef782SSimon Que dev_err(cdev->dev, "Error setting keyboard LED value: %d\n", 68492ef782SSimon Que status); 69492ef782SSimon Que } 70492ef782SSimon Que 71492ef782SSimon Que static enum led_brightness 726b1e5ba3STzung-Bi Shih keyboard_led_get_brightness_acpi(struct led_classdev *cdev) 73492ef782SSimon Que { 74492ef782SSimon Que unsigned long long brightness; 75492ef782SSimon Que acpi_status status; 76492ef782SSimon Que 77492ef782SSimon Que status = acpi_evaluate_integer(NULL, ACPI_KEYBOARD_BACKLIGHT_READ, 78492ef782SSimon Que NULL, &brightness); 79492ef782SSimon Que if (ACPI_FAILURE(status)) { 80492ef782SSimon Que dev_err(cdev->dev, "Error getting keyboard LED value: %d\n", 81492ef782SSimon Que status); 82492ef782SSimon Que return -EIO; 83492ef782SSimon Que } 84492ef782SSimon Que 85492ef782SSimon Que return brightness; 86492ef782SSimon Que } 87492ef782SSimon Que 886b1e5ba3STzung-Bi Shih static int keyboard_led_init_acpi(struct platform_device *pdev) 89492ef782SSimon Que { 90492ef782SSimon Que acpi_handle handle; 91492ef782SSimon Que acpi_status status; 92492ef782SSimon Que 93492ef782SSimon Que /* Look for the keyboard LED ACPI Device */ 94492ef782SSimon Que status = acpi_get_handle(ACPI_ROOT_OBJECT, 95492ef782SSimon Que ACPI_KEYBOARD_BACKLIGHT_DEVICE, 96492ef782SSimon Que &handle); 97492ef782SSimon Que if (ACPI_FAILURE(status)) { 98492ef782SSimon Que dev_err(&pdev->dev, "Unable to find ACPI device %s: %d\n", 99492ef782SSimon Que ACPI_KEYBOARD_BACKLIGHT_DEVICE, status); 100492ef782SSimon Que return -ENXIO; 101492ef782SSimon Que } 102492ef782SSimon Que 1036b1e5ba3STzung-Bi Shih return 0; 1046b1e5ba3STzung-Bi Shih } 1056b1e5ba3STzung-Bi Shih 1066b1e5ba3STzung-Bi Shih static const struct keyboard_led_drvdata keyboard_led_drvdata_acpi = { 1076b1e5ba3STzung-Bi Shih .init = keyboard_led_init_acpi, 1086b1e5ba3STzung-Bi Shih .brightness_set = keyboard_led_set_brightness_acpi, 1096b1e5ba3STzung-Bi Shih .brightness_get = keyboard_led_get_brightness_acpi, 1106b1e5ba3STzung-Bi Shih .max_brightness = ACPI_KEYBOARD_BACKLIGHT_MAX, 1116b1e5ba3STzung-Bi Shih }; 1126b1e5ba3STzung-Bi Shih 1136b1e5ba3STzung-Bi Shih #endif /* CONFIG_ACPI */ 1146b1e5ba3STzung-Bi Shih 1156b1e5ba3STzung-Bi Shih static int keyboard_led_probe(struct platform_device *pdev) 1166b1e5ba3STzung-Bi Shih { 1176b1e5ba3STzung-Bi Shih struct led_classdev *cdev; 1186b1e5ba3STzung-Bi Shih const struct keyboard_led_drvdata *drvdata; 1196b1e5ba3STzung-Bi Shih int error; 1206b1e5ba3STzung-Bi Shih 121*fd1e8054STzung-Bi Shih drvdata = device_get_match_data(&pdev->dev); 1226b1e5ba3STzung-Bi Shih if (!drvdata) 1236b1e5ba3STzung-Bi Shih return -EINVAL; 1246b1e5ba3STzung-Bi Shih 1256b1e5ba3STzung-Bi Shih if (drvdata->init) { 1266b1e5ba3STzung-Bi Shih error = drvdata->init(pdev); 1276b1e5ba3STzung-Bi Shih if (error) 1286b1e5ba3STzung-Bi Shih return error; 1296b1e5ba3STzung-Bi Shih } 1306b1e5ba3STzung-Bi Shih 131492ef782SSimon Que cdev = devm_kzalloc(&pdev->dev, sizeof(*cdev), GFP_KERNEL); 132492ef782SSimon Que if (!cdev) 133492ef782SSimon Que return -ENOMEM; 134492ef782SSimon Que 135492ef782SSimon Que cdev->name = "chromeos::kbd_backlight"; 136492ef782SSimon Que cdev->flags |= LED_CORE_SUSPENDRESUME; 1376b1e5ba3STzung-Bi Shih cdev->max_brightness = drvdata->max_brightness; 1386b1e5ba3STzung-Bi Shih cdev->brightness_set = drvdata->brightness_set; 1396b1e5ba3STzung-Bi Shih cdev->brightness_set_blocking = drvdata->brightness_set_blocking; 1406b1e5ba3STzung-Bi Shih cdev->brightness_get = drvdata->brightness_get; 141492ef782SSimon Que 142492ef782SSimon Que error = devm_led_classdev_register(&pdev->dev, cdev); 143492ef782SSimon Que if (error) 144492ef782SSimon Que return error; 145492ef782SSimon Que 146492ef782SSimon Que return 0; 147492ef782SSimon Que } 148492ef782SSimon Que 1496b1e5ba3STzung-Bi Shih #ifdef CONFIG_ACPI 1506b1e5ba3STzung-Bi Shih static const struct acpi_device_id keyboard_led_acpi_match[] = { 1516b1e5ba3STzung-Bi Shih { "GOOG0002", (kernel_ulong_t)&keyboard_led_drvdata_acpi }, 152492ef782SSimon Que { } 153492ef782SSimon Que }; 1546b1e5ba3STzung-Bi Shih MODULE_DEVICE_TABLE(acpi, keyboard_led_acpi_match); 1556b1e5ba3STzung-Bi Shih #endif 156492ef782SSimon Que 157*fd1e8054STzung-Bi Shih #ifdef CONFIG_OF 158*fd1e8054STzung-Bi Shih static const struct of_device_id keyboard_led_of_match[] = { 159*fd1e8054STzung-Bi Shih { 160*fd1e8054STzung-Bi Shih .compatible = "google,cros-kbd-led-backlight", 161*fd1e8054STzung-Bi Shih }, 162*fd1e8054STzung-Bi Shih {} 163*fd1e8054STzung-Bi Shih }; 164*fd1e8054STzung-Bi Shih MODULE_DEVICE_TABLE(of, keyboard_led_of_match); 165*fd1e8054STzung-Bi Shih #endif 166*fd1e8054STzung-Bi Shih 167492ef782SSimon Que static struct platform_driver keyboard_led_driver = { 168492ef782SSimon Que .driver = { 169492ef782SSimon Que .name = "chromeos-keyboard-leds", 1706b1e5ba3STzung-Bi Shih .acpi_match_table = ACPI_PTR(keyboard_led_acpi_match), 171*fd1e8054STzung-Bi Shih .of_match_table = of_match_ptr(keyboard_led_of_match), 172492ef782SSimon Que }, 173492ef782SSimon Que .probe = keyboard_led_probe, 174492ef782SSimon Que }; 175492ef782SSimon Que module_platform_driver(keyboard_led_driver); 176492ef782SSimon Que 177492ef782SSimon Que MODULE_AUTHOR("Simon Que <sque@chromium.org>"); 178492ef782SSimon Que MODULE_DESCRIPTION("ChromeOS Keyboard backlight LED Driver"); 179492ef782SSimon Que MODULE_LICENSE("GPL"); 180492ef782SSimon Que MODULE_ALIAS("platform:chromeos-keyboard-leds"); 181