xref: /linux/Documentation/admin-guide/laptops/uniwill-laptop.rst (revision 9d588a1140b9ae211581a7a154d0b806d8cd8238)
1*cec551ecSArmin Wolf.. SPDX-License-Identifier: GPL-2.0+
2*cec551ecSArmin Wolf
3*cec551ecSArmin WolfUniwill laptop extra features
4*cec551ecSArmin Wolf=============================
5*cec551ecSArmin Wolf
6*cec551ecSArmin WolfOn laptops manufactured by Uniwill (either directly or as ODM), the ``uniwill-laptop`` driver
7*cec551ecSArmin Wolfhandles various platform-specific features.
8*cec551ecSArmin Wolf
9*cec551ecSArmin WolfModule Loading
10*cec551ecSArmin Wolf--------------
11*cec551ecSArmin Wolf
12*cec551ecSArmin WolfThe ``uniwill-laptop`` driver relies on a DMI table to automatically load on supported devices.
13*cec551ecSArmin WolfWhen using the ``force`` module parameter, this DMI check will be omitted, allowing the driver
14*cec551ecSArmin Wolfto be loaded on unsupported devices for testing purposes.
15*cec551ecSArmin Wolf
16*cec551ecSArmin WolfHotkeys
17*cec551ecSArmin Wolf-------
18*cec551ecSArmin Wolf
19*cec551ecSArmin WolfUsually the FN keys work without a special driver. However as soon as the ``uniwill-laptop`` driver
20*cec551ecSArmin Wolfis loaded, the FN keys need to be handled manually. This is done automatically by the driver itself.
21*cec551ecSArmin Wolf
22*cec551ecSArmin WolfKeyboard settings
23*cec551ecSArmin Wolf-----------------
24*cec551ecSArmin Wolf
25*cec551ecSArmin WolfThe ``uniwill-laptop`` driver allows the user to enable/disable:
26*cec551ecSArmin Wolf
27*cec551ecSArmin Wolf - the FN and super key lock functionality of the integrated keyboard
28*cec551ecSArmin Wolf - the touchpad toggle functionality of the integrated touchpad
29*cec551ecSArmin Wolf
30*cec551ecSArmin WolfSee Documentation/ABI/testing/sysfs-driver-uniwill-laptop for details.
31*cec551ecSArmin Wolf
32*cec551ecSArmin WolfHwmon interface
33*cec551ecSArmin Wolf---------------
34*cec551ecSArmin Wolf
35*cec551ecSArmin WolfThe ``uniwill-laptop`` driver supports reading of the CPU and GPU temperature and supports up to
36*cec551ecSArmin Wolftwo fans. Userspace applications can access sensor readings over the hwmon sysfs interface.
37*cec551ecSArmin Wolf
38*cec551ecSArmin WolfPlatform profile
39*cec551ecSArmin Wolf----------------
40*cec551ecSArmin Wolf
41*cec551ecSArmin WolfSupport for changing the platform performance mode is currently not implemented.
42*cec551ecSArmin Wolf
43*cec551ecSArmin WolfBattery Charging Control
44*cec551ecSArmin Wolf------------------------
45*cec551ecSArmin Wolf
46*cec551ecSArmin WolfThe ``uniwill-laptop`` driver supports controlling the battery charge limit. This happens over
47*cec551ecSArmin Wolfthe standard ``charge_control_end_threshold`` power supply sysfs attribute. All values
48*cec551ecSArmin Wolfbetween 1 and 100 percent are supported.
49*cec551ecSArmin Wolf
50*cec551ecSArmin WolfAdditionally the driver signals the presence of battery charging issues through the standard
51*cec551ecSArmin Wolf``health`` power supply sysfs attribute.
52*cec551ecSArmin Wolf
53*cec551ecSArmin WolfLightbar
54*cec551ecSArmin Wolf--------
55*cec551ecSArmin Wolf
56*cec551ecSArmin WolfThe ``uniwill-laptop`` driver exposes the lightbar found on some models as a standard multicolor
57*cec551ecSArmin WolfLED class device. The default name of this LED class device is ``uniwill:multicolor:status``.
58*cec551ecSArmin Wolf
59*cec551ecSArmin WolfSee Documentation/ABI/testing/sysfs-driver-uniwill-laptop for details on how to control the various
60*cec551ecSArmin Wolfanimation modes of the lightbar.
61