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 v4 net-next 05/12] docs: ethtool: document ETHTOOL_A_STATS_SRC and ETHTOOL_A_PAUSE_STATS_SRC
Date:   Thu, 19 Jan 2023 14:26:57 +0200
Message-Id: <20230119122705.73054-6-vladimir.oltean@nxp.com>
In-Reply-To: <20230119122705.73054-1-vladimir.oltean@nxp.com>
References: <20230119122705.73054-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?QcB/IxpckiZ9hUavNYQ9yJuOEWHRSeb+rsY+wim3+W44AqxdQrb72hDx9+sF?=
 =?us-ascii?Q?uapIweudQemnE9MJPVT44Usa936xxBwHO/kPeYnYp/1GoPSpmgPtlPdICciS?=
 =?us-ascii?Q?y9bIlCOLjN2oZ2ifv9DYN3Xz3+DbClpZpyMHE9qFxEiSsTzOTy+0BAX5+fWN?=
 =?us-ascii?Q?buykXD9/DWEj+T8qAED7kWgBBb/EJGtdwYfb6tEt6dAsz+RO1nU2m1azCGXs?=
 =?us-ascii?Q?0csy/uji1IEnFICpVoDLEHDPslkPX+SDngqfiZXonI/NlvpsdzblMGksCzrl?=
 =?us-ascii?Q?bIAFTv9vIejH5oWApSVnJV0cZi2O+2gbNyY2RuMpg7Vo3b2nZR2Q524xDEk4?=
 =?us-ascii?Q?RvJoi+3cNQLuPo/VLRs6wUpfEIXw/GOjHrzaYYGpPlsusblqCEmlOdKmhHst?=
 =?us-ascii?Q?IKSRe22lL8HFoxIUP9Dh6/E3MUZVmevB7VniOwo1PoV5nRvX3r8jqxz6gOeu?=
 =?us-ascii?Q?uOU8/oBAbG7v3NdqUiJxOK1hyPUzjMKMeKYBN3zYVQWUnreA7g47pWbwdm/6?=
 =?us-ascii?Q?xvrQ83AOl2F4zXIAz5zTcaiy5HMHpzyzCX9zD6OW1rZ8ELfp3JOS/+HS5KAz?=
 =?us-ascii?Q?MhxunHzITJSRS7il8v+3gkiGxNZBWWyI1PJWg6MDiH6PxYBRB/TNm4ORZwnC?=
 =?us-ascii?Q?0G2JPTxrXlb5qYCgLurgNP54duyluuO1CX67CVDe01FwJ7GRlqwLBZTf5vnZ?=
 =?us-ascii?Q?2WZX89Wm9JTY9TaagrVFaNi0Fsf/V+VfSyyD2IztcW349ysoWOEp4WEfu4h9?=
 =?us-ascii?Q?jgzmXPfT6ygmA8O+XWF4nxVsPFbcx5rAD5dPFzRSuNVM2mKVa3D6Ri9FUenj?=
 =?us-ascii?Q?8eTdevRJnpiSQiMMBZLNVWtGFXiMq1TUUlL3zviCavHxi8LZp1Cbd7P1PM/w?=
 =?us-ascii?Q?7wleImmGMU9T7sLVo+PmXFpq+qmD6NnVC+t2Uw4vGBeNSYljaEvAhpUZs5Mm?=
 =?us-ascii?Q?ZNasvsS9nhNZZr45t8wSD7pMkyQy2Tq05MVaxiKXy813EuBUxnz9wlSLolQd?=
 =?us-ascii?Q?Zkkzkx3Ktpzzx7llzIgWa+IN59Hh3B41aaqw1aqrwlax6zeUOdw83zunkW2z?=
 =?us-ascii?Q?yzdZ5ghGeQph8ngcdHrpx42U1j84fAPPCcQqozxeSUBR5w6BTWfqtZPVyfMH?=
 =?us-ascii?Q?iOjwnVUdaPzhhadpjElmTYRnlK4wM8+EH/+HOdmqo1xir0kU/u8pBBCwAblB?=
 =?us-ascii?Q?nrnuxFTW1xCH4X3UstKgo82gMXHHWi3ZFg8jeHesp+L/jkzSRGxYRFgmAH/k?=
 =?us-ascii?Q?UMhgT+HlIuqlz7ydyOogjiDYLFl4l+jRWwW9/KAmjBgxUqtZAudpbVIusOFJ?=
 =?us-ascii?Q?wAAVZRxrEnJjaTdSEozmdMYwE0SzX9iiNKL3SUQvnyfS7yiSogK72FgJztEo?=
 =?us-ascii?Q?iOkiyMYV9rhlawaqV185cdoMh6qyx9BOcXXg+PPaljCCYmvFgJrp4ynR1lo+?=
 =?us-ascii?Q?xyqLOzvUiBJuFUR4+HCwNYs6ld9Lm4cfsaJ9hKS5ce9E1DKNFit+LeOMeAL/?=
 =?us-ascii?Q?qCkuuFOR+xR9BKxmdPqULFb4RD6iB1VOtaSZLacN8WI3ir8xjwU0ySowjlg0?=
 =?us-ascii?Q?L9ZTj+KvXrtTPunZWBuHf9MjSOnPKq3Ro9mkHp4SJ8GO8c03LzzL0//+IoZ2?=
 =?us-ascii?Q?cQ=3D=3D?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 47cc8fe3-4b82-40c2-329d-08dafa18938c
X-MS-Exchange-CrossTenant-AuthSource: VI1PR04MB5136.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 19 Jan 2023 12:27:49.0912
 (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: mODGoi8VR6w4PUokAAQ0sH8YDgnB2HIoh8UXdClIGqhptY6SAXiGJ2EGg/ZlVrjN/CUyqRSD0Abqv18m82XWXw==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: PAXPR04MB8206
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>
---
v3->v4: none
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