From: haver <haver@linux.vnet.ibm.com>
To: Lee Jones <lee.jones@linaro.org>
Cc: Joerg-Stephan Vogt <jsvogt@de.ibm.com>,
arnd@arndb.de, gregkh@linuxfoundation.org,
Frank Haverkamp <haver@linux.ibm.com>,
Michael Jung <mijung@gmx.net>,
linux-kernel@vger.kernel.org, Michael Ruettger <michael@ibmra.de>,
linux-arm-kernel@lists.infradead.org
Subject: Re: [PATCH 19/20] misc: genwqe: card_dev: Whole host of kerneldoc fixes
Date: Tue, 30 Jun 2020 09:25:43 +0200 [thread overview]
Message-ID: <ee07c5e22bd8c42afdce7a59e93d8fcf@linux.vnet.ibm.com> (raw)
In-Reply-To: <20200629140442.1043957-20-lee.jones@linaro.org>
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>
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
next prev parent reply other threads:[~2020-06-30 7:27 UTC|newest]
Thread overview: 41+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-06-29 14:04 [PATCH 00/20] Fix a bunch more W=1 warnings in Misc Lee Jones
2020-06-29 14:04 ` [PATCH 01/20] misc: pti: Repair kerneldoc formatting issues Lee Jones
2020-06-29 14:04 ` [PATCH 02/20] misc: pti: Remove unparsable empty line in function header Lee Jones
2020-06-29 14:04 ` [PATCH 03/20] misc: habanalabs: firmware_if: Add missing 'fw_name' and 'dst' entries to " Lee Jones
2020-06-29 14:57 ` Oded Gabbay
2020-06-29 14:04 ` [PATCH 04/20] misc: habanalabs: pci: Fix a variety of kerneldoc issues Lee Jones
2020-06-29 14:58 ` Oded Gabbay
2020-06-29 14:04 ` [PATCH 05/20] misc: habanalabs: irq: Repair kerneldoc formatting issues Lee Jones
2020-06-29 14:59 ` Oded Gabbay
2020-06-29 14:04 ` [PATCH 06/20] misc: habanalabs: goya: Omit pointless check ensuring addr is >=0 Lee Jones
2020-06-29 15:00 ` Oded Gabbay
2020-06-29 14:04 ` [PATCH 07/20] misc: habanalabs: pci: Scrub documentation for non-present function argument Lee Jones
2020-06-29 15:00 ` Oded Gabbay
2020-06-29 14:04 ` [PATCH 08/20] misc: habanalabs: goya: goya_coresight: Remove set but unused variable 'val' Lee Jones
2020-06-29 15:01 ` Oded Gabbay
2020-06-29 14:04 ` [PATCH 09/20] misc: habanalabs: gaudi: Remove ill placed asterisk from kerneldoc header Lee Jones
2020-06-29 15:01 ` Oded Gabbay
2020-06-29 14:04 ` [PATCH 10/20] misc: habanalabs: gaudi: gaudi_security: Repair incorrectly named function arg Lee Jones
2020-06-29 15:02 ` Oded Gabbay
2020-06-29 16:23 ` [PATCH v2 " Lee Jones
2020-06-29 14:04 ` [PATCH 11/20] misc: enclosure: Fix some kerneldoc anomalies Lee Jones
2020-06-29 14:04 ` [PATCH 12/20] misc: lattice-ecp3-config: Remove set but clearly unused variable 'ret' Lee Jones
2020-06-29 14:04 ` [PATCH 13/20] misc: pch_phub: Provide descriptions for 'chip' argument Lee Jones
2020-06-29 14:04 ` [PATCH 14/20] misc: pch_phub: Remove superfluous descriptions to non-existent args 'offset_address' Lee Jones
2020-06-29 14:04 ` [PATCH 15/20] misc: enclosure: Update enclosure_remove_device() documentation to match reality Lee Jones
2020-06-29 14:04 ` [PATCH 16/20] misc: genwqe: card_base: Remove set but unused variable 'rc' Lee Jones
2020-06-30 7:17 ` haver
2020-06-30 7:42 ` Lee Jones
2020-06-30 8:03 ` haver
2020-06-30 8:12 ` Lee Jones
2020-06-29 14:04 ` [PATCH 17/20] misc: genwqe: card_base: Do not pass unused argument 'fatal_err' Lee Jones
2020-06-30 7:35 ` haver
2020-06-30 9:10 ` Lee Jones
2020-06-30 9:54 ` haver
2020-06-30 14:00 ` Lee Jones
2020-06-29 14:04 ` [PATCH 18/20] misc: genwqe: card_base: Whole host of kerneldoc fixes Lee Jones
2020-06-30 7:24 ` haver
2020-06-29 14:04 ` [PATCH 19/20] misc: genwqe: card_dev: " Lee Jones
2020-06-30 7:25 ` haver [this message]
2020-06-29 14:04 ` [PATCH 20/20] misc: genwqe: card_utils: Whole a plethora of documentation issues Lee Jones
2020-06-30 7:26 ` haver
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=ee07c5e22bd8c42afdce7a59e93d8fcf@linux.vnet.ibm.com \
--to=haver@linux.vnet.ibm.com \
--cc=arnd@arndb.de \
--cc=gregkh@linuxfoundation.org \
--cc=haver@linux.ibm.com \
--cc=jsvogt@de.ibm.com \
--cc=lee.jones@linaro.org \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-kernel@vger.kernel.org \
--cc=michael@ibmra.de \
--cc=mijung@gmx.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).