Commit ab3bd366 authored by HariKrishna Sagala's avatar HariKrishna Sagala Committed by Takashi Iwai
Browse files

ALSA: ac97: Fix kernel-doc warning for snd_ac97_reset



kernel-doc populated the below warning for the non
static function "snd_ac97_reset".
"Warning: ./sound/ac97_bus.c:56 No description found
for return value of 'snd_ac97_reset'".
Added the return values as per the kernel-doc format.

Signed-off-by: default avatarHariKrishna Sagala <hariconscious@gmail.com>
Link: https://patch.msgid.link/20251105105229.112172-2-hariconscious@gmail.com


Signed-off-by: default avatarTakashi Iwai <tiwai@suse.de>
parent 4e5a0a0a
Loading
Loading
Loading
Loading
+8 −5
Original line number Diff line number Diff line
@@ -46,11 +46,14 @@ static bool snd_ac97_check_id(struct snd_ac97 *ac97, unsigned int id,
 * @id_mask: Mask that is applied to the device ID before comparing to @id
 *
 * This function resets the AC'97 device. If @try_warm is true the function
 * first performs a warm reset. If the warm reset is successful the function
 * returns 1. Otherwise or if @try_warm is false the function issues cold reset
 * followed by a warm reset. If this is successful the function returns 0,
 * otherwise a negative error code. If @id is 0 any valid device ID will be
 * accepted, otherwise only the ID that matches @id and @id_mask is accepted.
 * first performs a warm reset. If @try_warm is false the function issues
 * cold reset followed by a warm reset. If @id is 0 any valid device ID
 * will be accepted, otherwise only the ID that matches @id and @id_mask
 * is accepted.
 * Returns:
 * * %1 - if warm reset is successful
 * * %0 - if cold reset and warm reset is successful
 * * %-ENODEV - if @id and @id_mask not matching
 */
int snd_ac97_reset(struct snd_ac97 *ac97, bool try_warm, unsigned int id,
	unsigned int id_mask)