From patchwork Wed Mar 17 09:12:19 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 403094 Delivered-To: patch@linaro.org Received: by 2002:a02:8562:0:0:0:0:0 with SMTP id g89csp294687jai; Wed, 17 Mar 2021 02:14:11 -0700 (PDT) X-Google-Smtp-Source: ABdhPJyAVue6jXlsKZKt/Xwnm0pRedYcOyS1AY4naIMlc4aDcw+Yrtjo7yEk+ZPBxQtZnmVAVg1I X-Received: by 2002:a17:906:3e89:: with SMTP id a9mr17393526ejj.405.1615972451402; Wed, 17 Mar 2021 02:14:11 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1615972451; cv=none; d=google.com; s=arc-20160816; b=ocIFz7fpExsMZDGufxkOl24irMRhqLMOnaTMEQM43Ijr1gbiJx4Fnb1Ne3wBxFHR8B iiKrdfSq1M+PU5K8pmurwM44zPegJWsJdfRMKINSD2B6+DLrdG6xFF6RnaigxvppDVv0 X4X024yuazFyJgBnfg9C81EoiMm7Ng/d5fY/w9sg3dmOZ6nWAmW8CT2NGeyNlWoyDN/8 v7j0J7y5hvZnzOyelbImaqVPjW8MvbEux7gG02C1yLJ5tyK6coUllxTXJlCHIXJKEIVT FDoqYUR6lz6BpINyJ0COS/ev4JCwBMvkNctgy+mEjWfvNG9rG+DaJ/V6yD668Zu6YUZ6 RACw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=kZBkTcxO8EifQ0gwNY5E+sYyudmJwbLtlJKo3G5cZ8o=; b=sc7KwHgHBoqJmiPCByTRr47qmrvUvbygHy9bFS4L3Ojo/DU5VusQexYnj1m82CuWNv CY4GpZUSVo+UcT/gwmtOn0qE1QEfhIrImkblE49eLbQZP/W3XY1GW6ICnPUiocork3zK rcStvNNjqU/uClEz/PDepNSfGmZHSZRbS+Ap13NypQNlpBV0g6QtTXax8mm38aRBihxs YsroX+gsURqjAGyzMRKli8iDsxOQEsekyv3JyYQ7+smasZsPC4H71PJ6UWO+xnHaT4Bk wma4m/vPvDNlJxL/6VlDpLlS9NnIFGSfgpZmLvZ14VAXEX5pRvPXjjWDM6+AXpZpVc9x hbAg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=luP4yaV+; 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 t15si15461864edq.164.2021.03.17.02.14.11 for ; Wed, 17 Mar 2021 02:14:11 -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=luP4yaV+; 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 S231149AbhCQJNo (ORCPT ); Wed, 17 Mar 2021 05:13:44 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:42760 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230254AbhCQJNH (ORCPT ); Wed, 17 Mar 2021 05:13:07 -0400 Received: from mail-wr1-x430.google.com (mail-wr1-x430.google.com [IPv6:2a00:1450:4864:20::430]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id B2881C061760 for ; Wed, 17 Mar 2021 02:13:06 -0700 (PDT) Received: by mail-wr1-x430.google.com with SMTP id k8so1005792wrc.3 for ; Wed, 17 Mar 2021 02:13:06 -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=kZBkTcxO8EifQ0gwNY5E+sYyudmJwbLtlJKo3G5cZ8o=; b=luP4yaV+fwkHYQpmk1DQfKhl+/VEMhoQSAs7sCanrHcYLSoAgQnK2dwi1rZfKwJAx+ hN9QcsMOs6A2/ziGckyvTsgAaFmJA8yUW0+6XBkwnBY8tFsW5Agv1daO8X9N8262Gnys J5FAzcFnc49KjptwKOBsBXQk+n/iont0qcvPawzi+U4C1l+Awlln/jDvTN+33pnGDhMg Vj0laBJ5WzLaKSbS6Y46Hv3sIn9YS4/zSVQmOo+EwCvuOGLEtS/KNLUqLBEpjIvSFT90 HhEsUZ1pU/Icj341RTzYgrQXqEyM+yr3Cix0OwHoEZW6+5gZKavUU1S2zd14Kejb1CBV LtyA== 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=kZBkTcxO8EifQ0gwNY5E+sYyudmJwbLtlJKo3G5cZ8o=; b=Jjl+1X7o+9J/tLVy936Z6Zd6bovM15b26rmk40I89ZSt4THou8FYq8s1Xt582IDax4 x0dG5wycUU6l83TsiMPKbq91G0E4i1XNmY9Xz8Rq7BwHqQsknihjqK0p5ci9F6E9pste 5Fbez0093IVRd9pev49pQY4BNoR43QoeAAv32LOFwRLCJXCS+mYsfVH0lbJmKDK+ObeI IzuAF38PHnwxFGr0boNRiUbrpJ99M3CR5qzWNJ+B19sxj914Sx5i4Hh2zj98TlDZwPV0 5/8EiGkj5SqbS/jzAJycsxqt1FUUd04ot8g3A1IEW6ZBeVUJeVG3FqaFmWFZqxesV/MP k2YQ== X-Gm-Message-State: AOAM532aFjnaUMZ/Dtbp2dRDtERpThQF+a6FnPIeLd3Ju2GzzIwgPXWl hXNQ/pea7DDHOM55J092luIA8Q== X-Received: by 2002:a5d:4e52:: with SMTP id r18mr3534533wrt.28.1615972385442; Wed, 17 Mar 2021 02:13:05 -0700 (PDT) Received: from dell.default ([91.110.221.194]) by smtp.gmail.com with ESMTPSA id e18sm12695886wru.73.2021.03.17.02.13.04 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 17 Mar 2021 02:13:05 -0700 (PDT) From: Lee Jones To: lee.jones@linaro.org Cc: linux-kernel@vger.kernel.org, Artur Paszkiewicz , "James E.J. Bottomley" , "Martin K. Petersen" , linux-scsi@vger.kernel.org Subject: [PATCH 25/36] scsi: isci: port_config: Fix a bunch of doc-rot and demote abuses Date: Wed, 17 Mar 2021 09:12:19 +0000 Message-Id: <20210317091230.2912389-26-lee.jones@linaro.org> X-Mailer: git-send-email 2.27.0 In-Reply-To: <20210317091230.2912389-1-lee.jones@linaro.org> References: <20210317091230.2912389-1-lee.jones@linaro.org> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-scsi@vger.kernel.org Fixes the following W=1 kernel build warning(s): drivers/scsi/isci/port_config.c:76: warning: Cannot understand * drivers/scsi/isci/port_config.c:105: warning: Cannot understand * drivers/scsi/isci/port_config.c:148: warning: Cannot understand * drivers/scsi/isci/port_config.c:376: warning: Cannot understand * drivers/scsi/isci/port_config.c:607: warning: Function parameter or member 'ihost' not described in 'sci_apc_agent_link_up' drivers/scsi/isci/port_config.c:607: warning: Function parameter or member 'port_agent' not described in 'sci_apc_agent_link_up' drivers/scsi/isci/port_config.c:607: warning: Function parameter or member 'iport' not described in 'sci_apc_agent_link_up' drivers/scsi/isci/port_config.c:607: warning: Function parameter or member 'iphy' not described in 'sci_apc_agent_link_up' drivers/scsi/isci/port_config.c:607: warning: Excess function parameter 'scic' description in 'sci_apc_agent_link_up' drivers/scsi/isci/port_config.c:607: warning: Excess function parameter 'sci_port' description in 'sci_apc_agent_link_up' drivers/scsi/isci/port_config.c:607: warning: Excess function parameter 'sci_phy' description in 'sci_apc_agent_link_up' drivers/scsi/isci/port_config.c:623: warning: Cannot understand * drivers/scsi/isci/port_config.c:701: warning: Cannot understand * Cc: Artur Paszkiewicz Cc: "James E.J. Bottomley" Cc: "Martin K. Petersen" Cc: linux-scsi@vger.kernel.org Signed-off-by: Lee Jones --- drivers/scsi/isci/port_config.c | 37 +++++++++++++++++---------------- 1 file changed, 19 insertions(+), 18 deletions(-) -- 2.27.0 diff --git a/drivers/scsi/isci/port_config.c b/drivers/scsi/isci/port_config.c index b1c1975055792..c382a257b51b9 100644 --- a/drivers/scsi/isci/port_config.c +++ b/drivers/scsi/isci/port_config.c @@ -73,7 +73,7 @@ enum SCIC_SDS_APC_ACTIVITY { * ****************************************************************************** */ /** - * + * sci_sas_address_compare() * @address_one: A SAS Address to be compared. * @address_two: A SAS Address to be compared. * @@ -102,9 +102,9 @@ static s32 sci_sas_address_compare( } /** - * - * @controller: The controller object used for the port search. - * @phy: The phy object to match. + * sci_port_configuration_agent_find_port() + * @ihost: The controller object used for the port search. + * @iphy: The phy object to match. * * This routine will find a matching port for the phy. This means that the * port and phy both have the same broadcast sas address and same received sas @@ -145,8 +145,8 @@ static struct isci_port *sci_port_configuration_agent_find_port( } /** - * - * @controller: This is the controller object that contains the port agent + * sci_port_configuration_agent_validate_ports() + * @ihost: This is the controller object that contains the port agent * @port_agent: This is the port configuration agent for the controller. * * This routine will validate the port configuration is correct for the SCU @@ -373,15 +373,16 @@ static void sci_mpc_agent_link_up(struct isci_host *ihost, } /** - * - * @controller: This is the controller object that receives the link down + * sci_mpc_agent_link_down() + * @ihost: This is the controller object that receives the link down * notification. - * @port: This is the port object associated with the phy. If the is no + * @port_agent: This is the port configuration agent for the controller. + * @iport: This is the port object associated with the phy. If the is no * associated port this is an NULL. The port is an invalid * handle only if the phy was never port of this port. This happens when * the phy is not broadcasting the same SAS address as the other phys in the * assigned port. - * @phy: This is the phy object which has gone link down. + * @iphy: This is the phy object which has gone link down. * * This function handles the manual port configuration link down notifications. * Since all ports and phys are associated at initialization time we just turn @@ -590,11 +591,12 @@ static void sci_apc_agent_configure_ports(struct isci_host *ihost, /** * sci_apc_agent_link_up - handle apc link up events - * @scic: This is the controller object that receives the link up + * @ihost: This is the controller object that receives the link up * notification. - * @sci_port: This is the port object associated with the phy. If the is no + * @port_agent: This is the port configuration agent for the controller. + * @iport: This is the port object associated with the phy. If the is no * associated port this is an NULL. - * @sci_phy: This is the phy object which has gone link up. + * @iphy: This is the phy object which has gone link up. * * This method handles the automatic port configuration for link up * notifications. Is it possible to get a link down notification from a phy @@ -620,9 +622,10 @@ static void sci_apc_agent_link_up(struct isci_host *ihost, } /** - * - * @controller: This is the controller object that receives the link down + * sci_apc_agent_link_down() + * @ihost: This is the controller object that receives the link down * notification. + * @port_agent: This is the port configuration agent for the controller. * @iport: This is the port object associated with the phy. If the is no * associated port this is an NULL. * @iphy: This is the phy object which has gone link down. @@ -697,9 +700,7 @@ static void apc_agent_timeout(struct timer_list *t) * Public port configuration agent routines * ****************************************************************************** */ -/** - * - * +/* * This method will construct the port configuration agent for operation. This * call is universal for both manual port configuration and automatic port * configuration modes.