From patchwork Mon Jul 13 07:46:44 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 235314 Delivered-To: patch@linaro.org Received: by 2002:a92:d244:0:0:0:0:0 with SMTP id v4csp2611042ilg; Mon, 13 Jul 2020 00:47:44 -0700 (PDT) X-Google-Smtp-Source: ABdhPJz1x1y7000AH05P7Rsz+hFhZPZkxlDDMoaN58VRIUeKHx81kr0pLUEztlBtrd2WSuw7dIay X-Received: by 2002:a17:906:57c5:: with SMTP id u5mr55488659ejr.311.1594626464318; Mon, 13 Jul 2020 00:47:44 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1594626464; cv=none; d=google.com; s=arc-20160816; b=TV14KvJG4e3hmZWGg3yEFuCPBHcYy66EPogMTT0+RA1ZgPDM0jRkBHpQWrJhv3bttE 9FN3QRKIE7k0gha+rMtbIbYZMSC/TXjqoskgZOM7Y70PbbT4LxxNnsncaOg01lzY1NDo Q3lGAedmzTZTdd7XDZ9pRIvW75qZY4wqjIC6l+fPB9iUxSIjMjmvYwFBMk+AleNRXW5Z Al6cxidCt7YaE7I18yK6KD0YDJNfMJ1hiDKHe8AeL5hGFk1V94TmMYR39ydDYg91yzQ1 M3VHhJDXsH6Qk+wIfbH4mvFG15hlNQG9Hu+j0sAAw0Rzt74yoRurxrlR2+3n1Y2Dr+da IIlA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=d7D7AfDQQG73fSw4f21gOz4vhVntWScnapCoKvjgVSM=; b=KAWD4fu/3FjFxzGlwoEZNaXhfIbdc6kVvkj9V/R5wun1zX0EhrKyOAcl7D5BK3Bbj0 BiUKYcmgYVImKdbgGtkeXbkoeFUQyw+Z3Sh45sEk3vQ1Yg1Ltr0opoK/bFnJHqtGqoaQ nMAquQ8NmUpp0XC4baZesVpvHqY4gASgsudWHBo75HqT8Dc9nwP6vbX8V48QeiTfO0un rC4Tj0D3+Y2FIzlhIdn7xkXbF48gsO6vaAY0aNLbb1gZXy2weJZ8LEO+lVyVt8EErOH3 xM1EdQqS0LGoXu6jRQgndYo1s1ILFWHhAinQANHcq/3AU/7COyMr987dqpnx45Ic2MAZ rZcA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=vV+NVLZb; spf=pass (google.com: domain of linux-scsi-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-scsi-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id fi17si8664769ejb.724.2020.07.13.00.47.44 for ; Mon, 13 Jul 2020 00:47:44 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-scsi-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=vV+NVLZb; spf=pass (google.com: domain of linux-scsi-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-scsi-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1729516AbgGMHrk (ORCPT ); Mon, 13 Jul 2020 03:47:40 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:50478 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1729423AbgGMHrT (ORCPT ); Mon, 13 Jul 2020 03:47:19 -0400 Received: from mail-wm1-x343.google.com (mail-wm1-x343.google.com [IPv6:2a00:1450:4864:20::343]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 287A7C061755 for ; Mon, 13 Jul 2020 00:47:19 -0700 (PDT) Received: by mail-wm1-x343.google.com with SMTP id l2so12174727wmf.0 for ; Mon, 13 Jul 2020 00:47:19 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=d7D7AfDQQG73fSw4f21gOz4vhVntWScnapCoKvjgVSM=; b=vV+NVLZbcCzd4H3LMTl7g1rbRAL4pQW36HVzYwkRoNO7H8voiAmmb1Ft/Ig7C9LqAN 5NElhgHT2E+DngzMp3xd9PzgBACBMSL8PKud4STlFQNDR488sZRESJlnOIhg6LCGA4IP rDwVwXp+sxZclZMMgDjZKriAl/1M+xdQKZqbKpi7WqPwgOpauWacugk41diIdooz92zq ZFF00fG+2EZXpSQFE6auRlu+aBEMoFFJLmUV2WwFzybWIeyjeiqTcanXL20tvjoiTyHN fsYhJ+CxX5aXYUhwoJeEzHlNhHW7gQeq7rpZl5sAHNPl8Z8VepXO+NMz/87JgOQTHgAn PSbQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=d7D7AfDQQG73fSw4f21gOz4vhVntWScnapCoKvjgVSM=; b=F279f82pSQzR9dY/ztK5vcq27l34P5IcW7Af4MQZzH4lGYx+GGkzZ7loh3b8DMW5/j s6lNjEAjVkDqhS8Bb+q7aPLv8uHCvQhUBwDRUWs3b5YqEalh7txzzUYBPkzvvnSq9Bwz nryRMFV1L99ukHTN44uuwO92WZFJ7V+PWewaOo3lKrqSKb71dC5L83U5cj2wQ4RTqX+4 hFe6ojOum3vWZc5I+65E36EEjdibFLj2R7pnocX7WXk4wdkRKFv8p9mnf1fnreO0ZUXb CQUODIurhH18cfe9I7SygpqcxUb6mkeSdASByZXnltzNivLsbt3jRSdWq3Oi1/qoSdSU E9NQ== X-Gm-Message-State: AOAM530IysRWZBGBSRDnndbHHVe/4UxhlpLvZhUB+Gs2zADkivzg42L8 Ye1tOLuFVd6iwshz13UcIxc9FA== X-Received: by 2002:a7b:cd10:: with SMTP id f16mr18044156wmj.86.1594626437839; Mon, 13 Jul 2020 00:47:17 -0700 (PDT) Received: from localhost.localdomain ([2.31.163.6]) by smtp.gmail.com with ESMTPSA id k11sm25142488wrd.23.2020.07.13.00.47.16 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 13 Jul 2020 00:47:17 -0700 (PDT) From: Lee Jones To: jejb@linux.ibm.com, martin.petersen@oracle.com Cc: linux-kernel@vger.kernel.org, linux-scsi@vger.kernel.org, Lee Jones , Adaptec OEM Raid Solutions , "PMC-Sierra, Inc" Subject: [PATCH v2 28/29] scsi: aacraid: aachba: Fix a bunch of function doc formatting errors Date: Mon, 13 Jul 2020 08:46:44 +0100 Message-Id: <20200713074645.126138-29-lee.jones@linaro.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20200713074645.126138-1-lee.jones@linaro.org> References: <20200713074645.126138-1-lee.jones@linaro.org> MIME-Version: 1.0 Sender: linux-scsi-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-scsi@vger.kernel.org And a few missing/excessive parameter descriptions. Fixes the following W=1 kernel build warning(s): drivers/scsi/aacraid/aachba.c:358: warning: Function parameter or member 'dev' not described in 'aac_get_config_status' drivers/scsi/aacraid/aachba.c:358: warning: Function parameter or member 'commit_flag' not described in 'aac_get_config_status' drivers/scsi/aacraid/aachba.c:358: warning: Excess function parameter 'common' description in 'aac_get_config_status' drivers/scsi/aacraid/aachba.c:450: warning: Function parameter or member 'dev' not described in 'aac_get_containers' drivers/scsi/aacraid/aachba.c:450: warning: Excess function parameter 'common' description in 'aac_get_containers' drivers/scsi/aacraid/aachba.c:568: warning: Function parameter or member 'scsicmd' not described in 'aac_get_container_name' drivers/scsi/aacraid/aachba.c:796: warning: Function parameter or member 'scsicmd' not described in 'aac_probe_container_callback1' drivers/scsi/aacraid/aachba.c:796: warning: Excess function parameter 'dev' description in 'aac_probe_container_callback1' drivers/scsi/aacraid/aachba.c:796: warning: Excess function parameter 'cid' description in 'aac_probe_container_callback1' drivers/scsi/aacraid/aachba.c:1105: warning: Function parameter or member 'scsicmd' not described in 'aac_get_container_serial' drivers/scsi/aacraid/aachba.c:1961: warning: Excess function parameter 'phys_luns' description in 'aac_set_safw_attr_all_targets' drivers/scsi/aacraid/aachba.c:1961: warning: Excess function parameter 'rescan' description in 'aac_set_safw_attr_all_targets' drivers/scsi/aacraid/aachba.c:3394: warning: Cannot understand * on line 3394 - I thought it was a doc line drivers/scsi/aacraid/aachba.c:3687: warning: Cannot understand * on line 3687 - I thought it was a doc line drivers/scsi/aacraid/aachba.c:3752: warning: Cannot understand * on line 3752 - I thought it was a doc line drivers/scsi/aacraid/aachba.c:3795: warning: Cannot understand * on line 3795 - I thought it was a doc line Cc: Adaptec OEM Raid Solutions Cc: "PMC-Sierra, Inc" Signed-off-by: Lee Jones --- drivers/scsi/aacraid/aachba.c | 17 +++-------------- 1 file changed, 3 insertions(+), 14 deletions(-) -- 2.25.1 diff --git a/drivers/scsi/aacraid/aachba.c b/drivers/scsi/aacraid/aachba.c index 2b868f8db8ffe..7ae1e545a255c 100644 --- a/drivers/scsi/aacraid/aachba.c +++ b/drivers/scsi/aacraid/aachba.c @@ -561,7 +561,7 @@ static void get_container_name_callback(void *context, struct fib * fibptr) scsicmd->scsi_done(scsicmd); } -/** +/* * aac_get_container_name - get container name, none blocking. */ static int aac_get_container_name(struct scsi_cmnd * scsicmd) @@ -786,8 +786,7 @@ static int _aac_probe_container(struct scsi_cmnd * scsicmd, int (*callback)(stru /** * aac_probe_container - query a logical volume - * @dev: device to query - * @cid: container identifier + * @scsicmd: the scsi command block * * Queries the controller about the given volume. The volume information * is updated in the struct fsa_dev_info structure rather than returned. @@ -1098,7 +1097,7 @@ static void get_container_serial_callback(void *context, struct fib * fibptr) scsicmd->scsi_done(scsicmd); } -/** +/* * aac_get_container_serial - get container serial, none blocking. */ static int aac_get_container_serial(struct scsi_cmnd * scsicmd) @@ -1952,8 +1951,6 @@ static int aac_get_safw_attr_all_targets(struct aac_dev *dev) /** * aac_set_safw_attr_all_targets- update current hba map with data from FW * @dev: aac_dev structure - * @phys_luns: FW information from report phys luns - * @rescan: Indicates scan type * * Update our hba map with the information gathered from the FW */ @@ -3391,15 +3388,12 @@ int aac_dev_ioctl(struct aac_dev *dev, unsigned int cmd, void __user *arg) } /** - * * aac_srb_callback * @context: the context set in the fib - here it is scsi cmd * @fibptr: pointer to the fib * * Handles the completion of a scsi command to a non dasd device - * */ - static void aac_srb_callback(void *context, struct fib * fibptr) { struct aac_srb_reply *srbreply; @@ -3684,13 +3678,11 @@ static void hba_resp_task_failure(struct aac_dev *dev, } /** - * * aac_hba_callback * @context: the context set in the fib - here it is scsi cmd * @fibptr: pointer to the fib * * Handles the completion of a native HBA scsi command - * */ void aac_hba_callback(void *context, struct fib *fibptr) { @@ -3749,14 +3741,12 @@ void aac_hba_callback(void *context, struct fib *fibptr) } /** - * * aac_send_srb_fib * @scsicmd: the scsi command block * * This routine will form a FIB and fill in the aac_srb from the * scsicmd passed in. */ - static int aac_send_srb_fib(struct scsi_cmnd* scsicmd) { struct fib* cmd_fibcontext; @@ -3792,7 +3782,6 @@ static int aac_send_srb_fib(struct scsi_cmnd* scsicmd) } /** - * * aac_send_hba_fib * @scsicmd: the scsi command block *