Message ID | 20240220160406.3363002-2-maxime.chevallier@bootlin.com |
---|---|
State | New |
Headers |
Return-Path: <linux-kernel+bounces-73305-ouuuleilei=gmail.com@vger.kernel.org> Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:693c:2685:b0:108:e6aa:91d0 with SMTP id mn5csp499511dyc; Tue, 20 Feb 2024 08:05:59 -0800 (PST) X-Forwarded-Encrypted: i=3; AJvYcCWPZKcHLcmJO9yyijo5bM4MibSshkJLNvhaSkMUjtgZMq4SqQH9uowvGtt41DdLNgwXEl8DLzLSLw/mICFYLXG6z3FD4Q== X-Google-Smtp-Source: AGHT+IEFkjJTCE5ClES0H/dDCOX+MgFpf1zEhV1AEunMp6W3OGM+PZICrhryrj+LgBuEpMl/oCQM X-Received: by 2002:a17:906:6805:b0:a3f:252e:c245 with SMTP id k5-20020a170906680500b00a3f252ec245mr133843ejr.8.1708445159222; Tue, 20 Feb 2024 08:05:59 -0800 (PST) ARC-Seal: i=2; a=rsa-sha256; t=1708445159; cv=pass; d=google.com; s=arc-20160816; b=YqnarDpVYeR4yWG5VH/9DI3qcOmqanb1lpLn6g7VzKKpHf3ZmWczJQ0AbxAUDi7WP0 6QjhRcswrsFYCQF3QbSvQZFXl0ZpHEcpelGdSPB04Iw/8vyH5p9r+je+wgwv28PlDs7E bKkKQbypXDj3PsiUityHH2cGnW0Sjap2L8wK34296RlB4XitiGCcv3CGzZ5B22KNzOPl iymzQrl0Ox7HiTPCk56pD1BiVFvzjmpurH3LSMTjCJf+NCG7/6v3+e55cRiprkfm4ugD s9f5WFrqreGKhgNXJbaUdfW/viyxxCulGmZLEnSNv+nxAeQs7QfiN+Fce4ve4zpif7Ww iX4g== ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=content-transfer-encoding:mime-version:list-unsubscribe :list-subscribe:list-id:precedence:references:in-reply-to:message-id :date:subject:cc:to:from:dkim-signature; bh=0j6vyH8gSlQbmr8S5of7XqDa6oIEuqXtwYh8mWu5L1k=; fh=ucD0yDUQK4vkOjaD7gGMeT6G/Uk5SnXQjlHJp9K/X74=; b=h12gwAD2PufCPV4FqZdy2UTNHi7C/6wmoEZHbv2oNQCXzGDRn/rsPojgvglahcTX+c yqf8kkTwkqTFqEX4qKOw+tJHBxymYifjEvzmJ2DIQUll4ntaHw3qvZi3Ou8e/nfma4HN 3lfeFihMDlw8ahdtRGtqw3RiOqGkMdWD2iBvCnr0LXrPxOFjtjVXn47tJ/x7BQh27ms8 LlA/WEL9JEJEN11aapm2HivKWNeRE0bkbmI6Kjr2Jv9oiOOlvaDvk0ixOWMMB1A00MG3 4kSkN8/iQCoIiQ362kOK8BVk6xfikcRmNsTSCiPA/0nl4xlENRvQhrudAIlaFyp5gE+F ha/w==; dara=google.com ARC-Authentication-Results: i=2; mx.google.com; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=e9VXrQs1; arc=pass (i=1 spf=pass spfdomain=bootlin.com dkim=pass dkdomain=bootlin.com dmarc=pass fromdomain=bootlin.com); spf=pass (google.com: domain of linux-kernel+bounces-73305-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) smtp.mailfrom="linux-kernel+bounces-73305-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=bootlin.com Received: from am.mirrors.kernel.org (am.mirrors.kernel.org. [2604:1380:4601:e00::3]) by mx.google.com with ESMTPS id i20-20020a170906a29400b00a3ec216c61bsi1562793ejz.530.2024.02.20.08.05.59 for <ouuuleilei@gmail.com> (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 20 Feb 2024 08:05:59 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-73305-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) client-ip=2604:1380:4601:e00::3; Authentication-Results: mx.google.com; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=e9VXrQs1; arc=pass (i=1 spf=pass spfdomain=bootlin.com dkim=pass dkdomain=bootlin.com dmarc=pass fromdomain=bootlin.com); spf=pass (google.com: domain of linux-kernel+bounces-73305-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) smtp.mailfrom="linux-kernel+bounces-73305-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=bootlin.com Received: from smtp.subspace.kernel.org (wormhole.subspace.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by am.mirrors.kernel.org (Postfix) with ESMTPS id D19E91F22F43 for <ouuuleilei@gmail.com>; Tue, 20 Feb 2024 16:05:58 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id 362F2779F0; Tue, 20 Feb 2024 16:04:18 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=bootlin.com header.i=@bootlin.com header.b="e9VXrQs1" Received: from relay9-d.mail.gandi.net (relay9-d.mail.gandi.net [217.70.183.199]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 3228E763F7; Tue, 20 Feb 2024 16:04:11 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=217.70.183.199 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1708445055; cv=none; b=jbPkDCckNe4Lo5ip1GodcJgFVz8AuJ1ht1YJUmOC/qMsdK+aPyh1Mn3RAgrrlz+Hn4H1SIbWHzZ8b8llWvWxQShgcRob1MGE1qL+1Jz1hokY9bnM72b0YWgp4H4L0ZaYVVEfblPI8NJgoEXpjdKy51HBhYCh8N67ym5CmFdmUOM= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1708445055; c=relaxed/simple; bh=e41ssPMtOCWf4hbqr3GXct4QQnRw3mF4E7IEVePoDhE=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=JD0zUEtVTcd56k+h0snKjtXOQ5Z1SHrJNRBUQkzI4kGVcL5qEuDszatnOpNWpQ84UnG7A1dIGv/fI2eFpmyU74/hcodXgtkLRgwd8PgDgHHQZ9BGb1HSJVzYfL+pcbyQFA7Awd7tYAculxshTo0nCfjkK66GRd25c+YAFK81pHw= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=bootlin.com; spf=pass smtp.mailfrom=bootlin.com; dkim=pass (2048-bit key) header.d=bootlin.com header.i=@bootlin.com header.b=e9VXrQs1; arc=none smtp.client-ip=217.70.183.199 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=bootlin.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=bootlin.com Received: by mail.gandi.net (Postfix) with ESMTPSA id B4A73FF80F; Tue, 20 Feb 2024 16:04:09 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1708445050; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=0j6vyH8gSlQbmr8S5of7XqDa6oIEuqXtwYh8mWu5L1k=; b=e9VXrQs18lCFf1/zRSAhj5sva9sLY6gW28X4oZhRCpaATEU01ZwKgzaPAE7osDAQOLL+Zk rc9n54imIh0tbLeo21+VkT2DxsiOfIYCVWRsF2KMsV8G9Ykbg6PNKi7R2h5tP/sM8wHmkP t7S7Ex42lpQN1tr4r3ERIft66lrT4qpo+7JXIoU1gOig6hP8SZ2G3jTn/KY1hoDIKgd8TO G5WEbBVw1xPk23qy6zKyVAnITo6Xhel8WHfoVbA+IksW+vSi6rssx/3+/6gGPboTmQgxDN EV+vRk/fNKvqKB9W71mZ4AM4oZ2K2lpMb5421VrUi2f26CI0uC5AERxea+kWcw== From: Maxime Chevallier <maxime.chevallier@bootlin.com> To: davem@davemloft.net Cc: Maxime Chevallier <maxime.chevallier@bootlin.com>, netdev@vger.kernel.org, linux-kernel@vger.kernel.org, thomas.petazzoni@bootlin.com, Andrew Lunn <andrew@lunn.ch>, Jakub Kicinski <kuba@kernel.org>, Eric Dumazet <edumazet@google.com>, Paolo Abeni <pabeni@redhat.com>, Russell King <linux@armlinux.org.uk>, Florian Fainelli <f.fainelli@gmail.com>, Heiner Kallweit <hkallweit1@gmail.com>, Jonathan Corbet <corbet@lwn.net> Subject: [PATCH net-next 1/2] doc: sfp-phylink: drop the mention to phylink_config->pcs_poll Date: Tue, 20 Feb 2024 17:04:03 +0100 Message-ID: <20240220160406.3363002-2-maxime.chevallier@bootlin.com> X-Mailer: git-send-email 2.43.2 In-Reply-To: <20240220160406.3363002-1-maxime.chevallier@bootlin.com> References: <20240220160406.3363002-1-maxime.chevallier@bootlin.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: <linux-kernel.vger.kernel.org> List-Subscribe: <mailto:linux-kernel+subscribe@vger.kernel.org> List-Unsubscribe: <mailto:linux-kernel+unsubscribe@vger.kernel.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-GND-Sasl: maxime.chevallier@bootlin.com X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1791434591146885258 X-GMAIL-MSGID: 1791434591146885258 |
Series |
doc: sfp-phylink: update the porting guide
|
|
Commit Message
Maxime Chevallier
Feb. 20, 2024, 4:04 p.m. UTC
commit 64b4a0f8b51b ("net: phylink: remove phylink_config's pcs_poll")
dropped the phylink_config->pcs_poll field, which is no longer required
to be set by MAC drivers. Remove that mention in the phylink porting
guide.
Signed-off-by: Maxime Chevallier <maxime.chevallier@bootlin.com>
---
Documentation/networking/sfp-phylink.rst | 3 +--
1 file changed, 1 insertion(+), 2 deletions(-)
Comments
On Tue, Feb 20, 2024 at 05:04:03PM +0100, Maxime Chevallier wrote: > commit 64b4a0f8b51b ("net: phylink: remove phylink_config's pcs_poll") > dropped the phylink_config->pcs_poll field, which is no longer required > to be set by MAC drivers. Remove that mention in the phylink porting > guide. The porting guide needs to be updated with the PCS, and the details for that moved over rather than being deleted. While it's true that this member is gone from phylink_config, it was only removed after the introduction of the similarly named member in phylink_pcs. In other words, point 10 should probably read: 10. Arrange for PCS link state interrupts to be forwarded into phylink, via: .. code-block:: c phylink_pcs_change(pcs, link_is_up); where ``link_is_up`` is true if the link is currently up or false otherwise. If a PCS is unable to provide these interrupts, then it should set ``pcs->pcs_poll = true;`` when creating the PCS. However, for that to make sense, we then need the guide to provide details about creating the PCS, and also the mac_select_pcs() method. Thus my comment about a much bigger update being required.
Hi Russell, On Mon, 26 Feb 2024 11:41:07 +0000 "Russell King (Oracle)" <linux@armlinux.org.uk> wrote: > On Tue, Feb 20, 2024 at 05:04:03PM +0100, Maxime Chevallier wrote: > > commit 64b4a0f8b51b ("net: phylink: remove phylink_config's pcs_poll") > > dropped the phylink_config->pcs_poll field, which is no longer required > > to be set by MAC drivers. Remove that mention in the phylink porting > > guide. > > The porting guide needs to be updated with the PCS, and the details for > that moved over rather than being deleted. While it's true that this > member is gone from phylink_config, it was only removed after the > introduction of the similarly named member in phylink_pcs. > > In other words, point 10 should probably read: > > 10. Arrange for PCS link state interrupts to be forwarded into > phylink, via: > > .. code-block:: c > > phylink_pcs_change(pcs, link_is_up); > > where ``link_is_up`` is true if the link is currently up or false > otherwise. If a PCS is unable to provide these interrupts, then > it should set ``pcs->pcs_poll = true;`` when creating the PCS. > > However, for that to make sense, we then need the guide to provide > details about creating the PCS, and also the mac_select_pcs() method. > Thus my comment about a much bigger update being required. > Makes sense. If that's OK I'll send a V2 with a PCS handling addition to it, and see how that looks. Thanks for the review, Maxime
diff --git a/Documentation/networking/sfp-phylink.rst b/Documentation/networking/sfp-phylink.rst index 8054d33f449f..bc3365bbf096 100644 --- a/Documentation/networking/sfp-phylink.rst +++ b/Documentation/networking/sfp-phylink.rst @@ -264,8 +264,7 @@ this documentation. phylink_mac_change(priv->phylink, link_is_up); where ``link_is_up`` is true if the link is currently up or false - otherwise. If a MAC is unable to provide these interrupts, then - it should set ``priv->phylink_config.pcs_poll = true;`` in step 9. + otherwise. 11. Verify that the driver does not call::