Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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

+10 -4
+10 -4
arch/x86/kernel/cpu/mtrr/generic.c
··· 428 428 * from the x86_init.hyper.init_platform() hook. It can be called only once. 429 429 * The MTRR state can't be changed afterwards. To ensure that, X86_FEATURE_MTRR 430 430 * 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 431 435 */ 432 436 void mtrr_overwrite_state(struct mtrr_var_range *var, unsigned int num_var, 433 437 mtrr_type def_type) ··· 496 492 /** 497 493 * mtrr_type_lookup - look up memory type in MTRR 498 494 * 495 + * @start: Begin of the physical address range 496 + * @end: End of the physical address range 497 + * @uniform: output argument: 498 + * - 1: the returned MTRR type is valid for the whole region 499 + * - 0: otherwise 500 + * 499 501 * Return Values: 500 502 * MTRR_TYPE_(type) - The effective MTRR type for the region 501 503 * MTRR_TYPE_INVALID - MTRR is disabled 502 - * 503 - * Output Argument: 504 - * uniform - Set to 1 when the returned MTRR type is valid for the whole 505 - * region, set to 0 else. 506 504 */ 507 505 u8 mtrr_type_lookup(u64 start, u64 end, u8 *uniform) 508 506 {