From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-7.0 required=3.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED, DKIM_VALID,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI, SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 9A203C433DF for ; Tue, 30 Jun 2020 07:27:20 +0000 (UTC) Received: from merlin.infradead.org (merlin.infradead.org [205.233.59.134]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 5FC9C20759 for ; Tue, 30 Jun 2020 07:27:20 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="r10jMvYd" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 5FC9C20759 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linux.vnet.ibm.com Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=merlin.20170209; h=Sender:Content-Type: Content-Transfer-Encoding:Cc:List-Subscribe:List-Help:List-Post:List-Archive: List-Unsubscribe:List-Id:Message-ID:References:In-Reply-To:Subject:To:From: Date:MIME-Version:Reply-To:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Owner; bh=ofXXh/FoAtxWbJuMcwOTv7zL6lkRoKIoo5jEG3/nk/Y=; b=r10jMvYdJx3KI5RhB5Yzx/dUL ET4Fm0rvaJkNVWl+uv8nmXSKcGnrjMejoN4EKaXPs1P22AUtlDdS/METLOumb6MQWd+Sfh0hJzrmP TJfUrUb4S+fkfc3OYVcJOeagXEzEV3kJ7kHkeCPFyrYhr+A3G5jka/+vhMUn4c6xkQXs5ZUTpaoWa v7usuaAng9S/lPmUUrjZ9IBztLcYRgQVWbofsEDYajl7dCYOZLy+QLqYLVQ9Zmn4eTxwhkScnsyfX qxWtDVJoCobtODu06/X3QdHecF1ez9ogvXWxYLZkHk70hiH6t6NRTeIV1mghN4A1gPtTJpaHYtEGy 3kubmBD8Q==; Received: from localhost ([::1] helo=merlin.infradead.org) by merlin.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1jqAeU-0004D5-KM; Tue, 30 Jun 2020 07:25:58 +0000 Received: from mx0a-001b2d01.pphosted.com ([148.163.156.1]) by merlin.infradead.org with esmtps (Exim 4.92.3 #3 (Red Hat Linux)) id 1jqAeP-0004CS-TW for linux-arm-kernel@lists.infradead.org; Tue, 30 Jun 2020 07:25:55 +0000 Received: from pps.filterd (m0098394.ppops.net [127.0.0.1]) by mx0a-001b2d01.pphosted.com (8.16.0.42/8.16.0.42) with SMTP id 05U73Ron112395; Tue, 30 Jun 2020 03:25:47 -0400 Received: from pps.reinject (localhost [127.0.0.1]) by mx0a-001b2d01.pphosted.com with ESMTP id 31y3xd6gky-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Tue, 30 Jun 2020 03:25:47 -0400 Received: from m0098394.ppops.net (m0098394.ppops.net [127.0.0.1]) by pps.reinject (8.16.0.36/8.16.0.36) with SMTP id 05U74LfH117394; Tue, 30 Jun 2020 03:25:46 -0400 Received: from ppma03dal.us.ibm.com (b.bd.3ea9.ip4.static.sl-reverse.com [169.62.189.11]) by mx0a-001b2d01.pphosted.com with ESMTP id 31y3xd6gkh-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Tue, 30 Jun 2020 03:25:46 -0400 Received: from pps.filterd (ppma03dal.us.ibm.com [127.0.0.1]) by ppma03dal.us.ibm.com (8.16.0.42/8.16.0.42) with SMTP id 05U7GKlH031827; Tue, 30 Jun 2020 07:25:45 GMT Received: from b03cxnp08027.gho.boulder.ibm.com (b03cxnp08027.gho.boulder.ibm.com [9.17.130.19]) by ppma03dal.us.ibm.com with ESMTP id 31wwr8knfp-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Tue, 30 Jun 2020 07:25:45 +0000 Received: from b03ledav002.gho.boulder.ibm.com (b03ledav002.gho.boulder.ibm.com [9.17.130.233]) by b03cxnp08027.gho.boulder.ibm.com (8.14.9/8.14.9/NCO v10.0) with ESMTP id 05U7Pg7010486354 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Tue, 30 Jun 2020 07:25:42 GMT Received: from b03ledav002.gho.boulder.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id DDF9813605D; Tue, 30 Jun 2020 07:25:43 +0000 (GMT) Received: from b03ledav002.gho.boulder.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id 8AE9113604F; Tue, 30 Jun 2020 07:25:43 +0000 (GMT) Received: from ltc.linux.ibm.com (unknown [9.16.170.189]) by b03ledav002.gho.boulder.ibm.com (Postfix) with ESMTP; Tue, 30 Jun 2020 07:25:43 +0000 (GMT) MIME-Version: 1.0 Date: Tue, 30 Jun 2020 09:25:43 +0200 From: haver To: Lee Jones Subject: Re: [PATCH 19/20] misc: genwqe: card_dev: Whole host of kerneldoc fixes In-Reply-To: <20200629140442.1043957-20-lee.jones@linaro.org> References: <20200629140442.1043957-1-lee.jones@linaro.org> <20200629140442.1043957-20-lee.jones@linaro.org> Message-ID: X-Sender: haver@linux.vnet.ibm.com User-Agent: Roundcube Webmail/1.0.1 X-TM-AS-GCONF: 00 X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:6.0.235, 18.0.687 definitions=2020-06-30_01:2020-06-30, 2020-06-29 signatures=0 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 mlxscore=0 suspectscore=2 cotscore=-2147483648 clxscore=1015 impostorscore=0 lowpriorityscore=0 phishscore=0 bulkscore=0 adultscore=0 priorityscore=1501 malwarescore=0 spamscore=0 mlxlogscore=999 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2004280000 definitions=main-2006300049 X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Joerg-Stephan Vogt , arnd@arndb.de, gregkh@linuxfoundation.org, Frank Haverkamp , Michael Jung , linux-kernel@vger.kernel.org, Michael Ruettger , linux-arm-kernel@lists.infradead.org Content-Transfer-Encoding: 7bit Content-Type: text/plain; charset="us-ascii"; Format="flowed" Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.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 > Cc: Michael Ruettger > Cc: Frank Haverkamp > Cc: Joerg-Stephan Vogt > Signed-off-by: Lee Jones > --- > 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 _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel