diff options
| author | HariKrishna Sagala <hariconscious@gmail.com> | 2025-11-05 16:22:30 +0530 |
|---|---|---|
| committer | Takashi Iwai <tiwai@suse.de> | 2025-11-06 10:52:43 +0100 |
| commit | ab3bd3662ed4605b7859988f224e2ed615f03060 (patch) | |
| tree | 5f89b8cfc362242f856cb641ff9c07b907d48b90 | |
| parent | 4e5a0a0ae83fdc5e6414f5ad9716e436d95502b7 (diff) | |
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: HariKrishna Sagala <hariconscious@gmail.com>
Link: https://patch.msgid.link/20251105105229.112172-2-hariconscious@gmail.com
Signed-off-by: Takashi Iwai <tiwai@suse.de>
| -rw-r--r-- | sound/ac97_bus.c | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/sound/ac97_bus.c b/sound/ac97_bus.c index 1484fc178fa4..8a44297964f5 100644 --- a/sound/ac97_bus.c +++ b/sound/ac97_bus.c @@ -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) |