linux-kernel - [PATCH v2 0/1] x86/mtrr: Fix kernel-doc warnings in amd.c and centaur.c

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20251026195511.79300-1-dev@kael-k.io>
Date: Sun, 26 Oct 2025 20:54:41 +0100
From: Kael D'Alcamo <dev@...l-k.io>
To: Thomas Gleixner <tglx@...utronix.de>,
	Ingo Molnar <mingo@...hat.com>,
	Borislav Petkov <bp@...en8.de>,
	Dave Hansen <dave.hansen@...ux.intel.com>
Cc: x86@...nel.org,
	"H. Peter Anvin" <hpa@...or.com>,
	linux-kernel@...r.kernel.org
Subject: [PATCH v2 0/1] x86/mtrr: Fix kernel-doc warnings in amd.c and centaur.c

Hi Boris,

Thank you for your feedback

>> Signed-off-by: Kael D'Alcamo <dev@...l-k.io>
>> ---
>>  arch/x86/kernel/cpu/mtrr/centaur.c | 1 +
>>  1 file changed, 1 insertion(+)
>> 
>> diff --git a/arch/x86/kernel/cpu/mtrr/centaur.c b/arch/x86/kernel/cpu/mtrr/centaur.c
>> index 6f6c3ae92943..f4c72402c284 100644
>> --- a/arch/x86/kernel/cpu/mtrr/centaur.c
>> +++ b/arch/x86/kernel/cpu/mtrr/centaur.c
>> @@ -20,6 +20,7 @@ static u8 centaur_mcr_type;	/* 0 for winchip, 1 for winchip2 */
>>   *
>>   * @base: The starting (base) address of the region.
>>   * @size: The size (in bytes) of the region.
>> + * @replace_reg: mtrr index to be replaced; set to invalid value if none.
>
>I'm afraid I can't follow here what invalid value you mean...

In order to solve the warning issue while keeping the documentation
homogeneus, I used the same description from the get_free_region in
generic.c.
I believe that the original doc author referred to the fact that you can either
choose to reuse a specific MTRR (by passing its index in replace_reg) 
or ask the function to find a free one
by passing an "invalid value" (for instance -1).

Changelog v1 -> v2:
* merge changes into a single patch
* add commit message

Have a nice day,
Kael.

Kael D'Alcamo (1):
  x86/mtrr: Fix kernel-doc warnings in amd.c and centaur.c

 arch/x86/kernel/cpu/mtrr/amd.c     | 8 ++++----
 arch/x86/kernel/cpu/mtrr/centaur.c | 1 +
 2 files changed, 5 insertions(+), 4 deletions(-)

-- 
2.51.1