Skip to content

Commit 73ba88f

Browse files
Nirbhay Sharmatakaswie
authored andcommitted
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 <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Takashi Sakamoto <[email protected]>
1 parent 246aca5 commit 73ba88f

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

drivers/firewire/init_ohci1394_dma.c

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,7 @@ static inline void __init init_ohci1394_initialize(struct ohci *ohci)
167167

168168
/**
169169
* init_ohci1394_wait_for_busresets - wait until bus resets are completed
170+
* @ohci: Pointer to the OHCI-1394 controller structure
170171
*
171172
* OHCI1394 initialization itself and any device going on- or offline
172173
* and any cable issue cause a IEEE1394 bus reset. The OHCI1394 spec
@@ -189,6 +190,8 @@ static inline void __init init_ohci1394_wait_for_busresets(struct ohci *ohci)
189190

190191
/**
191192
* init_ohci1394_enable_physical_dma - Enable physical DMA for remote debugging
193+
* @ohci: Pointer to the OHCI-1394 controller structure
194+
*
192195
* This enables remote DMA access over IEEE1394 from every host for the low
193196
* 4GB of address space. DMA accesses above 4GB are not available currently.
194197
*/
@@ -201,6 +204,8 @@ static inline void __init init_ohci1394_enable_physical_dma(struct ohci *ohci)
201204

202205
/**
203206
* init_ohci1394_reset_and_init_dma - init controller and enable DMA
207+
* @ohci: Pointer to the OHCI-1394 controller structure
208+
*
204209
* This initializes the given controller and enables physical DMA engine in it.
205210
*/
206211
static inline void __init init_ohci1394_reset_and_init_dma(struct ohci *ohci)
@@ -230,6 +235,10 @@ static inline void __init init_ohci1394_reset_and_init_dma(struct ohci *ohci)
230235

231236
/**
232237
* init_ohci1394_controller - Map the registers of the controller and init DMA
238+
* @num: PCI bus number
239+
* @slot: PCI device number
240+
* @func: PCI function number
241+
*
233242
* This maps the registers of the specified controller and initializes it
234243
*/
235244
static inline void __init init_ohci1394_controller(int num, int slot, int func)
@@ -284,6 +293,7 @@ void __init init_ohci1394_dma_on_all_controllers(void)
284293

285294
/**
286295
* setup_ohci1394_dma - enables early OHCI1394 DMA initialization
296+
* @opt: Kernel command line parameter string
287297
*/
288298
static int __init setup_ohci1394_dma(char *opt)
289299
{

0 commit comments

Comments
 (0)