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

Configure Feed

Select the types of activity you want to include in your feed.

firewire: init_ohci1394_dma: add missing function parameter documentation

Add missing kernel-doc parameter descriptions for five functions
in init_ohci1394_dma.c to fix documentation warnings when building
with W=1.

This patch addresses the following warnings:
- init_ohci1394_wait_for_busresets: missing @ohci description
- init_ohci1394_enable_physical_dma: missing @ohci description
- init_ohci1394_reset_and_init_dma: missing @ohci description
- init_ohci1394_controller: missing @num, @slot, @func descriptions
- setup_ohci1394_dma: missing @opt description

Tested with GCC 13.2.0 and W=1 flag. All documentation warnings
for these functions have been resolved.

Signed-off-by: Nirbhay Sharma <nirbhay.lkd@gmail.com>
Link: https://lore.kernel.org/r/20251024203219.101990-2-nirbhay.lkd@gmail.com
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

authored by

Nirbhay Sharma and committed by
Takashi Sakamoto 73ba88fb 246aca5b

+10
+10
drivers/firewire/init_ohci1394_dma.c
··· 167 167 168 168 /** 169 169 * init_ohci1394_wait_for_busresets - wait until bus resets are completed 170 + * @ohci: Pointer to the OHCI-1394 controller structure 170 171 * 171 172 * OHCI1394 initialization itself and any device going on- or offline 172 173 * and any cable issue cause a IEEE1394 bus reset. The OHCI1394 spec ··· 190 189 191 190 /** 192 191 * init_ohci1394_enable_physical_dma - Enable physical DMA for remote debugging 192 + * @ohci: Pointer to the OHCI-1394 controller structure 193 + * 193 194 * This enables remote DMA access over IEEE1394 from every host for the low 194 195 * 4GB of address space. DMA accesses above 4GB are not available currently. 195 196 */ ··· 204 201 205 202 /** 206 203 * init_ohci1394_reset_and_init_dma - init controller and enable DMA 204 + * @ohci: Pointer to the OHCI-1394 controller structure 205 + * 207 206 * This initializes the given controller and enables physical DMA engine in it. 208 207 */ 209 208 static inline void __init init_ohci1394_reset_and_init_dma(struct ohci *ohci) ··· 235 230 236 231 /** 237 232 * init_ohci1394_controller - Map the registers of the controller and init DMA 233 + * @num: PCI bus number 234 + * @slot: PCI device number 235 + * @func: PCI function number 236 + * 238 237 * This maps the registers of the specified controller and initializes it 239 238 */ 240 239 static inline void __init init_ohci1394_controller(int num, int slot, int func) ··· 293 284 294 285 /** 295 286 * setup_ohci1394_dma - enables early OHCI1394 DMA initialization 287 + * @opt: Kernel command line parameter string 296 288 */ 297 289 static int __init setup_ohci1394_dma(char *opt) 298 290 {