Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Date:   Thu, 8 Dec 2022 09:59:40 +0700
From:   Bagas Sanjaya <bagasdotme@gmail.com>
To:     Wyes Karny <wyes.karny@amd.com>, linux-doc@vger.kernel.org,
        linux-kernel@vger.kernel.org, linux-pm@vger.kernel.org
Cc:     Jonathan Corbet <corbet@lwn.net>, Huang Rui <ray.huang@amd.com>,
        "Rafael J . Wysocki" <rafael@kernel.org>,
        Viresh Kumar <viresh.kumar@linaro.org>,
        Mario.Limonciello@amd.com, Perry.Yuan@amd.com,
        Ananth Narayan <ananth.narayan@amd.com>, gautham.shenoy@amd.com
Subject: Re: [PATCH 4/4] Documentation: amd_pstate: Add amd_pstate state
 sysfs file
Message-ID: <Y5FTHGsezkdzwvUa@debian.me>
References: <20221207154648.233759-1-wyes.karny@amd.com>
 <20221207154648.233759-5-wyes.karny@amd.com>
MIME-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha256;
        protocol="application/pgp-signature"; boundary="w3Iq/EiQLaZI2tbc"
Content-Disposition: inline
In-Reply-To: <20221207154648.233759-5-wyes.karny@amd.com>
Precedence: bulk


--w3Iq/EiQLaZI2tbc
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

On Wed, Dec 07, 2022 at 03:46:48PM +0000, Wyes Karny wrote:
> +``state``
> +
> +``amd_pstate`` also exposes a sysfs interface to view and control the dr=
iver state.
> +The driver state can be one of the following:
> +``disable``     : indicates driver is in unloaded state.
> +``passive``     : indicates driver is loaded and currently in passive mo=
de.
> +``guided`` : indicates driver is loaded and currenlty in guided autonomo=
us mode.

Use bullet lists for above:

---- >8 ----

diff --git a/Documentation/admin-guide/pm/amd-pstate.rst b/Documentation/ad=
min-guide/pm/amd-pstate.rst
index 4d3783516ddc2c..0d0e0affa3adb2 100644
--- a/Documentation/admin-guide/pm/amd-pstate.rst
+++ b/Documentation/admin-guide/pm/amd-pstate.rst
@@ -269,9 +269,12 @@ Other performance and frequency values can be read bac=
k from
=20
 ``amd_pstate`` also exposes a sysfs interface to view and control the driv=
er state.
 The driver state can be one of the following:
-``disable``     : indicates driver is in unloaded state.
-``passive``     : indicates driver is loaded and currently in passive mode.
-``guided`` : indicates driver is loaded and currenlty in guided autonomous=
 mode.
+
+  - ``disable``     : indicates driver is in unloaded state.
+  - ``passive``     : indicates driver is loaded and currently in passive =
mode.
+  - ``guided``      : indicates driver is loaded and currenlty in guided
+    autonomous mode.
+
 This file can be found here: ``/sys/devices/system/cpu/amd_pstate/state``.
=20
 To switch to passive mode: ``echo passive > /sys/devices/system/cpu/amd_ps=
tate/state``

> +This file can be found here: ``/sys/devices/system/cpu/amd_pstate/state`=
`.
> +
> +To switch to passive mode: ``echo passive > /sys/devices/system/cpu/amd_=
pstate/state``
> +To switch to guided mode: ``echo guided > /sys/devices/system/cpu/amd_ps=
tate/state``
> =20

What about these wordings instead?

---- >8 ----
=20
diff --git a/Documentation/admin-guide/pm/amd-pstate.rst b/Documentation/ad=
min-guide/pm/amd-pstate.rst
index 4d3783516ddc2c..6465bd39b7dcbc 100644
--- a/Documentation/admin-guide/pm/amd-pstate.rst
+++ b/Documentation/admin-guide/pm/amd-pstate.rst
@@ -267,15 +267,16 @@ Other performance and frequency values can be read ba=
ck from
=20
 ``state``
=20
-``amd_pstate`` also exposes a sysfs interface to view and control the driv=
er state.
-The driver state can be one of the following:
-``disable``     : indicates driver is in unloaded state.
-``passive``     : indicates driver is loaded and currently in passive mode.
-``guided`` : indicates driver is loaded and currenlty in guided autonomous=
 mode.
-This file can be found here: ``/sys/devices/system/cpu/amd_pstate/state``.
+``amd_pstate`` also exposes a sysfs interface to view and control the driv=
er
+state, named ``/sys/devices/system/cpu/amd_pstate/state``. The driver state
+can be one of the following:
=20
-To switch to passive mode: ``echo passive > /sys/devices/system/cpu/amd_ps=
tate/state``
-To switch to guided mode: ``echo guided > /sys/devices/system/cpu/amd_psta=
te/state``
+  - ``disable``     : the driver is disabled
+  - ``passive``     : the driver is in passive mode.
+  - ``guided``      : the driver is in guided autonomous mode.
+
+To switch between these modes above, write the appropriate value to the
+aforementioned sysfs file.
=20
 ``amd-pstate`` vs ``acpi-cpufreq``
 =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D

Thanks.

--=20
An old man doll... just what I always wanted! - Clara

--w3Iq/EiQLaZI2tbc
Content-Type: application/pgp-signature; name="signature.asc"

-----BEGIN PGP SIGNATURE-----

iHUEABYIAB0WIQSSYQ6Cy7oyFNCHrUH2uYlJVVFOowUCY5FTFwAKCRD2uYlJVVFO
o7/DAQDPXGzLP5B1ne8T+5hevkqKMCiwgB/oB/HYAhJZ1jExZwD9HbebcQeg02sU
qzgZxy4OPhhoERSe5BwnLYt0kWYvJgk=
=x2DH
-----END PGP SIGNATURE-----

--w3Iq/EiQLaZI2tbc--