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, 28 Apr 2022 17:14:37 +0800
From:   Huang Rui <ray.huang@amd.com>
To:     "Meng, Li (Jassmine)" <Li.Meng@amd.com>
Cc:     Shuah Khan <skhan@linuxfoundation.org>,
        "linux-pm@vger.kernel.org" <linux-pm@vger.kernel.org>,
        "Rafael J . Wysocki" <rafael.j.wysocki@intel.com>,
        "Fontenot, Nathan" <Nathan.Fontenot@amd.com>,
        "Sharma, Deepak" <Deepak.Sharma@amd.com>,
        "Deucher, Alexander" <Alexander.Deucher@amd.com>,
        "Limonciello, Mario" <Mario.Limonciello@amd.com>,
        "Su, Jinzhou (Joe)" <Jinzhou.Su@amd.com>,
        "Yuan, Perry" <Perry.Yuan@amd.com>,
        "Du, Xiaojian" <Xiaojian.Du@amd.com>,
        Viresh Kumar <viresh.kumar@linaro.org>,
        Borislav Petkov <bp@alien8.de>,
        "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH V4 3/3] Documentation: amd-pstate: Add unit test
 introduction
Message-ID: <Ympa/YusPdnYhfRH@amd.com>
References: <20220427135315.3447550-1-li.meng@amd.com>
 <20220427135315.3447550-4-li.meng@amd.com>
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <20220427135315.3447550-4-li.meng@amd.com>
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?cGXfx0hFVFN6/CBnsvpZw0HPCblc3ap+lGWd4l3VX4xvzvOIHBxEKUmvc/Hk?=
 =?us-ascii?Q?0SrWiyM0vpsp72q/5YLZKhHqYhWkMtE6u3DJSE8orkwYaPcD0otfbX1+zosh?=
 =?us-ascii?Q?ONGhS3bJZB4mIuImERLAxZKPKQwpl8SIX9CAvempaMCQmqJ8R1XBRCgnfSU4?=
 =?us-ascii?Q?z6dMoZsKgGXOFCibzL97Mo5BxedZhpphK5UEyEyvh62qTbA2oAvdXzxJCPb7?=
 =?us-ascii?Q?tJ0LS1h+tEccbBHfVNj4DwLXCKTNnjnTFg/bnNm2vPUhFGjHv0byTQ6KYEAM?=
 =?us-ascii?Q?06lcICZudzpy5fRq1cUkB6d+RMl3LY1WBeaiHcNt6u3lRsujLxrNRuRKUBir?=
 =?us-ascii?Q?RYTiR85IsyTT3bKDv14LYEp8JY+ZjwaixWE2N/InQEhx2s3sQkw23bMQ3HSi?=
 =?us-ascii?Q?689v8fefMfHX//Ov3sPxs0qMijiibZlo1y75y+kYal9cjZfN5+FL6QENBKJf?=
 =?us-ascii?Q?HJG8UVUEg30IQ93dMZJQ5gHtgpwbxI/vjCbJfjZ24gYBlkqUF7jF7CgSfQQw?=
 =?us-ascii?Q?dttS7xqy86ZOlr4U+tsKdCayxbBGhk5BE4GAkwAnXr68UYnKWYT64KY6Myt9?=
 =?us-ascii?Q?Yd1trCy1tpcEdBiQAp9tZwNyILUz0/OLXmB2+7BcXTnazXYwwDWX8/cBP64Y?=
 =?us-ascii?Q?c2G8zpbVPqPLqXqfYOxtttwu41cAtCOJ2DlQ8bT3Y5RH7F6HW8kxxTFm7Hde?=
 =?us-ascii?Q?hdJbBrekEOT3U9QwbYMPAeuzmUFBE5ryoDne13aCn4F8jwYAm6lmdT2kGLMW?=
 =?us-ascii?Q?47uESEoiTMOAVcTZReEa6Fp1o9/j9WoXIkrJ06FXcsCSB9ZNUKq2taqrWkbh?=
 =?us-ascii?Q?401D3QEJpMkxs+dhHvvRb5FY2Wp8srkesMU5cPaJkEDg1rCacf5ms6+UyylN?=
 =?us-ascii?Q?QYTv9waUMv5Af6vdbJ+eg/amyrPfYsNYexdIylfZhLP5wzsYOjw1KTP46xlj?=
 =?us-ascii?Q?0X0QPiv2n53jgB+LwRDLGaV4T/6G/EzBpbX31QwQpvpU14Yy47TCBscHXWC1?=
 =?us-ascii?Q?PLuNFS7dl+xmpRRqnQxuv/nUB29iBt5Sy3VjVd58O19C/DB+y9C0xhxDstuC?=
 =?us-ascii?Q?L0HNMLL5EGsfD0hcEVYtJ3LWz+WYvtepn/v0Vmdk0YeJdJwjav3HaEy5DYW4?=
 =?us-ascii?Q?KfV426ekG3esP57HFyMjaPNGxYry3cce9GwDC3tSEZRRYpLnl3ZSx0+x+Zmh?=
 =?us-ascii?Q?VOaM2MS5mRYaGWlqTbs7Je4NH2KF2glYbUNvkva+OYs8Pjr9G8Q9Pjy7jZuP?=
 =?us-ascii?Q?D5gaLo5TP5lBGWSjZiJ5TG0MRKI257xbDLTVaLOfiymA0/A8Lr59qLa2Xkuq?=
 =?us-ascii?Q?wj2dPciBpxO7GQ6XsLP1RSZggaS1v3uypDh/BUSYabvmPL15M1np04T4BjvX?=
 =?us-ascii?Q?ZLhx3zlwq+2wZH/ct4rUd8OBEQYEYRwysnDYdMzcO0W6RNO33KeCWyB9qZTp?=
 =?us-ascii?Q?ujEnV2NmsgluHQLXKCl4ZmtfOyevu1oJTOgAvo1qNDjF5YKqQU/6euFe3iFB?=
 =?us-ascii?Q?KQ0LDQjWmgu6YvrBAID2fbhpriOXL+Q/TQfAmeBDWatoCY6e8GKvqm3LOD1J?=
 =?us-ascii?Q?crVsAwPA3s+uWs7aM2uOOGsdJVDHM/z+v6Xf0ipjWM4UZMluc7oLartfPwLs?=
 =?us-ascii?Q?I0BCBQmQ+/1MMfsy/gs9om+Jk1mcXFxh65srmaK4+vzroKh7JDT8R7TApLdH?=
 =?us-ascii?Q?oyBxBVwMOQuUtGqS+ENTwYa8NDyELq+IDakysMRDY7ZO3QigibMcQPP7jjSp?=
 =?us-ascii?Q?XCPMbRkcmw=3D=3D?=
X-OriginatorOrg: amd.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 1a4e0027-17a1-4918-6668-08da28f79259
X-MS-Exchange-CrossTenant-AuthSource: DM5PR12MB2504.namprd12.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 28 Apr 2022 09:15:00.5117
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 3dd8961f-e488-4e60-8e11-a82d994e183d
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: 7k0GbCtgcUfio3MObHUj1XDAAD3kXgSsJRCrnTOab6427IunviZgXI1j8nHxbH608p57jfISVS4TybAnk0BbHQ==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM5PR1201MB2472
X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_NONE,
        RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,SPF_PASS autolearn=ham
        autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

On Wed, Apr 27, 2022 at 09:53:15PM +0800, Meng, Li (Jassmine) wrote:
> Introduce the AMD P-State unit test module design and implementation.
> 
> Signed-off-by: Meng Li <li.meng@amd.com>
> ---
>  Documentation/admin-guide/pm/amd-pstate.rst | 87 +++++++++++++++++++++
>  1 file changed, 87 insertions(+)
> 
> diff --git a/Documentation/admin-guide/pm/amd-pstate.rst b/Documentation/admin-guide/pm/amd-pstate.rst
> index 83b58eb4ab4d..395b8b5c680c 100644
> --- a/Documentation/admin-guide/pm/amd-pstate.rst
> +++ b/Documentation/admin-guide/pm/amd-pstate.rst
> @@ -182,6 +182,7 @@ to the ``struct sugov_cpu`` that the utilization update belongs to.
>  Then, ``amd-pstate`` updates the desired performance according to the CPU
>  scheduler assigned.
>  
> +.. _processor_support:
>  
>  Processor Support
>  =======================
> @@ -282,6 +283,8 @@ efficiency frequency management method on AMD processors.
>  Kernel Module Options for ``amd-pstate``
>  =========================================
>  
> +.. _shared_mem:
> +
>  ``shared_mem``
>  Use a module param (shared_mem) to enable related processors manually with
>  **amd_pstate.shared_mem=1**.
> @@ -393,6 +396,87 @@ about part of the output. ::
>   CPU_005     712          116384        39        49        166       0.7565  9645075 2214891 38431470  25.1   11.646       469         2.496         kworker/5:0-40
>   CPU_006     712          116408        39        49        166       0.6769  8950227 1839034 37192089  24.06  11.272       470         2.496         kworker/6:0-1264
>  
> +Unit Tests for amd-pstate
> +-------------------------
> +
> +``amd-pstate-ut`` is a test module for testing the ``amd-pstate`` driver.
> +
> + * It can help all users to verify their processor support (SBIOS/Firmware or Hardware).
> +
> + * Kernel can have a basic function test to avoid the kernel regression during the update.
> +
> + * We can introduce more functional or performance tests to align the result together, it will benefit power and performance scale optimization.
> +
> +1. Test case decriptions
> +
> +        +---------+--------------------------------+------------------------------------------------------------------------------------+
> +        | Index   | Functions                      | Description                                                                        |
> +        +=========+================================+====================================================================================+
> +        | 0       | aput_acpi_cpc                  || Check whether the _CPC object is present in SBIOS.                                |
> +        |         |                                ||                                                                                   |
> +        |         |                                || The detail refer to `Processor Support <processor_support_>`_.                    |
> +        +---------+--------------------------------+------------------------------------------------------------------------------------+
> +        | 1       | aput_check_enabled             || Check whether AMD P-State is enabled.                                             |
> +        |         |                                ||                                                                                   |
> +        |         |                                || AMD P-States and ACPI hardware P-States always can be supported in one processor. |
> +        |         |                                | But AMD P-States has the higher priority and if it is enabled with                 |
> +        |         |                                | :c:macro:`MSR_AMD_CPPC_ENABLE` or ``cppc_set_enable``, it will respond to the      |
> +        |         |                                | request from AMD P-States.                                                         |
> +        +---------+--------------------------------+------------------------------------------------------------------------------------+
> +        | 2       | aput_check_perf                || Check if the each performance values are reasonable.                              |
> +        |         |                                || highest_perf >= nominal_perf > lowest_nonlinear_perf > lowest_perf > 0.           |
> +        +---------+--------------------------------+------------------------------------------------------------------------------------+
> +        | 3       | aput_check_freq                || Check if the each frequency values and max freq when set support boost mode       |
> +        |         |                                | are reasonable.                                                                    |
> +        |         |                                || max_freq >= nominal_freq > lowest_nonlinear_freq > min_freq > 0                   |
> +        |         |                                || If boost is not active but supported, this maximum frequency will be larger than  |
> +        |         |                                | the one in ``cpuinfo``.                                                            |
> +        +---------+--------------------------------+------------------------------------------------------------------------------------+
> +
> +#. How to execute the tests
> +
> +   We use test module in the kselftest frameworks to implement it.
> +   We create amd-pstate-ut module and tie it into kselftest.(for
> +   details refer to Linux Kernel Selftests [4]_).
> +
> +    1. Build ::
> +
> +        jasminemeng@jasmine-meng:~/amd-brahma$ cd linux
> +        jasminemeng@jasmine-meng:~/amd-brahma/linux$ make modules M=tools/testing/selftests/amd-pstate/amd-pstate-ut
> +          CC [M]  tools/testing/selftests/amd-pstate/amd-pstate-ut/amd-pstate-ut.o
> +          MODPOST tools/testing/selftests/amd-pstate/amd-pstate-ut/Module.symvers
> +          CC [M]  tools/testing/selftests/amd-pstate/amd-pstate-ut/amd-pstate-ut.mod.o
> +          LD [M]  tools/testing/selftests/amd-pstate/amd-pstate-ut/amd-pstate-ut.ko
> +          BTF [M] tools/testing/selftests/amd-pstate/amd-pstate-ut/amd-pstate-ut.ko
> +        jasminemeng@jasmine-meng:~/amd-brahma/linux$ make -C tools/testing/selftests
> +
> +    #. Installation & Steps ::
> +
> +        jasmine@jasmine-MayanDAP-RMB:~/amd-brahma/linux$ make -C tools/testing/selftests install INSTALL_PATH=~/kselftest
> +        jasmine@jasmine-MayanDAP-RMB:~$ sudo cp amd-pstate-ut.ko /lib/modules/5.18.0-rc2+/

We should not mention a specfic kernel version "5.18.0-rc2+" here.

> +        jasmine@jasmine-MayanDAP-RMB:~$ sudo depmod
> +        jasmine@jasmine-MayanDAP-RMB:~$ sudo ./kselftest/run_kselftest.sh -c amd-pstate

"Can we move "insmod/rmmod amd-pstate-ut.ko" stuff into script amd_pstate_ut.sh?

Thanks,
Ray

> +        TAP version 13
> +        1..1
> +        # selftests: amd-pstate: amd-pstate-ut.sh
> +        # amd-pstate-ut: ok
> +        ok 1 selftests: amd-pstate: amd-pstate-ut.sh
> +
> +    #. Results ::
> +
> +         jasmine@jasmine-MayanDAP-RMB:~$ dmesg | grep "amd-pstate-ut" | tee log.txt
> +         [76697.480217] amd-pstate-ut: loaded.
> +         [76697.480222] amd-pstate-ut: ****** Begin 1             acpi_cpc_valid          ******
> +         [76697.480227] amd-pstate-ut: ****** End   1             acpi_cpc_valid          ******
> +         [76697.480228] amd-pstate-ut: ****** Begin 2             check_enabled           ******
> +         [76697.480253] amd-pstate-ut: ****** End   2             check_enabled           ******
> +         [76697.480255] amd-pstate-ut: ****** Begin 3             check_perf              ******
> +         [76697.480554] amd-pstate-ut: ****** End   3             check_perf              ******
> +         [76697.480556] amd-pstate-ut: ****** Begin 4             check_freq              ******
> +         [76697.480558] amd-pstate-ut: ****** End   4             check_freq              ******
> +         [76697.480559] amd-pstate-ut: all 4 tests passed
> +         [76697.482507] amd-pstate-ut: unloaded.
> +
>  
>  Reference
>  ===========
> @@ -405,3 +489,6 @@ Reference
>  
>  .. [3] Processor Programming Reference (PPR) for AMD Family 19h Model 51h, Revision A1 Processors
>         https://www.amd.com/system/files/TechDocs/56569-A1-PUB.zip
> +
> +.. [4] Linux Kernel Selftests,
> +       https://www.kernel.org/doc/html/latest/dev-tools/kselftest.html
> -- 
> 2.25.1
>