| Message ID | 20240409232520.237613-2-rrameshbabu@nvidia.com (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 65f35aa76c0e21b0243fd734e513fd2263f22a18 |
| Delegated to: | Netdev Maintainers |
| Headers | show |
| Series | [net-next,v1] ethtool: update tsinfo statistics attribute docs with correct type | expand |
Hello: This patch was applied to netdev/net-next.git (main) by Jakub Kicinski <kuba@kernel.org>: On Tue, 9 Apr 2024 16:25:16 -0700 you wrote: > nla_put_uint can either write a u32 or u64 netlink attribute value. The > size depends on whether the value can be represented with a u32 or requires > a u64. Use a uint annotation in various documentation to represent this. > > Signed-off-by: Rahul Rameshbabu <rrameshbabu@nvidia.com> > --- > > [...] Here is the summary with links: - [net-next,v1] ethtool: update tsinfo statistics attribute docs with correct type https://git.kernel.org/netdev/net-next/c/65f35aa76c0e You are awesome, thank you!
diff --git a/Documentation/networking/ethtool-netlink.rst b/Documentation/networking/ethtool-netlink.rst index 5dc42f7ce429..4e63d3708ed9 100644 --- a/Documentation/networking/ethtool-netlink.rst +++ b/Documentation/networking/ethtool-netlink.rst @@ -1254,9 +1254,9 @@ would be empty (no bit set). Additional hardware timestamping statistics response contents: ===================================== ====== =================================== - ``ETHTOOL_A_TS_STAT_TX_PKTS`` u64 Packets with Tx HW timestamps - ``ETHTOOL_A_TS_STAT_TX_LOST`` u64 Tx HW timestamp not arrived count - ``ETHTOOL_A_TS_STAT_TX_ERR`` u64 HW error request Tx timestamp count + ``ETHTOOL_A_TS_STAT_TX_PKTS`` uint Packets with Tx HW timestamps + ``ETHTOOL_A_TS_STAT_TX_LOST`` uint Tx HW timestamp not arrived count + ``ETHTOOL_A_TS_STAT_TX_ERR`` uint HW error request Tx timestamp count ===================================== ====== =================================== CABLE_TEST diff --git a/include/uapi/linux/ethtool_netlink.h b/include/uapi/linux/ethtool_netlink.h index 23e225f00fb0..b4f0d233d048 100644 --- a/include/uapi/linux/ethtool_netlink.h +++ b/include/uapi/linux/ethtool_netlink.h @@ -488,9 +488,9 @@ enum { enum { ETHTOOL_A_TS_STAT_UNSPEC, - ETHTOOL_A_TS_STAT_TX_PKTS, /* u64 */ - ETHTOOL_A_TS_STAT_TX_LOST, /* u64 */ - ETHTOOL_A_TS_STAT_TX_ERR, /* u64 */ + ETHTOOL_A_TS_STAT_TX_PKTS, /* uint */ + ETHTOOL_A_TS_STAT_TX_LOST, /* uint */ + ETHTOOL_A_TS_STAT_TX_ERR, /* uint */ /* add new constants above here */ __ETHTOOL_A_TS_STAT_CNT,
nla_put_uint can either write a u32 or u64 netlink attribute value. The size depends on whether the value can be represented with a u32 or requires a u64. Use a uint annotation in various documentation to represent this. Signed-off-by: Rahul Rameshbabu <rrameshbabu@nvidia.com> --- Notes: Reasoning: I discovered this inaccuracy while working on ethtool patches for implementing support for the statistics. Used the rst initially to base the types and then realized we went with uint when I noticed incorrect netlink message parsing due to using the incorrect size per attribute. Documentation/networking/ethtool-netlink.rst | 6 +++--- include/uapi/linux/ethtool_netlink.h | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-)