linux-kernel - [PATCH -next] x86/mm/mtrr: fix doc warnings in generic.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-next>] [day] [month] [year] [list]

Message-ID: <20210605064821.694432-1-libaokun1@huawei.com>
Date:   Sat, 5 Jun 2021 14:48:21 +0800
From:   Baokun Li <libaokun1@...wei.com>
To:     <tglx@...utronix.de>, <mingo@...hat.com>, <bp@...en8.de>,
        <x86@...nel.org>, <hpa@...or.com>, <jroedel@...e.de>,
        <trix@...hat.com>, <brijesh.singh@....com>, <rostedt@...dmis.org>,
        <ying-tsun.huang@....com>, <linux-kernel@...r.kernel.org>
CC:     <weiyongjun1@...wei.com>, <yuehaibing@...wei.com>,
        <yangjihong1@...wei.com>, <yukuai3@...wei.com>,
        <libaokun1@...wei.com>
Subject: [PATCH -next] x86/mm/mtrr: fix doc warnings in generic.c

Fixes the following W=1 kernel build warning(s):

 arch/x86/kernel/cpu/mtrr/generic.c:120: warning: Function parameter or 
  member 'start' not described in 'mtrr_type_lookup_fixed'
 arch/x86/kernel/cpu/mtrr/generic.c:120: warning: Function parameter or 
  member 'end' not described in 'mtrr_type_lookup_fixed'
 arch/x86/kernel/cpu/mtrr/generic.c:161: warning: Function parameter or 
  member 'start' not described in 'mtrr_type_lookup_variable'
 arch/x86/kernel/cpu/mtrr/generic.c:161: warning: Function parameter or 
  member 'end' not described in 'mtrr_type_lookup_variable'
 arch/x86/kernel/cpu/mtrr/generic.c:161: warning: Function parameter or 
  member 'partial_end' not described in 'mtrr_type_lookup_variable'
 arch/x86/kernel/cpu/mtrr/generic.c:161: warning: Function parameter or 
  member 'repeat' not described in 'mtrr_type_lookup_variable'
 arch/x86/kernel/cpu/mtrr/generic.c:161: warning: Function parameter or 
  member 'uniform' not described in 'mtrr_type_lookup_variable'
 arch/x86/kernel/cpu/mtrr/generic.c:255: warning: Function parameter or 
  member 'start' not described in 'mtrr_type_lookup'
 arch/x86/kernel/cpu/mtrr/generic.c:255: warning: Function parameter or 
  member 'end' not described in 'mtrr_type_lookup'
 arch/x86/kernel/cpu/mtrr/generic.c:255: warning: Function parameter or 
  member 'uniform' not described in 'mtrr_type_lookup'

Signed-off-by: Baokun Li <libaokun1@...wei.com>
---
 arch/x86/kernel/cpu/mtrr/generic.c | 13 ++++++++++---
 1 file changed, 10 insertions(+), 3 deletions(-)

diff --git a/arch/x86/kernel/cpu/mtrr/generic.c b/arch/x86/kernel/cpu/mtrr/generic.c
index 558108296f3c..8a943a83845e 100644
--- a/arch/x86/kernel/cpu/mtrr/generic.c
+++ b/arch/x86/kernel/cpu/mtrr/generic.c
@@ -104,7 +104,8 @@ static int check_type_overlap(u8 *prev, u8 *curr)
 
 /**
  * mtrr_type_lookup_fixed - look up memory type in MTRR fixed entries
- *
+ * @start: Start addaress.
+ * @end: End address.
  * Return the MTRR fixed memory type of 'start'.
  *
  * MTRR fixed entries are divided into the following ways:
@@ -143,7 +144,11 @@ static u8 mtrr_type_lookup_fixed(u64 start, u64 end)
 
 /**
  * mtrr_type_lookup_variable - look up memory type in MTRR variable entries
- *
+ * @start: Start addaress.
+ * @end: End address.
+ * @partial_end: Partial end address.
+ * @repeat: Memory is repeat or not.
+ * @uniform: Memory is uniform or not.
  * Return Value:
  * MTRR_TYPE_(type) - Matched memory type or default memory type (unmatched)
  *
@@ -241,7 +246,9 @@ static u8 mtrr_type_lookup_variable(u64 start, u64 end, u64 *partial_end,
 
 /**
  * mtrr_type_lookup - look up memory type in MTRR
- *
+ * @start: Start addaress.
+ * @end: End address.
+ * @uniform: Memory is uniform or not.
  * Return Values:
  * MTRR_TYPE_(type)  - The effective MTRR type for the region
  * MTRR_TYPE_INVALID - MTRR is disabled
-- 
2.31.1