uniwill-laptop.rst 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. .. SPDX-License-Identifier: GPL-2.0+
  2. Uniwill laptop extra features
  3. =============================
  4. On laptops manufactured by Uniwill (either directly or as ODM), the ``uniwill-laptop`` driver
  5. handles various platform-specific features.
  6. Module Loading
  7. --------------
  8. The ``uniwill-laptop`` driver relies on a DMI table to automatically load on supported devices.
  9. When using the ``force`` module parameter, this DMI check will be omitted, allowing the driver
  10. to be loaded on unsupported devices for testing purposes.
  11. Hotkeys
  12. -------
  13. Usually the FN keys work without a special driver. However as soon as the ``uniwill-laptop`` driver
  14. is loaded, the FN keys need to be handled manually. This is done automatically by the driver itself.
  15. Keyboard settings
  16. -----------------
  17. The ``uniwill-laptop`` driver allows the user to enable/disable:
  18. - the FN lock and super key of the integrated keyboard
  19. - the touchpad toggle functionality of the integrated touchpad
  20. See Documentation/ABI/testing/sysfs-driver-uniwill-laptop for details.
  21. Hwmon interface
  22. ---------------
  23. The ``uniwill-laptop`` driver supports reading of the CPU and GPU temperature and supports up to
  24. two fans. Userspace applications can access sensor readings over the hwmon sysfs interface.
  25. Platform profile
  26. ----------------
  27. Support for changing the platform performance mode is currently not implemented.
  28. Battery Charging Control
  29. ------------------------
  30. The ``uniwill-laptop`` driver supports controlling the battery charge limit. This happens over
  31. the standard ``charge_control_end_threshold`` power supply sysfs attribute. All values
  32. between 1 and 100 percent are supported.
  33. Additionally the driver signals the presence of battery charging issues through the standard
  34. ``health`` power supply sysfs attribute.
  35. Lightbar
  36. --------
  37. The ``uniwill-laptop`` driver exposes the lightbar found on some models as a standard multicolor
  38. LED class device. The default name of this LED class device is ``uniwill:multicolor:status``.
  39. See Documentation/ABI/testing/sysfs-driver-uniwill-laptop for details on how to control the various
  40. animation modes of the lightbar.