Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 49193a66 authored by Vince Bridgers's avatar Vince Bridgers Committed by David S. Miller
Browse files

Documentation: networking: phy.txt: Update text for indirect MMD access 



Update the PHY library documentation to describe how a specific PHY
driver can use the PAL MMD register access routines or override those
routines with it's own in the event the PHY does not support the IEEE
standard for reading and writing MMD phy registers.

Signed-off-by: default avatarVince Bridgers <vbridgers2013@gmail.com>
Reviewed-by: default avatarFlorian Fainelli <f.fainelli@gmail.com>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent 19936942

Documentation/networking/phy.txt

+17 −1
Original line number Diff line number Diff line
@@ -272,6 +272,8 @@ Writing a PHY driver 
   txtsamp: Requests a transmit timestamp at the PHY level for a 'skb'

   set_wol: Enable Wake-on-LAN at the PHY level

   get_wol: Get the Wake-on-LAN status at the PHY level

   read_mmd_indirect: Read PHY MMD indirect register

   write_mmd_indirect: Write PHY MMD indirect register



 Of these, only config_aneg and read_status are required to be

 assigned by the driver code.  The rest are optional.  Also, it is
@@ -284,7 +286,21 @@ Writing a PHY driver 


 Feel free to look at the Marvell, Cicada, and Davicom drivers in

 drivers/net/phy/ for examples (the lxt and qsemi drivers have

 not been tested as of this writing)

 not been tested as of this writing).



 The PHY's MMD register accesses are handled by the PAL framework

 by default, but can be overridden by a specific PHY driver if

 required. This could be the case if a PHY was released for

 manufacturing before the MMD PHY register definitions were

 standardized by the IEEE. Most modern PHYs will be able to use

 the generic PAL framework for accessing the PHY's MMD registers.

 An example of such usage is for Energy Efficient Ethernet support,

 implemented in the PAL. This support uses the PAL to access MMD

 registers for EEE query and configuration if the PHY supports

 the IEEE standard access mechanisms, or can use the PHY's specific

 access interfaces if overridden by the specific PHY driver. See

 the Micrel driver in drivers/net/phy/ for an example of how this

 can be implemented.



Board Fixups