]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
Documentation: PM: Document intel_idle.table command line option
authorArtem Bityutskiy <artem.bityutskiy@linux.intel.com>
Thu, 5 Feb 2026 12:53:54 +0000 (12:53 +0000)
committerRafael J. Wysocki <rafael.j.wysocki@intel.com>
Wed, 11 Feb 2026 20:08:23 +0000 (21:08 +0100)
Add the 'intel_idle.table' command line option description to the
intel_idle document in admin-guide.

Signed-off-by: Artem Bityutskiy <artem.bityutskiy@linux.intel.com>
[ rjw: Subject adjustment, changelog edits]
Link: https://patch.msgid.link/20260205125354.632891-1-artem.bityutskiy@linux.intel.com
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
Documentation/admin-guide/pm/intel_idle.rst

index ed6f055d4b148e5beda28bf1e5257e2ea0e120d4..188d52cd26e85142e5fd0a72355cfde89a4c4466 100644 (file)
@@ -260,6 +260,17 @@ mode to off when the CPU is in any one of the available idle states.  This may
 help performance of a sibling CPU at the expense of a slightly higher wakeup
 latency for the idle CPU.
 
+The ``table`` argument allows customization of idle state latency and target
+residency. The syntax is a comma-separated list of ``name:latency:residency``
+entries, where ``name`` is the idle state name, ``latency`` is the exit latency
+in microseconds, and ``residency`` is the target residency in microseconds. It
+is not necessary to specify all idle states; only those to be customized. For
+example, ``C1:1:3,C6:50:100`` sets the exit latency and target residency for
+C1 and C6 to 1/3 and 50/100 microseconds, respectively. Remaining idle states
+keep their default values. The driver verifies that deeper idle states have
+higher latency and target residency than shallower ones. Also, target
+residency cannot be smaller than exit latency. If any of these conditions is
+not met, the driver ignores the entire ``table`` parameter.
 
 .. _intel-idle-core-and-package-idle-states: