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

Kory Maincent posted 1 patch 1 month ago
There is a newer version of this series
Documentation/networking/ethtool-netlink.rst | 3 +++
1 file changed, 3 insertions(+)
[PATCH net-next] Documentation: networking: Add missing PHY_GET command in the message list
Posted by Kory Maincent 1 month ago
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
   ======================================== =================================
 
 ``GET`` requests are sent by userspace applications to retrieve device
-- 
2.34.1
Re: [PATCH net-next] Documentation: networking: Add missing PHY_GET command in the message list
Posted by Simon Horman 1 month ago
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
> 
>
Re: [PATCH net-next] Documentation: networking: Add missing PHY_GET command in the message list
Posted by Kory Maincent 1 month ago
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,
-- 
Köry Maincent, Bootlin
Embedded Linux and kernel engineering
https://bootlin.com
Re: [PATCH net-next] Documentation: networking: Add missing PHY_GET command in the message list
Posted by Simon Horman 1 month ago
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?
Re: [PATCH net-next] Documentation: networking: Add missing PHY_GET command in the message list
Posted by Maxime Chevallier 1 month ago
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