From patchwork Thu Jul 23 12:24:24 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 247039 Delivered-To: patch@linaro.org Received: by 2002:a54:2c11:0:0:0:0:0 with SMTP id g17csp1147800ecp; Thu, 23 Jul 2020 05:25:20 -0700 (PDT) X-Google-Smtp-Source: ABdhPJx9SoyGY9arCUZamfMC1WP0RmGG82vKEYle3JjtahyD7rvWb+nmlv23wwOhWI2UvwVXjgzU X-Received: by 2002:a50:93a2:: with SMTP id o31mr3968990eda.203.1595507120031; Thu, 23 Jul 2020 05:25:20 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1595507120; cv=none; d=google.com; s=arc-20160816; b=FKDtxNcSFLbmijmLa+7DFAxR/jCYLyQkZPqSNw2vMbwsKSq8E+9xG5btk+poqStYlq Gzt4K/T8RdGwXnpSkgXX/JNALh2/c9LeiLSj3qz7MUS3p95537pds7iglBYwbdVokOMy wajqSw1Q87yA8hN7O22KMkAubSJZeJJ7l8iwxD2anjK7hlX+h4NJAUcLWEWcuG9vAeHo 5sotWzglLSyN8MjRls/K2HHRYPkEprLhXvwNCjyzhIw9CnjBxqifTWP9mtlKQ/g2O2eQ 6QF4tbTLKfKgQEyFdTL6EmKPV7nMV38m7C3MQRqDeZb/FhqVb+wOO7UCBQcdrMSAGQrv PjOw== 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=fFCkXG9YSXNm34wg4F+wGX5K4ez31ESofd03IW98OEg=; b=kzycUwmPo6R6n6fUS5+PUdOMGAobS63j2e7OJ9E0gP1+p08/8B9mS0uTub1CDNa8s4 4/p/WxeZ+Lp9nnlkhzb5rrK8WwWuw0pP5InpsmM/v4cux+/y73jEDkSayK+sjkssZnMk HNJC8Hy0phXGRKNHgz4wnH7xPEGaawi99jF5cQeMqU+YzBW1TtHQPmpfzjdVio6QiqbF /Vlofl49RupZmuv7zWTEiNwLlb6QRMHbTNhZDoMBI8kW3kwDOxnuskMZOXbk24D0Oct9 R+005Ie/LnwXIcR5/zP3ZU5xZ0XckXch2WI3S5PlJJ4fcL3lldMUep89mm0RGwBO/+z7 oZ1Q== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b="y9/5H92V"; 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 b18si1916586ejb.89.2020.07.23.05.25.19 for ; Thu, 23 Jul 2020 05:25:20 -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="y9/5H92V"; 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 S1728981AbgGWMZQ (ORCPT ); Thu, 23 Jul 2020 08:25:16 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:58186 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1728961AbgGWMZO (ORCPT ); Thu, 23 Jul 2020 08:25:14 -0400 Received: from mail-wr1-x441.google.com (mail-wr1-x441.google.com [IPv6:2a00:1450:4864:20::441]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 81B0DC0698C4 for ; Thu, 23 Jul 2020 05:25:12 -0700 (PDT) Received: by mail-wr1-x441.google.com with SMTP id y3so4977615wrl.4 for ; Thu, 23 Jul 2020 05:25:12 -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=fFCkXG9YSXNm34wg4F+wGX5K4ez31ESofd03IW98OEg=; b=y9/5H92VbCA1egotNV9BA58XpjXdzU33aT3oGUcjZfBmDlpDVbbF3L5oth+TM4+oft LLsJa3FnzFeoDFjArzUyZhkCXcXOnwOlBsZ8xmvZquib1xqFDlxOQJzgvozOJ9BNkbh9 ds+ISMCJ45QDwEpbN/XFb5aZbnS2h8KzzD5QjQEMZSlXjDlebRw2UT1S63Udzvc7T6DP VKDlSzmGcVs7kG7++z+U/Xwi///G+AHZSBAZYL1B2SYOTk9Im/ecX+wcKU44M9Cqj3o+ HEJbpO+/Ro1oyUPOsr8IEbGlAcV5F2P2to7VA1MIpG2Qs2lEbPCvHX/TRY/TqKsbZ0Re tObA== 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=fFCkXG9YSXNm34wg4F+wGX5K4ez31ESofd03IW98OEg=; b=Op5/TCH3LJPRacqCCq07iQGZhe22D/yiQvvQ4vwbai4eI1s4D6zatgFVN4ruvCECOU n2/LdVYa1wbpmRRN/PgEID4PxGfs7lGXK8ayswp2Z74glwJXsQXj/T/0MMXQQZwbl0nM 9/83FKympG6eu6LQOvWQkA6byjYqSPCF0GGIgpRMlQVaCvXNZtKECoCymp6ZNbMq+3Sz 8gpVtP5KA/NIif4SLBd55HwEGWs4QuVg3uIhqBPrTaSeIJCs6jxbnxVXEiY5+iMuuhgA jpuWus/EmCruGTUD97bRBmUUDkrbJPUaUNWWq1qMWOuh9fV1g6otgQwWcDizPgpGAVgg hnjg== X-Gm-Message-State: AOAM5304xApuujBDu0Ors3GI+K1Fd31QzIX20dfKd2SyXBl6KmHF09sK jJ/WR6BUjp/Vyr48UhIPOkw7pQ== X-Received: by 2002:adf:92a1:: with SMTP id 30mr4196849wrn.56.1595507111228; Thu, 23 Jul 2020 05:25:11 -0700 (PDT) Received: from localhost.localdomain ([2.27.167.73]) by smtp.gmail.com with ESMTPSA id j5sm3510651wma.45.2020.07.23.05.25.10 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 23 Jul 2020 05:25:10 -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 , James Smart , Dick Kennedy Subject: [PATCH 18/40] scsi: lpfc: lpfc_mbox: Fix a bunch of kerneldoc misdemeanours Date: Thu, 23 Jul 2020 13:24:24 +0100 Message-Id: <20200723122446.1329773-19-lee.jones@linaro.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20200723122446.1329773-1-lee.jones@linaro.org> References: <20200723122446.1329773-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 Adding, removing and correcting function parameter descriptions. Fixes the following W=1 kernel build warning(s): drivers/scsi/lpfc/lpfc_mbox.c:886: warning: Function parameter or member 'vport' not described in 'lpfc_reg_vpi' drivers/scsi/lpfc/lpfc_mbox.c:886: warning: Excess function parameter 'phba' description in 'lpfc_reg_vpi' drivers/scsi/lpfc/lpfc_mbox.c:886: warning: Excess function parameter 'vpi' description in 'lpfc_reg_vpi' drivers/scsi/lpfc/lpfc_mbox.c:886: warning: Excess function parameter 'sid' description in 'lpfc_reg_vpi' drivers/scsi/lpfc/lpfc_mbox.c:1218: warning: Function parameter or member 'ring' not described in 'lpfc_config_ring' drivers/scsi/lpfc/lpfc_mbox.c:1626: warning: Function parameter or member 'mboxq' not described in 'lpfc_mbox_tmo_val' drivers/scsi/lpfc/lpfc_mbox.c:1626: warning: Excess function parameter 'cmd' description in 'lpfc_mbox_tmo_val' drivers/scsi/lpfc/lpfc_mbox.c:1710: warning: Function parameter or member 'sge' not described in 'lpfc_sli4_mbx_sge_get' drivers/scsi/lpfc/lpfc_mbox.c:1780: warning: Function parameter or member 'emb' not described in 'lpfc_sli4_config' drivers/scsi/lpfc/lpfc_mbox.c:2027: warning: Function parameter or member 'mboxq' not described in 'lpfc_sli4_mbx_read_fcf_rec' drivers/scsi/lpfc/lpfc_mbox.c:2078: warning: Function parameter or member 'phba' not described in 'lpfc_request_features' Cc: James Smart Cc: Dick Kennedy Signed-off-by: Lee Jones --- drivers/scsi/lpfc/lpfc_mbox.c | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) -- 2.25.1 diff --git a/drivers/scsi/lpfc/lpfc_mbox.c b/drivers/scsi/lpfc/lpfc_mbox.c index e34e0f11bfdd5..3414ffcb26fed 100644 --- a/drivers/scsi/lpfc/lpfc_mbox.c +++ b/drivers/scsi/lpfc/lpfc_mbox.c @@ -868,9 +868,7 @@ lpfc_sli4_unreg_all_rpis(struct lpfc_vport *vport) /** * lpfc_reg_vpi - Prepare a mailbox command for registering vport identifier - * @phba: pointer to lpfc hba data structure. - * @vpi: virtual N_Port identifier. - * @sid: Fibre Channel S_ID (N_Port_ID assigned to a virtual N_Port). + * @vport: pointer to a vport object. * @pmb: pointer to the driver internal queue element for mailbox command. * * The registration vport identifier mailbox command is used to activate a @@ -1199,7 +1197,7 @@ lpfc_config_hbq(struct lpfc_hba *phba, uint32_t id, /** * lpfc_config_ring - Prepare a mailbox command for configuring an IOCB ring * @phba: pointer to lpfc hba data structure. - * @ring: + * @ring: ring number/index * @pmb: pointer to the driver internal queue element for mailbox command. * * The configure ring mailbox command is used to configure an IOCB ring. This @@ -1613,7 +1611,7 @@ lpfc_mbox_dev_check(struct lpfc_hba *phba) /** * lpfc_mbox_tmo_val - Retrieve mailbox command timeout value * @phba: pointer to lpfc hba data structure. - * @cmd: mailbox command code. + * @mboxq: pointer to the driver internal queue element for mailbox command. * * This routine retrieves the proper timeout value according to the mailbox * command code. @@ -1700,6 +1698,7 @@ lpfc_sli4_mbx_sge_set(struct lpfcMboxq *mbox, uint32_t sgentry, * lpfc_sli4_mbx_sge_get - Get a sge entry from non-embedded mailbox command * @mbox: pointer to lpfc mbox command. * @sgentry: sge entry index. + * @sge: pointer to lpfc mailbox sge to load into. * * This routine gets an entry from the non-embedded mailbox command at the sge * index location. @@ -1767,6 +1766,7 @@ lpfc_sli4_mbox_cmd_free(struct lpfc_hba *phba, struct lpfcMboxq *mbox) * @subsystem: The sli4 config sub mailbox subsystem. * @opcode: The sli4 config sub mailbox command opcode. * @length: Length of the sli4 config mailbox command (including sub-header). + * @emb: True if embedded mbox command should be setup. * * This routine sets up the header fields of SLI4 specific mailbox command * for sending IOCTL command. @@ -2012,6 +2012,7 @@ lpfc_sli_config_mbox_opcode_get(struct lpfc_hba *phba, LPFC_MBOXQ_t *mbox) /** * lpfc_sli4_mbx_read_fcf_rec - Allocate and construct read fcf mbox cmd * @phba: pointer to lpfc hba data structure. + * @mboxq: pointer to lpfc mbox command. * @fcf_index: index to fcf table. * * This routine routine allocates and constructs non-embedded mailbox command @@ -2068,6 +2069,7 @@ lpfc_sli4_mbx_read_fcf_rec(struct lpfc_hba *phba, /** * lpfc_request_features: Configure SLI4 REQUEST_FEATURES mailbox + * @phba: pointer to lpfc hba data structure. * @mboxq: pointer to lpfc mbox command. * * This routine sets up the mailbox for an SLI4 REQUEST_FEATURES