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:   Vladimir Oltean <vladimir.oltean@nxp.com>
To:     netdev@vger.kernel.org
Cc:     linux-kernel@vger.kernel.org,
        "David S. Miller" <davem@davemloft.net>,
        Eric Dumazet <edumazet@google.com>,
        Jakub Kicinski <kuba@kernel.org>,
        Paolo Abeni <pabeni@redhat.com>,
        Michal Kubecek <mkubecek@suse.cz>,
        Claudiu Manoil <claudiu.manoil@nxp.com>,
        Vinicius Costa Gomes <vinicius.gomes@intel.com>,
        Xiaoliang Yang <xiaoliang.yang_1@nxp.com>,
        Kurt Kanzenbach <kurt@linutronix.de>,
        Rui Sousa <rui.sousa@nxp.com>,
        Ferenc Fejes <ferenc.fejes@ericsson.com>,
        Pranavi Somisetty <pranavi.somisetty@amd.com>,
        Harini Katakam <harini.katakam@amd.com>,
        Colin Foster <colin.foster@in-advantage.com>,
        UNGLinuxDriver@microchip.com,
        Alexandre Belloni <alexandre.belloni@bootlin.com>,
        Andrew Lunn <andrew@lunn.ch>,
        Florian Fainelli <f.fainelli@gmail.com>
Subject: [PATCH v3 net-next 05/12] docs: ethtool: document ETHTOOL_A_STATS_SRC and ETHTOOL_A_PAUSE_STATS_SRC
Date:   Tue, 17 Jan 2023 10:59:40 +0200
Message-Id: <20230117085947.2176464-6-vladimir.oltean@nxp.com>
In-Reply-To: <20230117085947.2176464-1-vladimir.oltean@nxp.com>
References: <20230117085947.2176464-1-vladimir.oltean@nxp.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?FF/ot5cTjQV5DwBfxP8Tl0hQWZh6jh9A5VEx+aMy98biQ9I1uF4AfylzA+Kx?=
 =?us-ascii?Q?M3AfhMhMa1rTrWShQqvTrc6YJYxn5u8zNoqlBhn6qC6EvDExM1N+ts3Oxx0M?=
 =?us-ascii?Q?aloGVUjn2lG60xYTvZ36dlxfvhLEOwtqc2GwZ3YUC6VMmh9C6gsv78uGLmoL?=
 =?us-ascii?Q?QUbZf5FajcJlFLTwPxvIPAJ12EmL2bhH66D4YPGLgVaBeIRfmllK9CxChPS5?=
 =?us-ascii?Q?4eYGjsga9zIA1dNh+iSASwtJXXuBOrKu8nptk+so18xQtOuEi6NstfcMuG1a?=
 =?us-ascii?Q?5BFP9wUmV+ngNR3UXQtkR/DSLTFG1gwu/5i9tJzpFW3nJuaxV6AyzG+841vU?=
 =?us-ascii?Q?CHGTDDAicFIECUxx/IvFT1OrhexMaYVy3K6PtC+g3MGKp3c1n+doNzWpHfVO?=
 =?us-ascii?Q?uf+46sqwyXJBayYGnvrVZkculSz3nJHXYCPo9nP8oSnOQzBaFhGjLwj0jPcU?=
 =?us-ascii?Q?A+s1xG92sSNjq3v+ZtlhBRaQF9jrMS0iuAgrkzL4+0dcAKKHNBgm9CPPl3lx?=
 =?us-ascii?Q?jFtMpV7ucCEMk1gjt59J9ZKbdp1tsBP+2dGYUUe5g5aeo5Yw0uM9aax3pW0X?=
 =?us-ascii?Q?DSM8cW+ozp0N169a2EvA27KXFpgpL61T4QgnwKYxsf54qlQO0fJWTmOyycs6?=
 =?us-ascii?Q?R58L7Pmafj/EA47SD2PWgJy7JLw8r7zEprEpElEhszsU3hw68k/9GZvF1yJL?=
 =?us-ascii?Q?SiieoeJX3XB+r/9jMGZ7ALv2pxNXK32ybau3rV3WDxzqKmGfOvO+YGOP6/he?=
 =?us-ascii?Q?KFGhadL5WTBPeBMc0xNtc/VrFwlnkhy9nbM/UjjF/ULHcY/Pp7+SJMLbb+gW?=
 =?us-ascii?Q?KlBOhAB5zKWMYrkrLhhTvj2oXlbG06nHy3DxMMOL5iLE+coCUinB9atVb/10?=
 =?us-ascii?Q?QAwvi0COkw4sk9T//RKCTkXsIXNJ/X8CJJCQ5sulHu1SOYVmSPDMtQz9CLnU?=
 =?us-ascii?Q?efKkMJoyZCE4Rv2X0/mM4Ut49VQNhodgzsqOZIJiwhq+v6aL0EeAQv7fHT9V?=
 =?us-ascii?Q?5m9d7rFbdY1fdtXzTPVvdj3wyGOzd6E9vGJPl2096za99eH9vjdxWlPsCHfG?=
 =?us-ascii?Q?KBLYSJLa/uCHMmoDXf6llMrPjphCfebx+DWhbTsDfqyoB5YOwhm4X+5QRPdy?=
 =?us-ascii?Q?FxM3+2fVMJAe9NbyCi7Czz5olwn7AyyjI3qf5CFB8BKwPi5l/etLh3f7kCuu?=
 =?us-ascii?Q?Uzijoa4hF9caExdyyNrXFjzs1tg90ts8SWSfx6F+pd3pXbHSOWXCMuPLe65m?=
 =?us-ascii?Q?UH4wdjZMOBSq7C1Lj/hPLz9DHuomTpxokovNgx5wQuKuqHJnnexPsWw0pRTW?=
 =?us-ascii?Q?oXCugvxAc/cBn7IWAdpj1WAAjkdhZqdPOzZxTSgKWY4a8ZY2OUvBLuhXhZpD?=
 =?us-ascii?Q?BQA+Np2YVsSYRt9n1lY5XWBXCrTQi/azU7IyHga7k3Q8A4oj7ijszOXSLEPu?=
 =?us-ascii?Q?grXFcC8xSW5SyFKHg537IwkTsEABh6w0+9ej+X+ejAsYvp7eqzfTfICyE+jo?=
 =?us-ascii?Q?kH30glJNRAvOR45LOM+lixu8gWwpt+4y8iyZsX/UNT7qmgUnydyxn4c1K/mw?=
 =?us-ascii?Q?0uhy+ytJQXklmWVeSTpOE4w/GmyUVq3igVkQOm8y1/2E6L8/63ijxWbYQ0ER?=
 =?us-ascii?Q?kQ=3D=3D?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 95b3f9f8-df05-4a4a-598a-08daf8693ab3
X-MS-Exchange-CrossTenant-AuthSource: VI1PR04MB5136.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 17 Jan 2023 09:00:06.8777
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 686ea1d3-bc2b-4c6f-a92c-d99c5c301635
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: 2FS9NKXTenZIX4WxNL+WGI80oBSl9C4KMWiWk3U5ZTY2GWELfTHdbdbslY7MbZStIrVxB6aGkpVpQ6dl7XAhwA==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: GV1PR04MB9182
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

Two new netlink attributes were added to PAUSE_GET and STATS_GET and
their replies. Document them.

Signed-off-by: Vladimir Oltean <vladimir.oltean@nxp.com>
---
v2->v3:
- adapt to renaming of constants
- add a single kernel-doc reference to enum ethtool_mac_stats_src
  (second one gives warning apparently)
v1->v2: patch is new

 Documentation/networking/ethtool-netlink.rst | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/Documentation/networking/ethtool-netlink.rst b/Documentation/networking/ethtool-netlink.rst
index 31413535dce5..1626e863eec9 100644
--- a/Documentation/networking/ethtool-netlink.rst
+++ b/Documentation/networking/ethtool-netlink.rst
@@ -1092,8 +1092,18 @@ Request contents:
 
   =====================================  ======  ==========================
   ``ETHTOOL_A_PAUSE_HEADER``             nested  request header
+  ``ETHTOOL_A_PAUSE_STATS_SRC``          u32     source of statistics
   =====================================  ======  ==========================
 
+``ETHTOOL_A_PAUSE_STATS_SRC`` is optional. It takes values from:
+
+.. kernel-doc:: include/uapi/linux/ethtool.h
+    :identifiers: ethtool_mac_stats_src
+
+If absent from the request, stats will be provided with
+an ``ETHTOOL_A_PAUSE_STATS_SRC`` attribute in the response equal to
+``ETHTOOL_MAC_STATS_SRC_AGGREGATE``.
+
 Kernel response contents:
 
   =====================================  ======  ==========================
@@ -1508,6 +1518,7 @@ Request contents:
 
   =======================================  ======  ==========================
   ``ETHTOOL_A_STATS_HEADER``               nested  request header
+  ``ETHTOOL_A_STATS_SRC``                  u32     source of statistics
   ``ETHTOOL_A_STATS_GROUPS``               bitset  requested groups of stats
   =======================================  ======  ==========================
 
@@ -1516,6 +1527,8 @@ Kernel response contents:
  +-----------------------------------+--------+--------------------------------+
  | ``ETHTOOL_A_STATS_HEADER``        | nested | reply header                   |
  +-----------------------------------+--------+--------------------------------+
+ | ``ETHTOOL_A_STATS_SRC``           | u32    | source of statistics           |
+ +-----------------------------------+--------+--------------------------------+
  | ``ETHTOOL_A_STATS_GRP``           | nested | one or more group of stats     |
  +-+---------------------------------+--------+--------------------------------+
  | | ``ETHTOOL_A_STATS_GRP_ID``      | u32    | group ID - ``ETHTOOL_STATS_*`` |
@@ -1577,6 +1590,11 @@ Low and high bounds are inclusive, for example:
  etherStatsPkts512to1023Octets 512  1023
  ============================= ==== ====
 
+``ETHTOOL_A_STATS_SRC`` is optional. Similar to ``PAUSE_GET``, it takes values
+from ``enum ethtool_mac_stats_src``. If absent from the request, stats will be
+provided with an ``ETHTOOL_A_STATS_SRC`` attribute in the response equal to
+``ETHTOOL_MAC_STATS_SRC_AGGREGATE``.
+
 PHC_VCLOCKS_GET
 ===============
 
-- 
2.34.1