Skip to content

Commit 4e15b91

Browse files
committed
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
1 parent f7a25cf commit 4e15b91

1 file changed

Lines changed: 10 additions & 4 deletions

File tree

arch/x86/kernel/cpu/mtrr/generic.c

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -428,6 +428,10 @@ void __init mtrr_copy_map(void)
428428
* from the x86_init.hyper.init_platform() hook. It can be called only once.
429429
* The MTRR state can't be changed afterwards. To ensure that, X86_FEATURE_MTRR
430430
* is cleared.
431+
*
432+
* @var: MTRR variable range array to use
433+
* @num_var: length of the @var array
434+
* @def_type: default caching type
431435
*/
432436
void mtrr_overwrite_state(struct mtrr_var_range *var, unsigned int num_var,
433437
mtrr_type def_type)
@@ -492,13 +496,15 @@ static u8 type_merge(u8 type, u8 new_type, u8 *uniform)
492496
/**
493497
* mtrr_type_lookup - look up memory type in MTRR
494498
*
499+
* @start: Begin of the physical address range
500+
* @end: End of the physical address range
501+
* @uniform: output argument:
502+
* - 1: the returned MTRR type is valid for the whole region
503+
* - 0: otherwise
504+
*
495505
* Return Values:
496506
* MTRR_TYPE_(type) - The effective MTRR type for the region
497507
* MTRR_TYPE_INVALID - MTRR is disabled
498-
*
499-
* Output Argument:
500-
* uniform - Set to 1 when the returned MTRR type is valid for the whole
501-
* region, set to 0 else.
502508
*/
503509
u8 mtrr_type_lookup(u64 start, u64 end, u8 *uniform)
504510
{

0 commit comments

Comments
 (0)