From patchwork Mon Oct 23 09:33:40 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Oleksij Rempel X-Patchwork-Id: 156779 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:ce89:0:b0:403:3b70:6f57 with SMTP id p9csp1175024vqx; Mon, 23 Oct 2023 02:35:06 -0700 (PDT) X-Google-Smtp-Source: AGHT+IFzgHWCHnyNQ2UaSwaJJMZdSjV0I+/LeltDMWpbEkCZW3KVd6YRRFUgO6XonIw7CmGuwbOb X-Received: by 2002:a05:6300:8085:b0:15e:707c:904 with SMTP id ap5-20020a056300808500b0015e707c0904mr6329439pzc.24.1698053705633; Mon, 23 Oct 2023 02:35:05 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1698053705; cv=none; d=google.com; s=arc-20160816; b=chd0wBqhhfg1JHocchrnzLenFoxdxFY8xXLuFkNwceNoodxOIYVCOnGO18qk+9VLnV OMMomqrrma0O/h0iaLh+tJnWD/fCZ39S4d+hYyAbz6xiN9Il+f0PO/1Q8hMgK15Pa+26 ZHyUbP9dYpQh398BE4VAdj4AfROg/HUk5JC39onNMOmHdigwgbB2XUCgXqlbdw8CL142 kz9Td+80WxkkoCk3bv0qjxrYRdCbLnyIRA+S6I+06b8d8mBsS03lQhPLNz02mVF69j39 I+Be8D7llIyAqdNQ1IAIgWOnmZkXTW5NTf9nqbbHTNTKvtrNMgcNwNC3TfoFuaUSNpWc KEdQ== 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=gczAXFpcGPxeM5LzjHFg5UWyvrSBq5YALTMOlVm0Zks=; fh=dtm4yT6MkhVTfBPO3z+Y52DNxAcSgnFad+iu/czBlro=; b=zWbEKpW/3p0fEQYL2mMMaHodejUOsokazxr6u/hNRubKybeg8Z4f98N2aL+aD+qN88 A5Hn0u1VdrJeLAqBHk2OroqaESmoPU73L/+KSjrNCHxUtDKUjgULO7aRy3DwYtuPZKTY shyN5/+Bpqvl4UQGhFjBb+A/cSFLsy3I/bxpLiSW2N6Z14maoQI/tfGL3WZ+8Hr/iPYx ttTc3wzr/eZxTDbyganv9KBPhqgWKXOKlHgB/FCqAoCMgVpIcSDRCysJHnfg4iFcHGx8 GPLtTaakMWbvK0Dpio5PEZR/UI17vKsuaeaW0Z6LalyuqQjV56z1dsO+L/WGpljBOTAi XfVw== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.31 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from morse.vger.email (morse.vger.email. [23.128.96.31]) by mx.google.com with ESMTPS id gj19-20020a17090b109300b0027d0c811520si8354179pjb.95.2023.10.23.02.35.05 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 23 Oct 2023 02:35:05 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.31 as permitted sender) client-ip=23.128.96.31; Authentication-Results: mx.google.com; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.31 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 morse.vger.email (Postfix) with ESMTP id 973D28042D2D; Mon, 23 Oct 2023 02:35:03 -0700 (PDT) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.10 at morse.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233116AbjJWJe0 (ORCPT + 27 others); Mon, 23 Oct 2023 05:34:26 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:53076 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229749AbjJWJeI (ORCPT ); Mon, 23 Oct 2023 05:34:08 -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 A2007B7 for ; Mon, 23 Oct 2023 02:34:05 -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 1qurJi-0000DF-0n; Mon, 23 Oct 2023 11:33:46 +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 1qurJh-003fwt-2z; Mon, 23 Oct 2023 11:33:45 +0200 Received: from ore by dude04.red.stw.pengutronix.de with local (Exim 4.96) (envelope-from ) id 1qurJg-009wdT-36; Mon, 23 Oct 2023 11:33:44 +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 v7 6/9] net: dsa: microchip: Refactor comment for ksz_switch_macaddr_get() function Date: Mon, 23 Oct 2023 11:33:40 +0200 Message-Id: <20231023093343.2370248-7-o.rempel@pengutronix.de> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20231023093343.2370248-1-o.rempel@pengutronix.de> References: <20231023093343.2370248-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 morse.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 (morse.vger.email [0.0.0.0]); Mon, 23 Oct 2023 02:35:03 -0700 (PDT) X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1780538362078518767 X-GMAIL-MSGID: 1780538362078518767 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 a5ea372db3a5..0442c1b628d9 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)