mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@infradead.org>
To: Armin Wolf <W_Armin@gmx.de>,
	ilpo.jarvinen@linux.intel.com, hdegoede@redhat.com,
	chumuzero@gmail.com, corbet@lwn.net, cs@tuxedo.de,
	wse@tuxedocomputers.com, ggo@tuxedocomputers.com
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
	platform-driver-x86@vger.kernel.org
Subject: Re: [RFC PATCH 3/3] Documentation: laptops: Add documentation for uniwill laptops
Date: Tue, 17 Jun 2025 23:23:46 -0700	[thread overview]
Message-ID: <45184ccd-04c7-4883-9500-8a628272c2cd@infradead.org> (raw)
In-Reply-To: <20250615175957.9781-4-W_Armin@gmx.de>

Hi,

On 6/15/25 10:59 AM, Armin Wolf wrote:
> Add documentation for admins regarding Uniwill laptops. This should
> help users to setup the uniwill-laptop and uniwill-wmi drivers, which
> sadly cannot be loaded automatically.
> 
> Reported-by: cyear <chumuzero@gmail.com>
> Closes: https://github.com/lm-sensors/lm-sensors/issues/508
> Closes: https://github.com/Wer-Wolf/uniwill-laptop/issues/3
> Signed-off-by: Armin Wolf <W_Armin@gmx.de>
> ---
>  Documentation/admin-guide/laptops/index.rst   |  1 +
>  .../admin-guide/laptops/uniwill-laptop.rst    | 68 +++++++++++++++++++
>  MAINTAINERS                                   |  1 +
>  3 files changed, 70 insertions(+)
>  create mode 100644 Documentation/admin-guide/laptops/uniwill-laptop.rst


> diff --git a/Documentation/admin-guide/laptops/uniwill-laptop.rst b/Documentation/admin-guide/laptops/uniwill-laptop.rst
> new file mode 100644
> index 000000000000..8b977c09e747
> --- /dev/null
> +++ b/Documentation/admin-guide/laptops/uniwill-laptop.rst
> @@ -0,0 +1,68 @@
> +.. SPDX-License-Identifier: GPL-2.0+
> +
> +Uniwill laptop extra features
> +=============================
> +
> +On laptops manufactured by Uniwill (either directly or as ODM), the ``uniwill-laptop`` and
> +``uniwill-wmi`` driver both handle various platform-specific features.
> +However due to a design flaw in the underlying firmware interface, both drivers might need
> +to be loaded manually on some devices.
> +
> +.. warning:: Not all devices supporting the firmware interface will necessarily support those
> +             drivers, please be careful.
> +
> +Module Loading
> +--------------
> +
> +The ``uniwill-laptop`` driver relies on a DMI table to automatically load on supported devices.
> +When using the ``force`` module parameter, this DMI check will be omitted, allowing the driver
> +to be loaded on unsupported devices for testing purposes.
> +
> +The ``uniwill-wmi`` driver always needs to be loaded manually. However the ``uniwill-laptop``
> +driver will automatically load it as a dependency.
> +
> +Hotkeys
> +-------
> +
> +Usually the FN keys work without a special driver. However as soon as the ``uniwill-laptop`` driver
> +is loaded, the FN keys need to be handled manually. This is done by the ``uniwill-wmi`` driver.
> +
> +Keyboard settings
> +-----------------
> +
> +The ``uniwill-laptop`` driver allows the user to enable/disable:
> +
> + - the FN and super key lock functionality of the integrated keyboard
> + - the touchpad toggle functionality of the integrated touchpad

What is this touchpad toggle functionality, please?

> +
> +See Documentation/ABI/testing/sysfs-driver-uniwill-laptop for details.
> +
> +Hwmon interface
> +---------------
> +
> +The ``uniwill-laptop`` driver supports reading of the CPU and GPU temperature and supports up to
> +two fans. Userspace applications can access sensor readings over the hwmon sysfs interface.
> +
> +Platform profile
> +----------------
> +
> +Support for changing the platform performance mode is currently not implemented.
> +
> +Battery Charging Control
> +------------------------
> +
> +The ``uniwill-laptop`` driver supports controlling the battery charge limit. This happens over
> +the standard ``charge_control_end_threshold`` power supply sysfs attribute. All values
> +between 1 and 100 percent are supported.
> +
> +Additionally the driver signals the presence of battery charging issues thru the standard ``health``
> +power supply sysfs attribute.
> +
> +Lightbar
> +--------
> +
> +The ``uniwill-laptop`` driver exposes the lightbar found on some models as a standard multicolor
> +led class device. The default name of this led class device is ``uniwill:multicolor:status``.

s/led/LED/ 2 places, preferably.

> +
> +See Documentation/ABI/testing/sysfs-driver-uniwill-laptop for details on how to control the various
> +animation modes of the lightbar.

-- 
~Randy


  reply	other threads:[~2025-06-18  6:24 UTC|newest]

Thread overview: 40+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-06-15 17:59 [RFC PATCH 0/3] platform/x86: Add support for Uniwill laptop features Armin Wolf
2025-06-15 17:59 ` [RFC PATCH 1/3] platform/x86: Add Uniwill WMI driver Armin Wolf
2025-06-15 18:46   ` Randy Dunlap
2025-06-15 19:05   ` ALOK TIWARI
2025-06-17 20:58     ` Armin Wolf
2025-06-15 20:32   ` Randy Dunlap
2025-06-16  9:21   ` Hans de Goede
2025-06-17 21:10     ` Armin Wolf
2025-06-18  7:23       ` Hans de Goede
2025-06-16 11:14   ` Werner Sembach
2025-06-15 17:59 ` [RFC PATCH 2/3] platform/x86: Add Uniwill laptop driver Armin Wolf
2025-06-15 19:00   ` Randy Dunlap
2025-06-17 21:40     ` Armin Wolf
2025-06-15 20:39   ` Randy Dunlap
2025-06-16  8:10   ` Ilpo Järvinen
2025-06-17 21:47     ` Armin Wolf
2025-06-16 12:32   ` Werner Sembach
2025-06-17 21:50     ` Armin Wolf
2025-06-18 11:15       ` Werner Sembach
2025-06-22 18:58         ` Armin Wolf
2025-06-16 12:46   ` Werner Sembach
2025-06-17 21:52     ` Armin Wolf
2025-06-19  9:47       ` Lee Jones
2025-06-19 12:30         ` Hans de Goede
2025-06-19 15:17           ` Lee Jones
2025-06-19 20:03             ` Hans de Goede
2025-06-22 19:19               ` Armin Wolf
2025-06-22 21:37   ` Pőcze Barnabás
2025-06-22 22:36     ` Armin Wolf
2025-06-25 15:59       ` Pőcze Barnabás
2025-06-27 23:09         ` Armin Wolf
2025-06-30 12:32           ` Werner Sembach
2025-06-30 12:40             ` Armin Wolf
2025-06-30 12:55               ` Werner Sembach
2025-06-30 13:21                 ` Armin Wolf
2025-06-15 17:59 ` [RFC PATCH 3/3] Documentation: laptops: Add documentation for uniwill laptops Armin Wolf
2025-06-18  6:23   ` Randy Dunlap [this message]
2025-06-18 20:06     ` Armin Wolf
2025-06-16 12:59 ` [RFC PATCH 0/3] platform/x86: Add support for Uniwill laptop features Werner Sembach
2025-06-17 22:02   ` Armin Wolf

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=45184ccd-04c7-4883-9500-8a628272c2cd@infradead.org \
    --to=rdunlap@infradead.org \
    --cc=W_Armin@gmx.de \
    --cc=chumuzero@gmail.com \
    --cc=corbet@lwn.net \
    --cc=cs@tuxedo.de \
    --cc=ggo@tuxedocomputers.com \
    --cc=hdegoede@redhat.com \
    --cc=ilpo.jarvinen@linux.intel.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=platform-driver-x86@vger.kernel.org \
    --cc=wse@tuxedocomputers.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®