diff mbox series

[net-next] Documentation: networking: Add missing PHY_GET command in the message list

Message ID 20241023141559.100973-1-kory.maincent@bootlin.com (mailing list archive)
State Superseded
Delegated to: Netdev Maintainers
Headers show
Series [net-next] Documentation: networking: Add missing PHY_GET command in the message list | expand

Checks

Context Check Description
netdev/series_format success Single patches do not need cover letters
netdev/tree_selection success Clearly marked for net-next
netdev/ynl success Generated files up to date; no warnings/errors; no diff in generated;
netdev/fixes_present success Fixes tag not required for -next series
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 5 this patch: 5
netdev/build_tools success No tools touched, skip
netdev/cc_maintainers success CCed 6 of 6 maintainers
netdev/build_clang success Errors and warnings before: 3 this patch: 3
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/deprecated_api success None detected
netdev/check_selftest success No net selftest shell script
netdev/verify_fixes success No Fixes tag
netdev/build_allmodconfig_warn success Errors and warnings before: 3 this patch: 3
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 15 lines checked
netdev/build_clang_rust success No Rust files in patch. Skipping build
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0
netdev/contest success net-next-2024-10-24--12-00 (tests: 777)

Commit Message

Kory Maincent Oct. 23, 2024, 2:15 p.m. UTC
ETHTOOL_MSG_PHY_GET/GET_REPLY/NTF is missing in the ethtool message list.
Add it to the ethool netlink documentation.

Signed-off-by: Kory Maincent <kory.maincent@bootlin.com>
---
 Documentation/networking/ethtool-netlink.rst | 3 +++
 1 file changed, 3 insertions(+)

Comments

Simon Horman Oct. 24, 2024, 2:52 p.m. UTC | #1
On Wed, Oct 23, 2024 at 04:15:58PM +0200, Kory Maincent wrote:
> ETHTOOL_MSG_PHY_GET/GET_REPLY/NTF is missing in the ethtool message list.
> Add it to the ethool netlink documentation.
> 
> Signed-off-by: Kory Maincent <kory.maincent@bootlin.com>
> ---
>  Documentation/networking/ethtool-netlink.rst | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/Documentation/networking/ethtool-netlink.rst b/Documentation/networking/ethtool-netlink.rst
> index 295563e91082..70ecc3821007 100644
> --- a/Documentation/networking/ethtool-netlink.rst
> +++ b/Documentation/networking/ethtool-netlink.rst
> @@ -236,6 +236,7 @@ Userspace to kernel:
>    ``ETHTOOL_MSG_MM_GET``                get MAC merge layer state
>    ``ETHTOOL_MSG_MM_SET``                set MAC merge layer parameters
>    ``ETHTOOL_MSG_MODULE_FW_FLASH_ACT``   flash transceiver module firmware
> +  ``ETHTOOL_MSG_PHY_GET``               get Ethernet PHY information
>    ===================================== =================================
>  
>  Kernel to userspace:
> @@ -283,6 +284,8 @@ Kernel to userspace:
>    ``ETHTOOL_MSG_PLCA_NTF``                 PLCA RS parameters
>    ``ETHTOOL_MSG_MM_GET_REPLY``             MAC merge layer status
>    ``ETHTOOL_MSG_MODULE_FW_FLASH_NTF``      transceiver module flash updates
> +  ``ETHTOOL_MSG_PHY_GET_REPLY``            Ethernet PHY information
> +  ``ETHTOOL_MSG_PHY_NTF``                  Ethernet PHY information

I wonder if ETHTOOL_MSG_PHY_NTF should be removed.
It doesn't seem to be used anywhere.

>    ======================================== =================================
>  
>  ``GET`` requests are sent by userspace applications to retrieve device
> -- 
> 2.34.1
> 
>
Kory Maincent Oct. 24, 2024, 3:18 p.m. UTC | #2
On Thu, 24 Oct 2024 15:52:23 +0100
Simon Horman <horms@kernel.org> wrote:

> On Wed, Oct 23, 2024 at 04:15:58PM +0200, Kory Maincent wrote:
> > ETHTOOL_MSG_PHY_GET/GET_REPLY/NTF is missing in the ethtool message list.
> > Add it to the ethool netlink documentation.
> > 
> > Signed-off-by: Kory Maincent <kory.maincent@bootlin.com>
> > ---
> >  Documentation/networking/ethtool-netlink.rst | 3 +++
> >  1 file changed, 3 insertions(+)
> > 
> > diff --git a/Documentation/networking/ethtool-netlink.rst
> > b/Documentation/networking/ethtool-netlink.rst index
> > 295563e91082..70ecc3821007 100644 ---
> > a/Documentation/networking/ethtool-netlink.rst +++
> > b/Documentation/networking/ethtool-netlink.rst @@ -236,6 +236,7 @@
> > Userspace to kernel: ``ETHTOOL_MSG_MM_GET``                get MAC merge
> > layer state ``ETHTOOL_MSG_MM_SET``                set MAC merge layer
> > parameters ``ETHTOOL_MSG_MODULE_FW_FLASH_ACT``   flash transceiver module
> > firmware
> > +  ``ETHTOOL_MSG_PHY_GET``               get Ethernet PHY information
> >    ===================================== =================================
> >  
> >  Kernel to userspace:
> > @@ -283,6 +284,8 @@ Kernel to userspace:
> >    ``ETHTOOL_MSG_PLCA_NTF``                 PLCA RS parameters
> >    ``ETHTOOL_MSG_MM_GET_REPLY``             MAC merge layer status
> >    ``ETHTOOL_MSG_MODULE_FW_FLASH_NTF``      transceiver module flash updates
> > +  ``ETHTOOL_MSG_PHY_GET_REPLY``            Ethernet PHY information
> > +  ``ETHTOOL_MSG_PHY_NTF``                  Ethernet PHY information  
> 
> I wonder if ETHTOOL_MSG_PHY_NTF should be removed.
> It doesn't seem to be used anywhere.

We can't, as it is in the ethtool UAPI. Also I believe Maxime will use it on
later patch series. Maxime, you confirm?

Regards,
Simon Horman Oct. 24, 2024, 3:28 p.m. UTC | #3
On Thu, Oct 24, 2024 at 05:18:02PM +0200, Kory Maincent wrote:
> On Thu, 24 Oct 2024 15:52:23 +0100
> Simon Horman <horms@kernel.org> wrote:
> 
> > On Wed, Oct 23, 2024 at 04:15:58PM +0200, Kory Maincent wrote:
> > > ETHTOOL_MSG_PHY_GET/GET_REPLY/NTF is missing in the ethtool message list.
> > > Add it to the ethool netlink documentation.
> > > 
> > > Signed-off-by: Kory Maincent <kory.maincent@bootlin.com>
> > > ---
> > >  Documentation/networking/ethtool-netlink.rst | 3 +++
> > >  1 file changed, 3 insertions(+)
> > > 
> > > diff --git a/Documentation/networking/ethtool-netlink.rst
> > > b/Documentation/networking/ethtool-netlink.rst index
> > > 295563e91082..70ecc3821007 100644 ---
> > > a/Documentation/networking/ethtool-netlink.rst +++
> > > b/Documentation/networking/ethtool-netlink.rst @@ -236,6 +236,7 @@
> > > Userspace to kernel: ``ETHTOOL_MSG_MM_GET``                get MAC merge
> > > layer state ``ETHTOOL_MSG_MM_SET``                set MAC merge layer
> > > parameters ``ETHTOOL_MSG_MODULE_FW_FLASH_ACT``   flash transceiver module
> > > firmware
> > > +  ``ETHTOOL_MSG_PHY_GET``               get Ethernet PHY information
> > >    ===================================== =================================
> > >  
> > >  Kernel to userspace:
> > > @@ -283,6 +284,8 @@ Kernel to userspace:
> > >    ``ETHTOOL_MSG_PLCA_NTF``                 PLCA RS parameters
> > >    ``ETHTOOL_MSG_MM_GET_REPLY``             MAC merge layer status
> > >    ``ETHTOOL_MSG_MODULE_FW_FLASH_NTF``      transceiver module flash updates
> > > +  ``ETHTOOL_MSG_PHY_GET_REPLY``            Ethernet PHY information
> > > +  ``ETHTOOL_MSG_PHY_NTF``                  Ethernet PHY information  
> > 
> > I wonder if ETHTOOL_MSG_PHY_NTF should be removed.
> > It doesn't seem to be used anywhere.
> 
> We can't, as it is in the ethtool UAPI. Also I believe Maxime will use it on
> later patch series. Maxime, you confirm?

Ok, if it's in the UAPI then I suppose it needs to stay.

But could we differentiate in the documentation between
ETHTOOL_MSG_PHY_GET_REPLY and ETHTOOL_MSG_PHY_NTF?
Maxime Chevallier Oct. 24, 2024, 4:11 p.m. UTC | #4
Hi Simon,

On Thu, 24 Oct 2024 16:28:16 +0100
Simon Horman <horms@kernel.org> wrote:

> On Thu, Oct 24, 2024 at 05:18:02PM +0200, Kory Maincent wrote:
> > On Thu, 24 Oct 2024 15:52:23 +0100
> > Simon Horman <horms@kernel.org> wrote:
> >   
> > > On Wed, Oct 23, 2024 at 04:15:58PM +0200, Kory Maincent wrote:  
> > > > ETHTOOL_MSG_PHY_GET/GET_REPLY/NTF is missing in the ethtool message list.
> > > > Add it to the ethool netlink documentation.
> > > > 
> > > > Signed-off-by: Kory Maincent <kory.maincent@bootlin.com>
> > > > ---
> > > >  Documentation/networking/ethtool-netlink.rst | 3 +++
> > > >  1 file changed, 3 insertions(+)
> > > > 
> > > > diff --git a/Documentation/networking/ethtool-netlink.rst
> > > > b/Documentation/networking/ethtool-netlink.rst index
> > > > 295563e91082..70ecc3821007 100644 ---
> > > > a/Documentation/networking/ethtool-netlink.rst +++
> > > > b/Documentation/networking/ethtool-netlink.rst @@ -236,6 +236,7 @@
> > > > Userspace to kernel: ``ETHTOOL_MSG_MM_GET``                get MAC merge
> > > > layer state ``ETHTOOL_MSG_MM_SET``                set MAC merge layer
> > > > parameters ``ETHTOOL_MSG_MODULE_FW_FLASH_ACT``   flash transceiver module
> > > > firmware
> > > > +  ``ETHTOOL_MSG_PHY_GET``               get Ethernet PHY information
> > > >    ===================================== =================================
> > > >  
> > > >  Kernel to userspace:
> > > > @@ -283,6 +284,8 @@ Kernel to userspace:
> > > >    ``ETHTOOL_MSG_PLCA_NTF``                 PLCA RS parameters
> > > >    ``ETHTOOL_MSG_MM_GET_REPLY``             MAC merge layer status
> > > >    ``ETHTOOL_MSG_MODULE_FW_FLASH_NTF``      transceiver module flash updates
> > > > +  ``ETHTOOL_MSG_PHY_GET_REPLY``            Ethernet PHY information
> > > > +  ``ETHTOOL_MSG_PHY_NTF``                  Ethernet PHY information    
> > > 
> > > I wonder if ETHTOOL_MSG_PHY_NTF should be removed.
> > > It doesn't seem to be used anywhere.  
> > 
> > We can't, as it is in the ethtool UAPI. Also I believe Maxime will use it on
> > later patch series. Maxime, you confirm?  
> 
> Ok, if it's in the UAPI then I suppose it needs to stay.
> 
> But could we differentiate in the documentation between
> ETHTOOL_MSG_PHY_GET_REPLY and ETHTOOL_MSG_PHY_NTF?

Yeah it was a leftover from when I implemented that, however I do plan
on adding this notification though, so if it's OK for it to stay that's
perfect as it'll get used.

Then for the documentation, we can specify "Ethernet PHY information
change notification". This would trigger when the PHYs are appearing on
the topology.

Thanks,

Maxime
diff mbox series

Patch

diff --git a/Documentation/networking/ethtool-netlink.rst b/Documentation/networking/ethtool-netlink.rst
index 295563e91082..70ecc3821007 100644
--- a/Documentation/networking/ethtool-netlink.rst
+++ b/Documentation/networking/ethtool-netlink.rst
@@ -236,6 +236,7 @@  Userspace to kernel:
   ``ETHTOOL_MSG_MM_GET``                get MAC merge layer state
   ``ETHTOOL_MSG_MM_SET``                set MAC merge layer parameters
   ``ETHTOOL_MSG_MODULE_FW_FLASH_ACT``   flash transceiver module firmware
+  ``ETHTOOL_MSG_PHY_GET``               get Ethernet PHY information
   ===================================== =================================
 
 Kernel to userspace:
@@ -283,6 +284,8 @@  Kernel to userspace:
   ``ETHTOOL_MSG_PLCA_NTF``                 PLCA RS parameters
   ``ETHTOOL_MSG_MM_GET_REPLY``             MAC merge layer status
   ``ETHTOOL_MSG_MODULE_FW_FLASH_NTF``      transceiver module flash updates
+  ``ETHTOOL_MSG_PHY_GET_REPLY``            Ethernet PHY information
+  ``ETHTOOL_MSG_PHY_NTF``                  Ethernet PHY information
   ======================================== =================================
 
 ``GET`` requests are sent by userspace applications to retrieve device