Re: [PATCH net-next 7/9] net: phy: icplus: select page before writing control register

[Heiner Kallweit <hkallweit1@gmail.com>]

On 10.02.2021 09:25, Michael Walle wrote:
> Hi,
> 
> Am 2021-02-10 08:03, schrieb Heiner Kallweit:
>> On 09.02.2021 17:40, Michael Walle wrote:
>>> Registers >= 16 are paged. Be sure to set the page. It seems this was
>>> working for now, because the default is correct for the registers used
>>> in the driver at the moment. But this will also assume, nobody will
>>> change the page select register before linux is started. The page select
>>> register is _not_ reset with a soft reset of the PHY.
>>>
>>> Add read_page()/write_page() support for the IP101G and use it
>>> accordingly.
>>>
>>> Signed-off-by: Michael Walle <michael@walle.cc>
>>> ---
>>>  drivers/net/phy/icplus.c | 50 +++++++++++++++++++++++++++++++---------
>>>  1 file changed, 39 insertions(+), 11 deletions(-)
>>>
>>> diff --git a/drivers/net/phy/icplus.c b/drivers/net/phy/icplus.c
>>> index a6e1c7611f15..858b9326a72d 100644
>>> --- a/drivers/net/phy/icplus.c
>>> +++ b/drivers/net/phy/icplus.c
>>> @@ -49,6 +49,8 @@ MODULE_LICENSE("GPL");
>>>  #define IP101G_DIGITAL_IO_SPEC_CTRL            0x1d
>>>  #define IP101G_DIGITAL_IO_SPEC_CTRL_SEL_INTR32        BIT(2)
>>>
>>> +#define IP101G_DEFAULT_PAGE            16
>>> +
>>>  #define IP175C_PHY_ID 0x02430d80
>>>  #define IP1001_PHY_ID 0x02430d90
>>>  #define IP101A_PHY_ID 0x02430c54
>>> @@ -250,23 +252,25 @@ static int ip101a_g_probe(struct phy_device *phydev)
>>>  static int ip101a_g_config_init(struct phy_device *phydev)
>>>  {
>>>      struct ip101a_g_phy_priv *priv = phydev->priv;
>>> -    int err;
>>> +    int oldpage, err;
>>> +
>>> +    oldpage = phy_select_page(phydev, IP101G_DEFAULT_PAGE);
>>>
>>>      /* configure the RXER/INTR_32 pin of the 32-pin IP101GR if needed: */
>>>      switch (priv->sel_intr32) {
>>>      case IP101GR_SEL_INTR32_RXER:
>>> -        err = phy_modify(phydev, IP101G_DIGITAL_IO_SPEC_CTRL,
>>> -                 IP101G_DIGITAL_IO_SPEC_CTRL_SEL_INTR32, 0);
>>> +        err = __phy_modify(phydev, IP101G_DIGITAL_IO_SPEC_CTRL,
>>> +                   IP101G_DIGITAL_IO_SPEC_CTRL_SEL_INTR32, 0);
>>>          if (err < 0)
>>> -            return err;
>>> +            goto out;
>>>          break;
>>>
>>>      case IP101GR_SEL_INTR32_INTR:
>>> -        err = phy_modify(phydev, IP101G_DIGITAL_IO_SPEC_CTRL,
>>> -                 IP101G_DIGITAL_IO_SPEC_CTRL_SEL_INTR32,
>>> -                 IP101G_DIGITAL_IO_SPEC_CTRL_SEL_INTR32);
>>> +        err = __phy_modify(phydev, IP101G_DIGITAL_IO_SPEC_CTRL,
>>> +                   IP101G_DIGITAL_IO_SPEC_CTRL_SEL_INTR32,
>>> +                   IP101G_DIGITAL_IO_SPEC_CTRL_SEL_INTR32);
>>>          if (err < 0)
>>> -            return err;
>>> +            goto out;
>>>          break;
>>>
>>>      default:
>>> @@ -284,12 +288,14 @@ static int ip101a_g_config_init(struct phy_device *phydev)
>>>       * reserved as 'write-one'.
>>>       */
>>>      if (priv->model == IP101A) {
>>> -        err = phy_set_bits(phydev, IP10XX_SPEC_CTRL_STATUS, IP101A_G_APS_ON);
>>> +        err = __phy_set_bits(phydev, IP10XX_SPEC_CTRL_STATUS,
>>> +                     IP101A_G_APS_ON);
>>>          if (err)
>>> -            return err;
>>> +            goto out;
>>>      }
>>>
>>> -    return 0;
>>> +out:
>>> +    return phy_restore_page(phydev, oldpage, err);
>>
>> If a random page was set before entering config_init, do we actually want
>> to restore it? Or wouldn't it be better to set the default page as part
>> of initialization?
> 
> First, I want to convert this to the match_phy_device() and while at it,
> I noticed that there is this one "problem". Short summary: the IP101A isn't
> paged, the IP101G has serveral and if page 16 is selected it is more or
> less compatible with the IP101A. My problem here is now how to share the
> functions for both PHYs without duplicating all the code. Eg. the IP101A
> will phy_read/phy_write/phy_modify(), that is, all the locked versions.
> For the IP101G I'd either need the _paged() versions or the __phy ones
> which don't take the mdio_bus lock.
> 
> Here is what I came up with:
> (1) provide a common function which uses the __phy ones, then the
>     callback for the A version will take the mdio_bus lock and calls
>     the common one. The G version will use phy_{select,restore}_page().
> (2) the phy_driver ops for A will also provde a .read/write_page()
>     callback which is just a no-op. So A can just use the G versions.
> (3) What Heiner mentioned here, just set the default page in
>     config_init().
> 
> (1) will still bloat the code; (3) has the disadvantage, that the
> userspace might fiddle around with the page register and then the
> whole PHY driver goes awry. I don't know if we have to respect that
> use case in general. I know there is an API to read/write the PHY
> registers and it could happen.
> 

The potential issue you mention here we have with all PHY's using
pages. As one example, the genphy functions rely on the PHY being
set to the default page. In general userspace can write PHY register
values that break processing, independent of paging.
I'm not aware of any complaints regarding this behavior, therefore
wouldn't be too concerned here.

Regarding (2) I'd like to come back to my proposal from yesterday,
implement match_phy_device to completely decouple the A and G versions.
Did you consider this option?

> That being said, I'm either fine with (2) and (3) but I'm preferring
> (2).
> 
> BTW, this patch is still missing read/writes to the interrupt status
> and control registers which is also paged.
> 
> -michael

Heiner