Skip to content

Commit b26d3d0

Browse files
rddunlapbp3tk0v
authored andcommitted
x86/lib/msr: Clean up kernel-doc notation
Convert x86/lib/msr.c comments to kernel-doc notation to eliminate kernel-doc warnings: msr.c:30: warning: This comment starts with '/**', but isn't \ a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst ... Fixes: 22085a6 ("x86: Add another set of MSR accessor functions") Reported-by: kernel test robot <lkp@intel.com> Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Borislav Petkov (AMD) <bp@alien8.de> Link: https://lore.kernel.org/oe-kbuild-all/202304120048.v4uqUq9Q-lkp@intel.com/
1 parent 454a348 commit b26d3d0

1 file changed

Lines changed: 19 additions & 13 deletions

File tree

arch/x86/lib/msr.c

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,14 @@ void msrs_free(struct msr *msrs)
2727
EXPORT_SYMBOL(msrs_free);
2828

2929
/**
30-
* Read an MSR with error handling
31-
*
30+
* msr_read - Read an MSR with error handling
3231
* @msr: MSR to read
3332
* @m: value to read into
3433
*
3534
* It returns read data only on success, otherwise it doesn't change the output
3635
* argument @m.
3736
*
37+
* Return: %0 for success, otherwise an error code
3838
*/
3939
static int msr_read(u32 msr, struct msr *m)
4040
{
@@ -49,10 +49,12 @@ static int msr_read(u32 msr, struct msr *m)
4949
}
5050

5151
/**
52-
* Write an MSR with error handling
52+
* msr_write - Write an MSR with error handling
5353
*
5454
* @msr: MSR to write
5555
* @m: value to write
56+
*
57+
* Return: %0 for success, otherwise an error code
5658
*/
5759
static int msr_write(u32 msr, struct msr *m)
5860
{
@@ -88,25 +90,29 @@ static inline int __flip_bit(u32 msr, u8 bit, bool set)
8890
}
8991

9092
/**
91-
* Set @bit in a MSR @msr.
93+
* msr_set_bit - Set @bit in a MSR @msr.
94+
* @msr: MSR to write
95+
* @bit: bit number to set
9296
*
93-
* Retval:
94-
* < 0: An error was encountered.
95-
* = 0: Bit was already set.
96-
* > 0: Hardware accepted the MSR write.
97+
* Return:
98+
* * < 0: An error was encountered.
99+
* * = 0: Bit was already set.
100+
* * > 0: Hardware accepted the MSR write.
97101
*/
98102
int msr_set_bit(u32 msr, u8 bit)
99103
{
100104
return __flip_bit(msr, bit, true);
101105
}
102106

103107
/**
104-
* Clear @bit in a MSR @msr.
108+
* msr_clear_bit - Clear @bit in a MSR @msr.
109+
* @msr: MSR to write
110+
* @bit: bit number to clear
105111
*
106-
* Retval:
107-
* < 0: An error was encountered.
108-
* = 0: Bit was already cleared.
109-
* > 0: Hardware accepted the MSR write.
112+
* Return:
113+
* * < 0: An error was encountered.
114+
* * = 0: Bit was already cleared.
115+
* * > 0: Hardware accepted the MSR write.
110116
*/
111117
int msr_clear_bit(u32 msr, u8 bit)
112118
{

0 commit comments

Comments
 (0)