diff mbox series

[tip:,x86/cleanups] x86/mtrr: Document missing function parameters in kernel-doc

Message ID 170047250972.398.12119323318343960939.tip-bot2@tip-bot2
State New
Headers
Series [tip:,x86/cleanups] x86/mtrr: Document missing function parameters in kernel-doc |

Commit Message

tip-bot2 for Thomas Gleixner Nov. 20, 2023, 9:28 a.m. UTC 
  The following commit has been merged into the x86/cleanups branch of tip:

Commit-ID:     4e15b91c5b7919c530c27f39c7f2d392bf0a95e3
Gitweb:        https://git.kernel.org/tip/4e15b91c5b7919c530c27f39c7f2d392bf0a95e3
Author:        Borislav Petkov (AMD) <bp@alien8.de>
AuthorDate:    Mon, 13 Nov 2023 14:52:52 +01:00
Committer:     Borislav Petkov (AMD) <bp@alien8.de>
CommitterDate: Mon, 20 Nov 2023 10:19:27 +01:00

x86/mtrr: Document missing function parameters in kernel-doc

Add text explaining what they do.

No functional changes.

Closes: https://lore.kernel.org/oe-kbuild-all/202311130104.9xKAKzke-lkp@intel.com/
Reported-by: kernel test robot <lkp@intel.com>
Signed-off-by: Borislav Petkov (AMD) <bp@alien8.de>
Link: https://lore.kernel.org/r/202311130104.9xKAKzke-lkp@intel.com
---
 arch/x86/kernel/cpu/mtrr/generic.c | 14 ++++++++++----
 1 file changed, 10 insertions(+), 4 deletions(-)
diff mbox series

Patch

diff --git a/arch/x86/kernel/cpu/mtrr/generic.c b/arch/x86/kernel/cpu/mtrr/generic.c
index 2d6aa5d..d352477 100644
--- a/arch/x86/kernel/cpu/mtrr/generic.c
+++ b/arch/x86/kernel/cpu/mtrr/generic.c
@@ -428,6 +428,10 @@  void __init mtrr_copy_map(void)
  * from the x86_init.hyper.init_platform() hook.  It can be called only once.
  * The MTRR state can't be changed afterwards.  To ensure that, X86_FEATURE_MTRR
  * is cleared.
+ *
+ * @var: MTRR variable range array to use
+ * @num_var: length of the @var array
+ * @def_type: default caching type
  */
 void mtrr_overwrite_state(struct mtrr_var_range *var, unsigned int num_var,
 			  mtrr_type def_type)
@@ -492,13 +496,15 @@  static u8 type_merge(u8 type, u8 new_type, u8 *uniform)
 /**
  * mtrr_type_lookup - look up memory type in MTRR
  *
+ * @start: Begin of the physical address range
+ * @end: End of the physical address range
+ * @uniform: output argument:
+ *  - 1: the returned MTRR type is valid for the whole region
+ *  - 0: otherwise
+ *
  * Return Values:
  * MTRR_TYPE_(type)  - The effective MTRR type for the region
  * MTRR_TYPE_INVALID - MTRR is disabled
- *
- * Output Argument:
- * uniform - Set to 1 when the returned MTRR type is valid for the whole
- *	     region, set to 0 else.
  */
 u8 mtrr_type_lookup(u64 start, u64 end, u8 *uniform)
 {