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:     Paolo Abeni <pabeni@redhat.com>,
        Eric Dumazet <edumazet@google.com>,
        Alexandru Marginean <alexandru.marginean@nxp.com>,
        Vladimir Oltean <olteanv@gmail.com>,
        "David S . Miller" <davem@davemloft.net>,
        Jakub Kicinski <kuba@kernel.org>, linux-kernel@vger.kernel.org,
        Sean Anderson <sean.anderson@seco.com>
Subject: [PATCH v3 03/11] net: phylink: Document MAC_(A)SYM_PAUSE
Date:   Mon, 25 Jul 2022 11:37:21 -0400
Message-Id: <20220725153730.2604096-4-sean.anderson@seco.com>
In-Reply-To: <20220725153730.2604096-1-sean.anderson@seco.com>
References: <20220725153730.2604096-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?doDhgC7YAykw1FMbPtTmvbrMiYpk1lyd/TcJDPuFyyDLfi8iX1L8AJHvc0u6?=
 =?us-ascii?Q?bfnS4J+UP3ry2arFR3nLtnN+CVRfZgQ7LSOOrX3QA3S1wOvnn4SIR5SG/wb/?=
 =?us-ascii?Q?SLg0m8xMwOSHnbHN49boE4LLXTrlz9HhLozqaY1s+TGYhrbqoztDJPJp5Bvz?=
 =?us-ascii?Q?8GpiXyIhtTVmIN10LfiDROCfgbs4144t0PMl8WVKj4nXATa8z09sdG9BL0/O?=
 =?us-ascii?Q?XmqfQzP5+GfvKPqwZKlyo6dQcGvTbAoO2AHDAE3vUERIBlo3QOqSyzcqUCRm?=
 =?us-ascii?Q?09tj1C79094ekUJBYh/wc9vTQxpGH5crbvOQ+/2VakzA7g/CC1v0hWck4CFH?=
 =?us-ascii?Q?mGNqZy2FHQgKF2QEHGs5InlDk5hNUIvV+UG56RdCsW8uuL/K6qP9CE28My8j?=
 =?us-ascii?Q?Zds7E2GKItJiNDY+r3QnqBVEdw10/42iKzyrk4ztdFCz0AZA4qns8O3q2sBX?=
 =?us-ascii?Q?Fkx9NMSNuEuEG4mkjwG3UCx9rEapTeghBpU68FNlZwwNoduQy8nghUGE89Ia?=
 =?us-ascii?Q?LSXpglBwgSaDncU9sXQDknAEgntshGus1zfd+DxMMNUYlMNAmGrvkAlu5UXc?=
 =?us-ascii?Q?yqu/3QVCZNcmtb5LnIGdig6wCjGOdUjVViBM/7RwI047fWZorGp4onuSBcIL?=
 =?us-ascii?Q?zqzmXuNEaPNonmCJ2pJi6AM6ZJtrsOLpFbOpKWuCkqXmkan0dagVtkYyMSaE?=
 =?us-ascii?Q?zSNBPTMrmVSt/puxsBp9hQjRIuqdrUtJ4PmBxYvaZ6sgSWgkkhx09RA0lYLu?=
 =?us-ascii?Q?8ekLtwtntGk2eS2YZRYOB1OlRlqoRBv4zNwZ77iNQ4OhmrT04R4hQpf2RugP?=
 =?us-ascii?Q?PzqELZ7n1tA4QYQ8KIXAcABVRaCyvZgoLpNVqNlwnfrGk9w2FzTItH70NR0P?=
 =?us-ascii?Q?MBS+6SGGr50h5n4eMU1M9Ub3UDkZvWoF0AdxEg/6E9cGxeuUFoRdappHPtyO?=
 =?us-ascii?Q?TlyVV449FY828r+ObjrBEYnl558d7wuEjuFwJRRYxQ/VhWsWYxDRauas/V93?=
 =?us-ascii?Q?0peMdDsu4RNrZQZmnnMK0g5hig2yG8spK0//J9rZm09GiwbZh9eTJk1lB6l1?=
 =?us-ascii?Q?za2NxJ90U8cm8L3gTu6UmmIYRh1dYW2RZbCmZEh2aPbVu9LE4Bmz+kiZzJD4?=
 =?us-ascii?Q?lCluEuFTKAqYL9QJaUzSPqEnPanXPlpd4N/BNlbve4Df0xoHpRIr/1LJv0Ua?=
 =?us-ascii?Q?CeWGl9+pozv0zyfbQ5JmiKKr4Yh2ttBaIYvfZ2eoikDlMt/WSEjK6eijFs9P?=
 =?us-ascii?Q?qpHWX2jafjQCz4IcNAwg2WSBpy/sJqmTfyjscpyOtQYx9TrFI7w6d/qvDFee?=
 =?us-ascii?Q?5h2MMY5RV/OQFZWXq3wgjyIE7wn6fHZ9gwGzVJQgehP1MC+eJD7KmI3doG4z?=
 =?us-ascii?Q?iIsyLlOcQ0MQnQvxzmww/5VceuVnvAk/kY/vw4UgLKqXM7jDx6wJHb7MDgwu?=
 =?us-ascii?Q?z3ETFpE6xb3aGrziL0seFUFERzNkNSMFUPjBQSxe4wEUc0Es19i91Ntezm0H?=
 =?us-ascii?Q?B18C5pGzGzIwIgkctfNTwOgifncquLvLyZjEkZMoQ9D6gOj23Rpz0MAgwOfR?=
 =?us-ascii?Q?7e93LVWo1pDhWtUJYLqUNHwhni+eOM6NXXmLJpQ1D5LmTc5t0O77ahG8VqF7?=
 =?us-ascii?Q?rg=3D=3D?=
X-OriginatorOrg: seco.com
X-MS-Exchange-CrossTenant-Network-Message-Id: fde730ab-4a0c-4458-8094-08da6e53a065
X-MS-Exchange-CrossTenant-AuthSource: DB7PR03MB4972.eurprd03.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 25 Jul 2022 15:37:47.9787
 (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: /+ma3rvrekcsD6SqYSxk7qIdA+QN95HoCDgijjIh1TLZaQog5FmV8HExl0yzFaxCocWYF19+sEaUQkbTW457mQ==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DB7PR03MB4394
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 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>
---

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