From patchwork Wed Jul 8 12:02:03 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 235070 Delivered-To: patch@linaro.org Received: by 2002:a92:d244:0:0:0:0:0 with SMTP id v4csp369614ilg; Wed, 8 Jul 2020 05:02:46 -0700 (PDT) X-Google-Smtp-Source: ABdhPJyF7x9485gXA9PNFDqszVOZYj9cBiXFUTSN+teTc3+mrB3nwHQrq+BLV3uXzxFLt608INtS X-Received: by 2002:a17:906:c24e:: with SMTP id bl14mr50075957ejb.285.1594209766382; Wed, 08 Jul 2020 05:02:46 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1594209766; cv=none; d=google.com; s=arc-20160816; b=OyEdPOrvU1ZsC3rkWZ/XpV7FvVKkYct+ygIM9c4nM2b/Ti1RQvoW6QPAEz2lRJ1RRA dM4zSrjpWwB0CssIHa8whGkhAgssQzTTefp0ltvAoMnSw1ijPplaDEdmndZsjCDpgV/7 2IQ+BTTzPH+xCplqVSbE5/TuaTpba+aYAOIdWy1Epw7Lw/JpdIDSilP0pkW8S2k13p5L V6bB8x92vww3fwaARzqy0FiFHtF1522z+TjTIPTOM3TVnuAPOtRoTvwEUSOks92jHDm0 CqYY3wAJdvvMsqERfiMROWH2T1EP5eRKGjWeYTjD+eKwqMEcbLGT0QY0zTC4ZW0BNSTa D97g== 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=DSQYT4u05u5XHMfy8CsexKzDa1uvZ/5gisr4AmMPcPk=; b=PoCVUs2Pfpkip5xh0Ge4NtnSSbAT1we6WrFBe8t0AwUe/dsnmKwrlL6rcetzDzTjdi LbQA78MCRivfJr9wQ7KbYx7xTIbTWh7DW9lfm/7J/rxYGt/Ceg3gPPX9Fy3rrEzVCZJ6 AAf/Y167leq7aNBTJJv21YCPsoRmK3tLn80Nnlf1QMaygjdcWevMBqOiWJIc63fuMKKb Nr80+VQp+YFCVnR4g4eYDO4rn1yJg5E8goMFLdThNCFnp5Ln39kd7JznBRlZ16/290ZO J7dqxDQ6TKD8VXN7sgckgApHGvD9PpwF1GvdvqlAHQMSKf3ZeqhpiCVQfKjd1UgmXD++ JoFQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=P7pECm1G; 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 r22si17696576edq.411.2020.07.08.05.02.46 for ; Wed, 08 Jul 2020 05:02:46 -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=P7pECm1G; 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 S1729089AbgGHMCp (ORCPT ); Wed, 8 Jul 2020 08:02:45 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:55408 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1729069AbgGHMCo (ORCPT ); Wed, 8 Jul 2020 08:02:44 -0400 Received: from mail-wm1-x342.google.com (mail-wm1-x342.google.com [IPv6:2a00:1450:4864:20::342]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id B455AC08E876 for ; Wed, 8 Jul 2020 05:02:43 -0700 (PDT) Received: by mail-wm1-x342.google.com with SMTP id q15so2726218wmj.2 for ; Wed, 08 Jul 2020 05:02:43 -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=DSQYT4u05u5XHMfy8CsexKzDa1uvZ/5gisr4AmMPcPk=; b=P7pECm1Gy1aRGbb++bMKhwPg0A2Y4d68UaMYFhuCKyV7BMX6/bLCcJJU1aOmkTCNnR ESXvFF0ZIUpyGUBlYp41i+v78s2zHN9JN7jTrQO8KRQt9mga3jI+XfLhqnrLMqCQ0Ql9 xM+/0JCu3uYPvksvh9FzSn57QgfB9VHwcitInoNrmizP17t+sRXsyi7hr0pIaiz+CKRJ LdOaxKfUR9WU9i4gXuE2ygO0DsQsZxTXF1SoBYUkR3cBmKoi16XVhdpP5LgzttcngxtY sxcZlUl0YpiKu3mokih0XocFqx5/DZ9iKJTByM1jXxN6M+DiyYpuvQLDF4odHGcRnGNy 7CEQ== 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=DSQYT4u05u5XHMfy8CsexKzDa1uvZ/5gisr4AmMPcPk=; b=U4xWUE5Z/WuZt+q0RKyNgcqPFvuDeIRRbEba+YSWJaMV6tq/ICaJlkEhHZ4ugICP/y D4vVcbShcmz2Zlq5NxPfcb2yT4+63Qzq5RLr2+ppQEWLMAq7kJuDS6Io3AfBMz6i+FE2 xQJTmtRef8i7pYzN3B5oJ09LLO3aCZzqWgZFJfhtY/oqFotKp+6nlMnMigEYKQ5+altU nKLeO02TeniRn+Q3ro0L9PH56F+PkDA5+xCTctM4duMyfTlwGcvuDb5jfyu+JZyo0heB nvDTz40Lx4EGbL11S7QbR3o7Zjod+sMZO8No7H04DgiDmtRO8Cc4WVQrdHwjor8cEQSP 3OiQ== X-Gm-Message-State: AOAM532xQQA1taamGZ/fvpjYlWxCbmIh35q113s6evgSCfsqjZmq4Q+e ByruaR8mbcIy728KxSinY6Eb5Q== X-Received: by 2002:a05:600c:2c0d:: with SMTP id q13mr8769318wmg.81.1594209762080; Wed, 08 Jul 2020 05:02:42 -0700 (PDT) Received: from localhost.localdomain ([2.27.35.206]) by smtp.gmail.com with ESMTPSA id m62sm3964997wmm.42.2020.07.08.05.02.40 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 08 Jul 2020 05:02:41 -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 , Hannes Reinecke Subject: [PATCH 12/30] scsi: libfc: fc_fcp: Provide missing and repair existing function documentation Date: Wed, 8 Jul 2020 13:02:03 +0100 Message-Id: <20200708120221.3386672-13-lee.jones@linaro.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20200708120221.3386672-1-lee.jones@linaro.org> References: <20200708120221.3386672-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 Mostly due to descriptions not keeping up with API changes. Fixes the following W=1 kernel build warning(s): drivers/scsi/libfc/fc_fcp.c:299: warning: Function parameter or member 'status_code' not described in 'fc_fcp_retry_cmd' drivers/scsi/libfc/fc_fcp.c:595: warning: Function parameter or member 'seq' not described in 'fc_fcp_send_data' drivers/scsi/libfc/fc_fcp.c:595: warning: Excess function parameter 'sp' description in 'fc_fcp_send_data' drivers/scsi/libfc/fc_fcp.c:1289: warning: Function parameter or member 't' not described in 'fc_lun_reset_send' drivers/scsi/libfc/fc_fcp.c:1289: warning: Excess function parameter 'data' description in 'fc_lun_reset_send' drivers/scsi/libfc/fc_fcp.c:1422: warning: Function parameter or member 't' not described in 'fc_fcp_timeout' drivers/scsi/libfc/fc_fcp.c:1422: warning: Excess function parameter 'data' description in 'fc_fcp_timeout' drivers/scsi/libfc/fc_fcp.c:1696: warning: Function parameter or member 'code' not described in 'fc_fcp_recovery' drivers/scsi/libfc/fc_fcp.c:1716: warning: Function parameter or member 'offset' not described in 'fc_fcp_srr' drivers/scsi/libfc/fc_fcp.c:1859: warning: Function parameter or member 'sc_cmd' not described in 'fc_queuecommand' drivers/scsi/libfc/fc_fcp.c:1859: warning: Excess function parameter 'cmd' description in 'fc_queuecommand' Cc: Hannes Reinecke Signed-off-by: Lee Jones --- drivers/scsi/libfc/fc_fcp.c | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) -- 2.25.1 diff --git a/drivers/scsi/libfc/fc_fcp.c b/drivers/scsi/libfc/fc_fcp.c index bf2cc9656e191..d1ff2335f552b 100644 --- a/drivers/scsi/libfc/fc_fcp.c +++ b/drivers/scsi/libfc/fc_fcp.c @@ -289,6 +289,7 @@ static int fc_fcp_send_abort(struct fc_fcp_pkt *fsp) /** * fc_fcp_retry_cmd() - Retry a fcp_pkt * @fsp: The FCP packet to be retried + * @status_code: The FCP status code to set * * Sets the status code to be FC_ERROR and then calls * fc_fcp_complete_locked() which in turn calls fc_io_compl(). @@ -580,7 +581,7 @@ static void fc_fcp_recv_data(struct fc_fcp_pkt *fsp, struct fc_frame *fp) /** * fc_fcp_send_data() - Send SCSI data to a target * @fsp: The FCP packet the data is on - * @sp: The sequence the data is to be sent on + * @seq: The sequence the data is to be sent on * @offset: The starting offset for this data request * @seq_blen: The burst length for this data request * @@ -1283,7 +1284,7 @@ static int fc_fcp_pkt_abort(struct fc_fcp_pkt *fsp) /** * fc_lun_reset_send() - Send LUN reset command - * @data: The FCP packet that identifies the LUN to be reset + * @t: Timer context used to fectch the FSP packet */ static void fc_lun_reset_send(struct timer_list *t) { @@ -1409,7 +1410,7 @@ static void fc_fcp_cleanup(struct fc_lport *lport) /** * fc_fcp_timeout() - Handler for fcp_pkt timeouts - * @data: The FCP packet that has timed out + * @t: Timer context used to fectch the FSP packet * * If REC is supported then just issue it and return. The REC exchange will * complete or time out and recovery can continue at that point. Otherwise, @@ -1691,6 +1692,7 @@ static void fc_fcp_rec_error(struct fc_fcp_pkt *fsp, struct fc_frame *fp) /** * fc_fcp_recovery() - Handler for fcp_pkt recovery * @fsp: The FCP pkt that needs to be aborted + * @code: The FCP status code to set */ static void fc_fcp_recovery(struct fc_fcp_pkt *fsp, u8 code) { @@ -1709,6 +1711,7 @@ static void fc_fcp_recovery(struct fc_fcp_pkt *fsp, u8 code) * fc_fcp_srr() - Send a SRR request (Sequence Retransmission Request) * @fsp: The FCP packet the SRR is to be sent on * @r_ctl: The R_CTL field for the SRR request + * @offset: The SRR relative offset * This is called after receiving status but insufficient data, or * when expecting status but the request has timed out. */ @@ -1851,7 +1854,7 @@ static inline int fc_fcp_lport_queue_ready(struct fc_lport *lport) /** * fc_queuecommand() - The queuecommand function of the SCSI template * @shost: The Scsi_Host that the command was issued to - * @cmd: The scsi_cmnd to be executed + * @sc_cmd: The scsi_cmnd to be executed * * This is the i/o strategy routine, called by the SCSI layer. */