| Message ID | 20200629140442.1043957-20-lee.jones@linaro.org (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | Fix a bunch more W=1 warnings in Misc | expand |
On 2020-06-29 16:04, Lee Jones wrote: > Including; add missing documentation for function arguments, > re-ordering > of #defines i.e. not placed between kerneldoc headers and the functions > they are documenting, demotion of file header/comment from kerneldoc > format and removal of documentation for non-existent args. > > Fixes the following W=1 kernel build warnings: > > drivers/misc/genwqe/card_dev.c:33: warning: Function parameter or > member 'cd' not described in 'genwqe_open_files' > drivers/misc/genwqe/card_dev.c:98: warning: Function parameter or > member 'virt_addr' not described in 'genwqe_search_pin' > drivers/misc/genwqe/card_dev.c:98: warning: Excess function parameter > 'dma_addr' description in 'genwqe_search_pin' > drivers/misc/genwqe/card_dev.c:154: warning: Function parameter or > member 'virt_addr' not described in '__genwqe_search_mapping' > drivers/misc/genwqe/card_dev.c:256: warning: Function parameter or > member 'cd' not described in 'genwqe_kill_fasync' > drivers/misc/genwqe/card_dev.c:256: warning: Function parameter or > member 'sig' not described in 'genwqe_kill_fasync' > drivers/misc/genwqe/card_dev.c:387: warning: Function parameter or > member 'vma' not described in 'genwqe_vma_close' > drivers/misc/genwqe/card_dev.c:430: warning: Function parameter or > member 'filp' not described in 'genwqe_mmap' > drivers/misc/genwqe/card_dev.c:430: warning: Function parameter or > member 'vma' not described in 'genwqe_mmap' > drivers/misc/genwqe/card_dev.c:495: warning: Excess function > parameter 'cd' description in 'FLASH_BLOCK' > drivers/misc/genwqe/card_dev.c:495: warning: Excess function > parameter 'load' description in 'FLASH_BLOCK' > drivers/misc/genwqe/card_dev.c:827: warning: Function parameter or > member 'cfile' not described in 'ddcb_cmd_cleanup' > drivers/misc/genwqe/card_dev.c:827: warning: Function parameter or > member 'req' not described in 'ddcb_cmd_cleanup' > drivers/misc/genwqe/card_dev.c:854: warning: Function parameter or > member 'cfile' not described in 'ddcb_cmd_fixups' > drivers/misc/genwqe/card_dev.c:854: warning: Function parameter or > member 'req' not described in 'ddcb_cmd_fixups' > drivers/misc/genwqe/card_dev.c:984: warning: Function parameter or > member 'cfile' not described in 'genwqe_execute_ddcb' > drivers/misc/genwqe/card_dev.c:984: warning: Function parameter or > member 'cmd' not described in 'genwqe_execute_ddcb' > drivers/misc/genwqe/card_dev.c:1350: warning: Function parameter or > member 'cd' not described in 'genwqe_device_remove' > > Cc: Michael Jung <mijung@gmx.net> > Cc: Michael Ruettger <michael@ibmra.de> > Cc: Frank Haverkamp <haver@linux.ibm.com> > Cc: Joerg-Stephan Vogt <jsvogt@de.ibm.com> > Signed-off-by: Lee Jones <lee.jones@linaro.org> > --- > drivers/misc/genwqe/card_dev.c | 24 ++++++++++++++++++------ > 1 file changed, 18 insertions(+), 6 deletions(-) > > diff --git a/drivers/misc/genwqe/card_dev.c > b/drivers/misc/genwqe/card_dev.c > index 040a0bda31254..55fc5b80e649f 100644 > --- a/drivers/misc/genwqe/card_dev.c > +++ b/drivers/misc/genwqe/card_dev.c > @@ -1,5 +1,5 @@ > // SPDX-License-Identifier: GPL-2.0-only > -/** > +/* > * IBM Accelerator Family 'GenWQE' > * > * (C) Copyright IBM Corp. 2013 > @@ -87,7 +87,7 @@ static int genwqe_del_pin(struct genwqe_file *cfile, > struct dma_mapping *m) > * @cfile: Descriptor of opened file > * @u_addr: User virtual address > * @size: Size of buffer > - * @dma_addr: DMA address to be updated > + * @virt_addr: Virtual address to be updated > * > * Return: Pointer to the corresponding mapping NULL if not found > */ > @@ -144,6 +144,7 @@ static void __genwqe_del_mapping(struct genwqe_file > *cfile, > * @u_addr: user virtual address > * @size: size of buffer > * @dma_addr: DMA address to be updated > + * @virt_addr: Virtual address to be updated > * Return: Pointer to the corresponding mapping NULL if not found > */ > static struct dma_mapping *__genwqe_search_mapping(struct genwqe_file > *cfile, > @@ -249,6 +250,8 @@ static void genwqe_remove_pinnings(struct > genwqe_file *cfile) > > /** > * genwqe_kill_fasync() - Send signal to all processes with open > GenWQE files > + * @cd: GenWQE device information > + * @sig: Signal to send out > * > * E.g. genwqe_send_signal(cd, SIGIO); > */ > @@ -380,6 +383,7 @@ static void genwqe_vma_open(struct vm_area_struct > *vma) > > /** > * genwqe_vma_close() - Called each time when vma is unmapped > + * @vma: VMA area to close > * > * Free memory which got allocated by GenWQE mmap(). > */ > @@ -416,6 +420,8 @@ static const struct vm_operations_struct > genwqe_vma_ops = { > > /** > * genwqe_mmap() - Provide contignous buffers to userspace > + * @filp: File pointer (unused) > + * @vma: VMA area to map > * > * We use mmap() to allocate contignous buffers used for DMA > * transfers. After the buffer is allocated we remap it to user-space > @@ -484,16 +490,15 @@ static int genwqe_mmap(struct file *filp, struct > vm_area_struct *vma) > return rc; > } > > +#define FLASH_BLOCK 0x40000 /* we use 256k blocks */ > + > /** > * do_flash_update() - Excute flash update (write image or CVPD) > - * @cd: genwqe device > + * @cfile: Descriptor of opened file > * @load: details about image load > * > * Return: 0 if successful > */ > - > -#define FLASH_BLOCK 0x40000 /* we use 256k blocks */ > - > static int do_flash_update(struct genwqe_file *cfile, > struct genwqe_bitstream *load) > { > @@ -820,6 +825,8 @@ static int genwqe_unpin_mem(struct genwqe_file > *cfile, struct genwqe_mem *m) > > /** > * ddcb_cmd_cleanup() - Remove dynamically created fixup entries > + * @cfile: Descriptor of opened file > + * @req: DDCB work request > * > * Only if there are any. Pinnings are not removed. > */ > @@ -844,6 +851,8 @@ static int ddcb_cmd_cleanup(struct genwqe_file > *cfile, struct ddcb_requ *req) > > /** > * ddcb_cmd_fixups() - Establish DMA fixups/sglists for user memory > references > + * @cfile: Descriptor of opened file > + * @req: DDCB work request > * > * Before the DDCB gets executed we need to handle the fixups. We > * replace the user-space addresses with DMA addresses or do > @@ -974,6 +983,8 @@ static int ddcb_cmd_fixups(struct genwqe_file > *cfile, struct ddcb_requ *req) > > /** > * genwqe_execute_ddcb() - Execute DDCB using userspace address fixups > + * @cfile: Descriptor of opened file > + * @cmd: Command identifier (passed from user) > * > * The code will build up the translation tables or lookup the > * contignous memory allocation table to find the right translations > @@ -1339,6 +1350,7 @@ static int > genwqe_inform_and_stop_processes(struct genwqe_dev *cd) > > /** > * genwqe_device_remove() - Remove genwqe's char device > + * @cd: GenWQE device information > * > * This function must be called after the client devices are removed > * because it will free the major/minor number range for the genwqe Ok. Signed-off-by: Frank Haverkamp <haver@linux.ibm.com>
diff --git a/drivers/misc/genwqe/card_dev.c b/drivers/misc/genwqe/card_dev.c index 040a0bda31254..55fc5b80e649f 100644 --- a/drivers/misc/genwqe/card_dev.c +++ b/drivers/misc/genwqe/card_dev.c @@ -1,5 +1,5 @@ // SPDX-License-Identifier: GPL-2.0-only -/** +/* * IBM Accelerator Family 'GenWQE' * * (C) Copyright IBM Corp. 2013 @@ -87,7 +87,7 @@ static int genwqe_del_pin(struct genwqe_file *cfile, struct dma_mapping *m) * @cfile: Descriptor of opened file * @u_addr: User virtual address * @size: Size of buffer - * @dma_addr: DMA address to be updated + * @virt_addr: Virtual address to be updated * * Return: Pointer to the corresponding mapping NULL if not found */ @@ -144,6 +144,7 @@ static void __genwqe_del_mapping(struct genwqe_file *cfile, * @u_addr: user virtual address * @size: size of buffer * @dma_addr: DMA address to be updated + * @virt_addr: Virtual address to be updated * Return: Pointer to the corresponding mapping NULL if not found */ static struct dma_mapping *__genwqe_search_mapping(struct genwqe_file *cfile, @@ -249,6 +250,8 @@ static void genwqe_remove_pinnings(struct genwqe_file *cfile) /** * genwqe_kill_fasync() - Send signal to all processes with open GenWQE files + * @cd: GenWQE device information + * @sig: Signal to send out * * E.g. genwqe_send_signal(cd, SIGIO); */ @@ -380,6 +383,7 @@ static void genwqe_vma_open(struct vm_area_struct *vma) /** * genwqe_vma_close() - Called each time when vma is unmapped + * @vma: VMA area to close * * Free memory which got allocated by GenWQE mmap(). */ @@ -416,6 +420,8 @@ static const struct vm_operations_struct genwqe_vma_ops = { /** * genwqe_mmap() - Provide contignous buffers to userspace + * @filp: File pointer (unused) + * @vma: VMA area to map * * We use mmap() to allocate contignous buffers used for DMA * transfers. After the buffer is allocated we remap it to user-space @@ -484,16 +490,15 @@ static int genwqe_mmap(struct file *filp, struct vm_area_struct *vma) return rc; } +#define FLASH_BLOCK 0x40000 /* we use 256k blocks */ + /** * do_flash_update() - Excute flash update (write image or CVPD) - * @cd: genwqe device + * @cfile: Descriptor of opened file * @load: details about image load * * Return: 0 if successful */ - -#define FLASH_BLOCK 0x40000 /* we use 256k blocks */ - static int do_flash_update(struct genwqe_file *cfile, struct genwqe_bitstream *load) { @@ -820,6 +825,8 @@ static int genwqe_unpin_mem(struct genwqe_file *cfile, struct genwqe_mem *m) /** * ddcb_cmd_cleanup() - Remove dynamically created fixup entries + * @cfile: Descriptor of opened file + * @req: DDCB work request * * Only if there are any. Pinnings are not removed. */ @@ -844,6 +851,8 @@ static int ddcb_cmd_cleanup(struct genwqe_file *cfile, struct ddcb_requ *req) /** * ddcb_cmd_fixups() - Establish DMA fixups/sglists for user memory references + * @cfile: Descriptor of opened file + * @req: DDCB work request * * Before the DDCB gets executed we need to handle the fixups. We * replace the user-space addresses with DMA addresses or do @@ -974,6 +983,8 @@ static int ddcb_cmd_fixups(struct genwqe_file *cfile, struct ddcb_requ *req) /** * genwqe_execute_ddcb() - Execute DDCB using userspace address fixups + * @cfile: Descriptor of opened file + * @cmd: Command identifier (passed from user) * * The code will build up the translation tables or lookup the * contignous memory allocation table to find the right translations @@ -1339,6 +1350,7 @@ static int genwqe_inform_and_stop_processes(struct genwqe_dev *cd) /** * genwqe_device_remove() - Remove genwqe's char device + * @cd: GenWQE device information * * This function must be called after the client devices are removed * because it will free the major/minor number range for the genwqe
Including; add missing documentation for function arguments, re-ordering of #defines i.e. not placed between kerneldoc headers and the functions they are documenting, demotion of file header/comment from kerneldoc format and removal of documentation for non-existent args. Fixes the following W=1 kernel build warnings: drivers/misc/genwqe/card_dev.c:33: warning: Function parameter or member 'cd' not described in 'genwqe_open_files' drivers/misc/genwqe/card_dev.c:98: warning: Function parameter or member 'virt_addr' not described in 'genwqe_search_pin' drivers/misc/genwqe/card_dev.c:98: warning: Excess function parameter 'dma_addr' description in 'genwqe_search_pin' drivers/misc/genwqe/card_dev.c:154: warning: Function parameter or member 'virt_addr' not described in '__genwqe_search_mapping' drivers/misc/genwqe/card_dev.c:256: warning: Function parameter or member 'cd' not described in 'genwqe_kill_fasync' drivers/misc/genwqe/card_dev.c:256: warning: Function parameter or member 'sig' not described in 'genwqe_kill_fasync' drivers/misc/genwqe/card_dev.c:387: warning: Function parameter or member 'vma' not described in 'genwqe_vma_close' drivers/misc/genwqe/card_dev.c:430: warning: Function parameter or member 'filp' not described in 'genwqe_mmap' drivers/misc/genwqe/card_dev.c:430: warning: Function parameter or member 'vma' not described in 'genwqe_mmap' drivers/misc/genwqe/card_dev.c:495: warning: Excess function parameter 'cd' description in 'FLASH_BLOCK' drivers/misc/genwqe/card_dev.c:495: warning: Excess function parameter 'load' description in 'FLASH_BLOCK' drivers/misc/genwqe/card_dev.c:827: warning: Function parameter or member 'cfile' not described in 'ddcb_cmd_cleanup' drivers/misc/genwqe/card_dev.c:827: warning: Function parameter or member 'req' not described in 'ddcb_cmd_cleanup' drivers/misc/genwqe/card_dev.c:854: warning: Function parameter or member 'cfile' not described in 'ddcb_cmd_fixups' drivers/misc/genwqe/card_dev.c:854: warning: Function parameter or member 'req' not described in 'ddcb_cmd_fixups' drivers/misc/genwqe/card_dev.c:984: warning: Function parameter or member 'cfile' not described in 'genwqe_execute_ddcb' drivers/misc/genwqe/card_dev.c:984: warning: Function parameter or member 'cmd' not described in 'genwqe_execute_ddcb' drivers/misc/genwqe/card_dev.c:1350: warning: Function parameter or member 'cd' not described in 'genwqe_device_remove' Cc: Michael Jung <mijung@gmx.net> Cc: Michael Ruettger <michael@ibmra.de> Cc: Frank Haverkamp <haver@linux.ibm.com> Cc: Joerg-Stephan Vogt <jsvogt@de.ibm.com> Signed-off-by: Lee Jones <lee.jones@linaro.org> --- drivers/misc/genwqe/card_dev.c | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-)