Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
ALSA: memalloc: Fix missing return value comments for kernel docs
Each kernel doc comment expects the definition of the return value in
a proper format. This patch adds or fixes the missing entries for
memory allocation helpers.
Link: https://lore.kernel.org/r/20220713104759.4365-7-tiwai@suse.de
Signed-off-by: Takashi Iwai <tiwai@suse.de>
+9
-1
+9
-1
sound/core/memalloc.c
+9
-1
sound/core/memalloc.c
···
147
147
* hence it can't work with SNDRV_DMA_TYPE_CONTINUOUS or
148
148
* SNDRV_DMA_TYPE_VMALLOC type.
149
149
*
150
-
* The function returns the snd_dma_buffer object at success, or NULL if failed.
150
+
* Return: the snd_dma_buffer object at success, or NULL if failed
151
151
*/
152
152
struct snd_dma_buffer *
153
153
snd_devm_alloc_dir_pages(struct device *dev, int type,
···
179
179
* snd_dma_buffer_mmap - perform mmap of the given DMA buffer
180
180
* @dmab: buffer allocation information
181
181
* @area: VM area information
182
+
*
183
+
* Return: zero if successful, or a negative error code
182
184
*/
183
185
int snd_dma_buffer_mmap(struct snd_dma_buffer *dmab,
184
186
struct vm_area_struct *area)
···
221
219
* snd_sgbuf_get_addr - return the physical address at the corresponding offset
222
220
* @dmab: buffer allocation information
223
221
* @offset: offset in the ring buffer
222
+
*
223
+
* Return: the physical address
224
224
*/
225
225
dma_addr_t snd_sgbuf_get_addr(struct snd_dma_buffer *dmab, size_t offset)
226
226
{
···
239
235
* snd_sgbuf_get_page - return the physical page at the corresponding offset
240
236
* @dmab: buffer allocation information
241
237
* @offset: offset in the ring buffer
238
+
*
239
+
* Return: the page pointer
242
240
*/
243
241
struct page *snd_sgbuf_get_page(struct snd_dma_buffer *dmab, size_t offset)
244
242
{
···
259
253
* @dmab: buffer allocation information
260
254
* @ofs: offset in the ring buffer
261
255
* @size: the requested size
256
+
*
257
+
* Return: the chunk size
262
258
*/
263
259
unsigned int snd_sgbuf_get_chunk_size(struct snd_dma_buffer *dmab,
264
260
unsigned int ofs, unsigned int size)