From patchwork Thu Oct 26 05:10:48 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Oleksij Rempel X-Patchwork-Id: 158399 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:d641:0:b0:403:3b70:6f57 with SMTP id cy1csp434649vqb; Wed, 25 Oct 2023 22:12:18 -0700 (PDT) X-Google-Smtp-Source: AGHT+IGAUIooWebou82v5bDfAQyWW+DGX3CheKSci0YYfg3EEebHh+oKDuWDnI7ErZE2HuIH1QrS X-Received: by 2002:a81:52c9:0:b0:5a8:f9fa:aba4 with SMTP id g192-20020a8152c9000000b005a8f9faaba4mr18409292ywb.2.1698297138285; Wed, 25 Oct 2023 22:12:18 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1698297138; cv=none; d=google.com; s=arc-20160816; b=m7+USDiNTR3E6CYF2UjGs7p88Ev9wlhZeBcYqKZCiFYs4B+4yNhvAJK+qsmWYk50lx dOEgRoku+HpMHPovLPnRNTyP6lriHCHz3qWLRD+G30IPfQvSVpvubVy0h0qrhhbLAVZS NQ2yy0b4sbHNj33KJ4JX8TaHbbmgvAiOyRNRdruLWNFNOxq/nMyp7GBGZq7Bbi8bT8h3 VxSKv3jKwsyfRUxVS/Zi6chVYT9MIxQXGUQ+Ob9iRnGXTqZmjjbK0qKy9pYkzwiLxL4s 2HS3upqev24+iMrjbEeFtBnqiWJ0py0c+9ZWtcNLnfp54ps/YclQbyg5PcoLTWcIC0Om hn6w== 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; bh=keT+ge3sqP1UhYV24CNFfvctREwcQw7xKA55+QlFDWg=; fh=dtm4yT6MkhVTfBPO3z+Y52DNxAcSgnFad+iu/czBlro=; b=O4nVzDxq+zCMggAIh3TUlenQ3uj4tzGFIbAKFOrNsNqCZSacmmTyBRjR8a/TkhpyE1 obausmrq1SwZVwJr1xsVak7Mw99ga1J9ow4+bRGmjz+2Zf2Uu4kGqEAvclKb5Zdvqlo/ 0nmgh9FU0KBe7f4Rlfj8KMsiZE+yd5bSaBq/lkNs6k/3mb6w+Nel2ctp37kVa7rjG0iR VYQMwfX9RKVSBC7yuLEwOXV1PcVclP1v+j4Vt0e71aVCem1mwomU1KQM82XquupUjKxi KWd7ELSFs6DffRn5NxfL7gKWwUG+wMICJBZOkMfw24y/w3s87yl9TIDd/TsFkFwogrMC oUyQ== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:2 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from agentk.vger.email (agentk.vger.email. [2620:137:e000::3:2]) by mx.google.com with ESMTPS id s188-20020a0dd0c5000000b0059f5275707asi13542128ywd.453.2023.10.25.22.12.17 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 25 Oct 2023 22:12:18 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:2 as permitted sender) client-ip=2620:137:e000::3:2; Authentication-Results: mx.google.com; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:2 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from out1.vger.email (depot.vger.email [IPv6:2620:137:e000::3:0]) by agentk.vger.email (Postfix) with ESMTP id B3E4580A5320; Wed, 25 Oct 2023 22:12:04 -0700 (PDT) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.10 at agentk.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234894AbjJZFLh (ORCPT + 26 others); Thu, 26 Oct 2023 01:11:37 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:52392 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233231AbjJZFLX (ORCPT ); Thu, 26 Oct 2023 01:11:23 -0400 Received: from metis.whiteo.stw.pengutronix.de (metis.whiteo.stw.pengutronix.de [IPv6:2a0a:edc0:2:b01:1d::104]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 9957C18F for ; Wed, 25 Oct 2023 22:11:20 -0700 (PDT) Received: from drehscheibe.grey.stw.pengutronix.de ([2a0a:edc0:0:c01:1d::a2]) by metis.whiteo.stw.pengutronix.de with esmtps (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1qvsdy-0004Y9-Oc; Thu, 26 Oct 2023 07:10:54 +0200 Received: from [2a0a:edc0:0:1101:1d::ac] (helo=dude04.red.stw.pengutronix.de) by drehscheibe.grey.stw.pengutronix.de with esmtps (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.94.2) (envelope-from ) id 1qvsdw-004L1R-MZ; Thu, 26 Oct 2023 07:10:52 +0200 Received: from ore by dude04.red.stw.pengutronix.de with local (Exim 4.96) (envelope-from ) id 1qvsdw-009ikn-21; Thu, 26 Oct 2023 07:10:52 +0200 From: Oleksij Rempel To: "David S. Miller" , Andrew Lunn , Eric Dumazet , Florian Fainelli , Jakub Kicinski , Paolo Abeni , Vladimir Oltean , Woojung Huh , Arun Ramadoss , Conor Dooley , Krzysztof Kozlowski , Rob Herring Cc: Oleksij Rempel , Florian Fainelli , Vladimir Oltean , kernel@pengutronix.de, linux-kernel@vger.kernel.org, netdev@vger.kernel.org, UNGLinuxDriver@microchip.com, "Russell King (Oracle)" , devicetree@vger.kernel.org Subject: [PATCH net-next v8 2/5] net: dsa: microchip: Refactor comment for ksz_switch_macaddr_get() function Date: Thu, 26 Oct 2023 07:10:48 +0200 Message-Id: <20231026051051.2316937-3-o.rempel@pengutronix.de> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20231026051051.2316937-1-o.rempel@pengutronix.de> References: <20231026051051.2316937-1-o.rempel@pengutronix.de> MIME-Version: 1.0 X-SA-Exim-Connect-IP: 2a0a:edc0:0:c01:1d::a2 X-SA-Exim-Mail-From: ore@pengutronix.de X-SA-Exim-Scanned: No (on metis.whiteo.stw.pengutronix.de); SAEximRunCond expanded to false X-PTX-Original-Recipient: linux-kernel@vger.kernel.org X-Spam-Status: No, score=-0.8 required=5.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS autolearn=unavailable autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on agentk.vger.email Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (agentk.vger.email [0.0.0.0]); Wed, 25 Oct 2023 22:12:05 -0700 (PDT) X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1780793620266330109 X-GMAIL-MSGID: 1780793620266330109 Update the comment to follow kernel-doc format. Signed-off-by: Oleksij Rempel Reviewed-by: Florian Fainelli Reviewed-by: Vladimir Oltean --- drivers/net/dsa/microchip/ksz_common.c | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/drivers/net/dsa/microchip/ksz_common.c b/drivers/net/dsa/microchip/ksz_common.c index 8244204e177d..0c3adc389d0b 100644 --- a/drivers/net/dsa/microchip/ksz_common.c +++ b/drivers/net/dsa/microchip/ksz_common.c @@ -3617,12 +3617,20 @@ bool ksz_is_port_mac_global_usable(struct dsa_switch *ds, int port) return true; } -/* Program the switch's MAC address register with the MAC address of the - * requesting user port. This single address is used by the switch for multiple - * features, like HSR self-address filtering and WoL. Other user ports are - * allowed to share ownership of this address as long as their MAC address is - * the same. The user ports' MAC addresses must not change while they have - * ownership of the switch MAC address. +/** + * ksz_switch_macaddr_get - Program the switch's MAC address register. + * @ds: DSA switch instance. + * @port: Port number. + * @extack: Netlink extended acknowledgment. + * + * This function programs the switch's MAC address register with the MAC address + * of the requesting user port. This single address is used by the switch for + * multiple features like HSR self-address filtering and WoL. Other user ports + * can share ownership of this address as long as their MAC address is the same. + * The MAC addresses of user ports must not change while they have ownership of + * the switch MAC address. + * + * Return: 0 on success, or other error codes on failure. */ int ksz_switch_macaddr_get(struct dsa_switch *ds, int port, struct netlink_ext_ack *extack)