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:     "David S . Miller" <davem@davemloft.net>,
        Paolo Abeni <pabeni@redhat.com>,
        Vladimir Oltean <olteanv@gmail.com>,
        linux-kernel@vger.kernel.org, Eric Dumazet <edumazet@google.com>,
        Jakub Kicinski <kuba@kernel.org>,
        Alexandru Marginean <alexandru.marginean@nxp.com>,
        Sean Anderson <sean.anderson@seco.com>
Subject: [PATCH net-next v4 02/10] net: phylink: Document MAC_(A)SYM_PAUSE
Date:   Thu, 18 Aug 2022 12:46:08 -0400
Message-Id: <20220818164616.2064242-3-sean.anderson@seco.com>
In-Reply-To: <20220818164616.2064242-1-sean.anderson@seco.com>
References: <20220818164616.2064242-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?DhXoJUBlT3eXA2SZqPEHvZHMzz82Fqx45MHaf6Nz9o8xMdlJpFNJOQohRRCI?=
 =?us-ascii?Q?yzyVcXrbbpJt5LoS3+bLYb7FwyNWZay25wJOqkzVKZDUXHUQc10rYvz99j6T?=
 =?us-ascii?Q?Ox/qhx/sk/XpBJBVRwE/HAPYaVv5rs6XGIIUuSndBEZVDzGDMdBIwmFmrf9h?=
 =?us-ascii?Q?IhCWYVsEB91FGYd0yoZtxkmXVE1Trti51BmHZdqvbhVsgJD1MDh1MLcV/6Dv?=
 =?us-ascii?Q?ho3J8S0LLL9vZH43PYh02YUn76kvuEZmcWkKCbu+4OFWciLFQRJ3PLdB6u5+?=
 =?us-ascii?Q?AljFleCtqDMtUS21TupalEZvQuRzoEjyaC3ZnQXAzWNwTBEzUK4EdbPUz5UT?=
 =?us-ascii?Q?iQpxnUS5K8xIv/bdRoPmMFqURHxVHBJqFJuHEnxaILnDcrGEOAR7kWdJd4w/?=
 =?us-ascii?Q?sg2Za57csSzYomfiFAjlMQLPUfkZYKTzrHTYLUDXGs93AJaIeJob51L6yox4?=
 =?us-ascii?Q?EA+JKBFheHJm2JDnHQV6NDTvKrOBOJwwXE/IBp3ou2jX+mspG1PQOft/HV8J?=
 =?us-ascii?Q?VBOM3djN/GozOTakj+1epLKXyX/DlA4DZImjcdKecqzgHe6zkt6msiVgMtIh?=
 =?us-ascii?Q?J/Esq3KO1mD9Z7RBGetkuWRQKbE1VXno4id4DjqWgGmiZoVmgx59tCs0XDZ2?=
 =?us-ascii?Q?V/KkIWE0nkYCLEQcuLQZQLXytr0jPJ7BcTPfd68v/TBk77hIISAuQxRHcUfh?=
 =?us-ascii?Q?CalJxHBB1cnvOoFZLM1ReCCeGrtR5yOTFOQepgjembjdvtYDuQnRg1e66eS/?=
 =?us-ascii?Q?pSsbSchKH1MJDogePSWYJpbK9KDOa5u1rhhilCcHhZ1n2VcAJSvPD5FPe+qL?=
 =?us-ascii?Q?EupMfJ5BD9OJScgyBMcnfysBIekrpG5AoWWHIiOoi/xN9kDbmj5ig0Bcd0bO?=
 =?us-ascii?Q?xTfXcFbI9AZqZz0B9oJbxqjUeb4lmIu0Ooo4H3ywQs2BLh5h4fEtRbJWTnVt?=
 =?us-ascii?Q?7SjPzIjSgKPB9RQN9cEaE6VXPeL5wkMPFUzFIK5/aOAC0OxdhekoqWSQwbi6?=
 =?us-ascii?Q?TbmJuEqINCVcq/TUPTpGdwFBwXZ4RvnbmSijiDuPwOOwYDyEMqBhWZU6s40X?=
 =?us-ascii?Q?7bDTo2n+c5Ug3j5DiorSLAjLYIrjnk6qHu1v6pwg7QDrmKoFJiCqrdpFg4dT?=
 =?us-ascii?Q?20ef7twARGPow3y4Zh7R5VN3Sc7fG2zlfi04Cv+7hLHTvSnIRjY37UeQI0LD?=
 =?us-ascii?Q?GkksBWEzOnt/2dBMTz2vsMApWvyBMbM3gQB7FhbsjR/erhGjKQBr3cBBobAK?=
 =?us-ascii?Q?zl6ey2vq2FsnRy4XfkFHwlDVAMrG82SS/nP67vRO9plDt0+2XpPhDMELUlPO?=
 =?us-ascii?Q?KMTgRwUTk/gNnUlSLSFUk6SfTp7awO6HMsbmYbZirHe5NUzuDE9n7mIFlWf4?=
 =?us-ascii?Q?4Ii+kxpsFssOcKjV5lLpkBIDk+JLo7jv6do4NvDpohaxj+ZQ7Tby7UubYiXf?=
 =?us-ascii?Q?IKywzGvLY7pG4vH2yd3j+HbwPzorwUXyq6Ta+0f9gS4VZGK7eODGIc15sQuW?=
 =?us-ascii?Q?kSIfQAXJcq1YpdNr+BYEspmGsYgzU028myftCmYFdpOVaSzHtJKIbQNpsLYC?=
 =?us-ascii?Q?Cd8sxg52d3LwbfQSzDaHvQHuO+PDWGvLJ8eFlDBPtcDYkqQMduFpabxGNrhz?=
 =?us-ascii?Q?/g=3D=3D?=
X-OriginatorOrg: seco.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 9c03eb5d-2112-47b9-fe64-08da8139332a
X-MS-Exchange-CrossTenant-AuthSource: DB7PR03MB4972.eurprd03.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 18 Aug 2022 16:46:29.9014
 (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: fVVvo/v7KyrNj8y85NB3s04fiNdXf39rYhCP9Ji1gEfJq0Rb3IuMEvAZWkNxTmCkjNqlOyGwXfJnVfmPyMm4yQ==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: PAXPR03MB7649
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_PASS,SPF_PASS,T_SCC_BODY_TEXT_LINE,
        URIBL_BLOCKED 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 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..9629bcd594b1 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 IEEE802.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