From nobody Sun Apr 20 11:10:27 2025 X-Original-To: dev-commits-doc-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4ZgQlS0jfDz5sx67 for ; Sun, 20 Apr 2025 11:10:28 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R10" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4ZgQlR1ncRz3NX6; Sun, 20 Apr 2025 11:10:27 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1745147427; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=MmcKYF2QIQJ/BtZEbZa1JmuHqcnah2xBX94PkppVIPY=; b=SLoTT7kW7gwAkeJMhGsxb+0bkUi0ae94LupFp9hOw+nMFcdRjNvq4L3NMkGQ9RJdvT1tXs k7Am9zJ3kSWqe11XnGc3CzSwwYo6v6SrWKSv6Qk7M/Gc3M8trNDzEJLNXdZlOfLoqW6UkC pHJleokqKXy75JBMGa5cpcFYce+PdBT37LXBDHcolUj8As5cDkUkBTLyy/Xtb4lxNJAyB2 UuZdAGNCyKoRBKDWlntlMG+tvDL+pKCw316zSk8iCPKMQAaAFHUEacculUiM3CBt6KLxR/ FJ2pmNjqPTuApHar3w0rQXMrmjplb+UT80rt/xFRpKqVJqet/htA8UvsRlk2fw== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1745147427; a=rsa-sha256; cv=none; b=OXaB1t2aHN/lZQhQtvjwNJbGdZP82Sb1qKIAbMpu+IABljP7+G6nZyTFmc94WWAYXO3uua 0wliN4XW0GxG6MReuTfqlsYzC8OltLr1rUaPF+M/PbcIEIJjJGS/HFX32Z3ZKHk9s5TpQL efN9MphmNxxuHJnC9Pi4smX7C0hdEtkdqgX3+gxpGMYTyC+v0LryfuO1kbJ0cgOdNVYuez q3SuqAXhUKp62jvJwQBVGzT/Av+yyk4XIyMF73OvLS1kLdXhiIzb8FbMK/etmSzHRCESRj OT7JHPDUqGyXL1qILUSkjR/8Xobf5DwagyuEjWhYdxDOcs7f6f16hk/1lXAL+Q== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1745147427; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=MmcKYF2QIQJ/BtZEbZa1JmuHqcnah2xBX94PkppVIPY=; b=YqXOj+D07NTquGOM82D+p0SmrxW+KwAjbMOJhvjQ7B2aqBq7nB00wFQAsFDugb0zSe9wLk 9/rEyO5WFN9VWVnypipCQzPa1Ph7mRu051tHmVz9D5XsAJ7c5czWdGNScR9xnmA/SUDIfF bGaor8lNAMOcmMUFNFqtxrN4xMjxtFqfDeF9QP5BrHBFlZVYL/oTyraZfUlwHgzZ4PBDYw Rl5Zu8K+CLECg4dfxDblMh4+B7JM91YOjXn5eY6QiC1dmcQkbHj6JdkHcRD+C/2T8CtC0N MSs/u5ocshA0hvDmAyG6k7Cm7R/DKjyT7WvjQdYvH8oyO887ZNWiKvP9LQGIWw== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4ZgQlR1Cmrz129n; Sun, 20 Apr 2025 11:10:27 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.18.1/8.18.1) with ESMTP id 53KBARe1096863; Sun, 20 Apr 2025 11:10:27 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.18.1/8.18.1/Submit) id 53KBARZf096860; Sun, 20 Apr 2025 11:10:27 GMT (envelope-from git) Date: Sun, 20 Apr 2025 11:10:27 GMT Message-Id: <202504201110.53KBARZf096860@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Lorenzo Salvadore Subject: git: ada3a879ac - main - Status/2025Q1/framework-kmod.adoc: Add report List-Id: Commit messages for all branches of the doc repository List-Archive: https://lists.freebsd.org/archives/dev-commits-doc-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-doc-all@freebsd.org Sender: owner-dev-commits-doc-all@FreeBSD.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: salvadore X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: ada3a879ac129abcc3483a0793c589db3127017b Auto-Submitted: auto-generated The branch main has been updated by salvadore: URL: https://cgit.FreeBSD.org/doc/commit/?id=ada3a879ac129abcc3483a0793c589db3127017b commit ada3a879ac129abcc3483a0793c589db3127017b Author: Chris Moerz AuthorDate: 2025-04-20 11:07:21 +0000 Commit: Lorenzo Salvadore CommitDate: 2025-04-20 11:10:11 +0000 Status/2025Q1/framework-kmod.adoc: Add report Differential Revision: https://reviews.freebsd.org/D49912 --- .../report-2025-01-2025-03/framework-kmod.adoc | 31 ++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/website/content/en/status/report-2025-01-2025-03/framework-kmod.adoc b/website/content/en/status/report-2025-01-2025-03/framework-kmod.adoc new file mode 100644 index 0000000000..4f5455ac12 --- /dev/null +++ b/website/content/en/status/report-2025-01-2025-03/framework-kmod.adoc @@ -0,0 +1,31 @@ +=== Framework Kernel Module + +Links: + +link:https://github.com/christian-moerz/framework-kmod[GitHub] URL: https://github.com/christian-moerz/framework-kmod[] + +link:https://bugs.freebsd.org/285448[Bugzilla] URL: https://bugs.freebsd.org/285448[] + +Contact: Chris Moerz + +The development of the `framework-kmod` kernel module originated from discussions and collaborative efforts within the link:https://wiki.freebsd.org/LaptopDesktopWorkingGroup[FreeBSD Laptop and Desktop Workgroup (LDWG)]. +This module addresses a specific need for dynamic screen dimming functionality, particularly suited for environments where full-featured desktop environments are not in use. + +The primary feature of the framework-kmod kernel module is to dynamically dim the screen when the computer is not in use and to restore brightness upon detecting user activity. +This functionality is designed to enhance power efficiency and user experience, especially in minimalistic setups. + +By default, the module dims the screen very aggressively, dimming it after approximately one second of inactivity. +This behavior ensures immediate power savings but may need adjustment based on user preferences. +The module's settings can be customized through sysctls, allowing users to tailor the behavior to their needs. +Users can set different brightness levels for the dimmed and bright states, adjust the length of time that needs to pass without any input signal before dimming the screen, and apply different settings depending on whether the laptop is running on a power outlet or battery. +Brightness levels can also be adjusted through the use of the keyboard's brightness control keys. + +The module tracks input signals through man:evdev[4]. +If no input is detected within the set timeout period, the screen brightness is reduced. +Upon detecting user input, the brightness is immediately restored to the previous level. +The module requires drm-kmod drivers to be loaded in advance, ensuring compatibility with the necessary graphics drivers. + +The framework-kmod is not a general-purpose screen dimming driver. +It is specifically designed for use with tty consoles or simple window managers like suckless' dwm or i3. +Users of full-featured desktop environments like Gnome or KDE are advised to use the built-in screen dimming functions provided by those environments. + +The development of this module was driven by the needs identified during LDWG calls, highlighting the collaborative nature of the workgroup. +A link:https://bugs.freebsd.org/285448[port of the framework-kmod] has been submitted, making it accessible for broader use and further development by the FreeBSD community.