Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   Sean Anderson <sean.anderson@seco.com>
To:     netdev@vger.kernel.org, Andrew Lunn <andrew@lunn.ch>,
        Heiner Kallweit <hkallweit1@gmail.com>,
        Russell King <linux@armlinux.org.uk>
Cc:     Jakub Kicinski <kuba@kernel.org>, Paolo Abeni <pabeni@redhat.com>,
        Vladimir Oltean <olteanv@gmail.com>,
        Alexandru Marginean <alexandru.marginean@nxp.com>,
        linux-kernel@vger.kernel.org,
        "David S . Miller" <davem@davemloft.net>,
        Eric Dumazet <edumazet@google.com>,
        Sean Anderson <sean.anderson@seco.com>
Subject: [PATCH net-next v5 1/8] net: phylink: Document MAC_(A)SYM_PAUSE
Date:   Tue,  6 Sep 2022 12:18:45 -0400
Message-Id: <20220906161852.1538270-2-sean.anderson@seco.com>
In-Reply-To: <20220906161852.1538270-1-sean.anderson@seco.com>
References: <20220906161852.1538270-1-sean.anderson@seco.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?EngBo/28MUTdAAOOVr7cMfWvg9ZF2ZgMGL5FJ7yqjRsPDfBkZywgeb+VYJwj?=
 =?us-ascii?Q?kQq8krqhNonnPs5Xb4fbpv04jpb/E3rQKiqKmXAzAGnlkurMttHSdA9+Jckq?=
 =?us-ascii?Q?dzbsX6irfZ2efPG3y7zNa+5LgCsZsGpkl2wQcaIQ9RGh1TX0Fa78IqtZljPb?=
 =?us-ascii?Q?DvXF9rMcc5uVIQOGImSp2sIz+M8WIRkPrn0Iiq5EwDNRWG10HHa40DkEwuQu?=
 =?us-ascii?Q?jXPgDdXBJ8X7gxvBmWawXELlAEXk8bvZDEapYiZ1aGMhiuA6ql+eHUVwWAzd?=
 =?us-ascii?Q?hk72xj9nMfC+8PJz/UZyUlya189/qZsqFYitbeLnU32MXCOg8zQMzJrgBtSY?=
 =?us-ascii?Q?F6QI3qmN6Vld7xyMb8cjTBwgqCfKyi2bZ3F+XmLkKnWjZ5qasDFKUzHJWs+e?=
 =?us-ascii?Q?E0HiHhi7+76Z/X8HFXqMQnRrJtN03lJzaRP8GBSD1xtLe9RzA6ICqDP3qo7O?=
 =?us-ascii?Q?ahMeDOT16UtxdxpChNCtZqXBoTzzVqTtJVKtE1X2gj57EgpJABUCdcIRnc/f?=
 =?us-ascii?Q?pEtSi/dIu6Ui/eEHdxA1yISbMpESrQB8umwzYxW68ClP91lh05lrygmyYcJG?=
 =?us-ascii?Q?ZBNMv7AXhfo0ssvgJQbBeI+eNXZd/NOA+VFBVrPd5cp+a/6l5zSGfZB8ECH7?=
 =?us-ascii?Q?TI0fGnWMGL1krDtrSBczvhPXc1M5hPOrHd9wEvmGxMQVL2h+n+dJKF8qDQuz?=
 =?us-ascii?Q?+em2KTwXROvQ6O4I9KhiX5nju1QNkCM6Kacq/vi0/cFwgUJHUx2heBE/tzGN?=
 =?us-ascii?Q?CJfjP4vC4lz9Ky5q+eMVKawhp6x6EVtYJel60xNKRAUxdHXR18zo1bIlYb4Z?=
 =?us-ascii?Q?uaa6T/ZjXaVQMzcyMIWWkbMnRYYB3CvCANpITf64Wr5/mTv2toFYZS84Zcsx?=
 =?us-ascii?Q?tNU9O3VZ0xB4DnGNTIg64yw+EduBuDzIb/m7DUE4mDLAZEp9U/yWQXAPO61G?=
 =?us-ascii?Q?88x2UWBNGlSPq7HmTRjO0QSQp1EnoFVEfB099Rucx2st7RBU2UdNcix3oa3F?=
 =?us-ascii?Q?pggUoy5ZVvhuBwV7QDjnTM9n2SM+buzEnEO1HGwQBJ8FpfDGtlfUhITjhT3f?=
 =?us-ascii?Q?DLX0hQBOOpNXI3rfOJDEZcegIkEI7MrQhPtiyo0LyviGD1X05icT4COSL47G?=
 =?us-ascii?Q?LfCdZC7mdbh3Aq3j4bEDnv7kCechipnGbZhLSPUU4CybtemJiwmvB7OAjlAv?=
 =?us-ascii?Q?hNCIWQdz+/XSRcmNbd2N1LGKSJ894F2rt/JkLp9S8Yf6OFOnqmtYCRT1nUa1?=
 =?us-ascii?Q?8aPuo0mwporqSbV+A4cIFctcSifH00C0H0htezeCLwC2gnp29BVD2OoarSRM?=
 =?us-ascii?Q?hxWu8lQUqxloVdb+u0BSFYsB8aM6QdU7JVEKtQmQ0GkakXVsXBzRBXa9v2GS?=
 =?us-ascii?Q?Ue7WL8BBC3pM7Onsm+4nwoOlowTfK7j4GHw7mLyh0d2doco3DIlsn5bBAO9M?=
 =?us-ascii?Q?n0NG4iSj8rIv1kDqUvpHP9gWJ/Vz6r3dWiWob8aF+l+eygCEdmt2O/wJkad4?=
 =?us-ascii?Q?23N7oqb5gWrOkjQFqn9mLxVaG+/MKT5ZdCJ5eh1loxRGWrg67Syv9UapEUl7?=
 =?us-ascii?Q?vfM09cFNhYyrQexfC5371bEfLh7c2zfteGR3yvmZgSPsbQc5sHsTm8Jw7IfG?=
 =?us-ascii?Q?hw=3D=3D?=
X-OriginatorOrg: seco.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 71c39cd6-55db-4faf-3db3-08da902384da
X-MS-Exchange-CrossTenant-AuthSource: DB7PR03MB4972.eurprd03.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 06 Sep 2022 16:19:05.4746
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: bebe97c3-6438-442e-ade3-ff17aa50e733
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: TkEX/vPeBhYiW55bWTITPTORYSacvbucGAPJWkkgl19sSHMq4oamIfJbvd5UNAtifqplkuYfV0nrND8D5/7vGg==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: VI1PR0301MB2254
X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_NONE,
        RCVD_IN_MSPIKE_H2,SPF_HELO_NONE,SPF_PASS,T_SCC_BODY_TEXT_LINE
        autolearn=ham autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

This documents the possible MLO_PAUSE_* settings which can result from
different combinations of MLO_(A)SYM_PAUSE. These are more-or-less a
direct consequence of IEEE 802.3 Table 28B-2.

Signed-off-by: Sean Anderson <sean.anderson@seco.com>
---

(no changes since v3)

Changes in v3:
- New

 include/linux/phylink.h | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/include/linux/phylink.h b/include/linux/phylink.h
index 6d06896fc20d..a431a0b0d217 100644
--- a/include/linux/phylink.h
+++ b/include/linux/phylink.h
@@ -21,6 +21,22 @@ enum {
 	MLO_AN_FIXED,	/* Fixed-link mode */
 	MLO_AN_INBAND,	/* In-band protocol */
 
+	/* MAC_SYM_PAUSE and MAC_ASYM_PAUSE correspond to the PAUSE and
+	 * ASM_DIR bits used in autonegotiation, respectively. See IEEE 802.3
+	 * Annex 28B for more information.
+	 *
+	 * The following table lists the values of MLO_PAUSE_* (aside from
+	 * MLO_PAUSE_AN) which might be requested depending on the results of
+	 * autonegotiation or user configuration:
+	 *
+	 * MAC_SYM_PAUSE MAC_ASYM_PAUSE Valid pause modes
+	 * ============= ============== ==============================
+	 *             0              0 MLO_PAUSE_NONE
+	 *             0              1 MLO_PAUSE_NONE, MLO_PAUSE_TX
+	 *             1              0 MLO_PAUSE_NONE, MLO_PAUSE_TXRX
+	 *             1              1 MLO_PAUSE_NONE, MLO_PAUSE_TXRX,
+	 *                              MLO_PAUSE_RX
+	 */
 	MAC_SYM_PAUSE	= BIT(0),
 	MAC_ASYM_PAUSE	= BIT(1),
 	MAC_10HD	= BIT(2),
-- 
2.35.1.1320.gc452695387.dirty