Re: [PATCH v4 22/63] Documentation: ACPI: move lpit.txt to firmware-guide/acpi and convert to reST

Mauro Carvalho Chehab
2019-04-24T14:49:47Z

Em Wed, 24 Apr 2019 00:28:51 +0800
Changbin Du <changbin.du@gmail.com> escreveu:

> This converts the plain text documentation to reStructuredText format and
> add it to Sphinx TOC tree. No essential content change.
>
> Signed-off-by: Changbin Du <changbin.du@gmail.com>

Reviewed-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>

> ---
> Documentation/firmware-guide/acpi/index.rst | 1 +
> .../lpit.txt => firmware-guide/acpi/lpit.rst} | 18 +++++++++++++-----
> 2 files changed, 14 insertions(+), 5 deletions(-)
> rename Documentation/{acpi/lpit.txt => firmware-guide/acpi/lpit.rst} (68%)
>
> diff --git a/Documentation/firmware-guide/acpi/index.rst b/Documentation/firmware-guide/acpi/index.rst
> index fca854f017d8..0e60f4b7129a 100644
> --- a/Documentation/firmware-guide/acpi/index.rst
> +++ b/Documentation/firmware-guide/acpi/index.rst
> @@ -22,3 +22,4 @@ ACPI Support
> gpio-properties
> i2c-muxes
> acpi-lid
> + lpit
> diff --git a/Documentation/acpi/lpit.txt b/Documentation/firmware-guide/acpi/lpit.rst
> similarity index 68%
> rename from Documentation/acpi/lpit.txt
> rename to Documentation/firmware-guide/acpi/lpit.rst
> index b426398d2e97..aca928fab027 100644
> --- a/Documentation/acpi/lpit.txt
> +++ b/Documentation/firmware-guide/acpi/lpit.rst
> @@ -1,3 +1,9 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +===========================
> +Low Power Idle Table (LPIT)
> +===========================
> +
> To enumerate platform Low Power Idle states, Intel platforms are using
> “Low Power Idle Table” (LPIT). More details about this table can be
> downloaded from:
> @@ -8,13 +14,15 @@ Residencies for each low power state can be read via FFH
>
> On platforms supporting S0ix sleep states, there can be two types of
> residencies:
> -- CPU PKG C10 (Read via FFH interface)
> -- Platform Controller Hub (PCH) SLP_S0 (Read via memory mapped interface)
> +
> + - CPU PKG C10 (Read via FFH interface)
> + - Platform Controller Hub (PCH) SLP_S0 (Read via memory mapped interface)
>
> The following attributes are added dynamically to the cpuidle
> -sysfs attribute group:
> - /sys/devices/system/cpu/cpuidle/low_power_idle_cpu_residency_us
> - /sys/devices/system/cpu/cpuidle/low_power_idle_system_residency_us
> +sysfs attribute group::
> +
> + /sys/devices/system/cpu/cpuidle/low_power_idle_cpu_residency_us
> + /sys/devices/system/cpu/cpuidle/low_power_idle_system_residency_us
>
> The "low_power_idle_cpu_residency_us" attribute shows time spent
> by the CPU package in PKG C10

Thanks,
Mauro