Commit bbae18f0 authored Jul 22, 2019 by Marek Szyprowski Committed by Kishon Vijay Abraham I Aug 23, 2019

phy: core: document phy_calibrate()



Commit 36914111 ("drivers: phy: add calibrate method") added support
for generic phy_calibrate() method, but it didn't explain in detail when
such method is supposed to be called. Add some more documentation directly
to the phy.h to make it clean that it is intended to be called after every
host controller reset.

Signed-off-by: Marek Szyprowski <m.szyprowski@samsung.com>
Signed-off-by: Kishon Vijay Abraham I <kishon@ti.com>

parent beae796d

drivers/phy/phy-core.c

+10 −0

Original line number	Diff line number	Diff line
		@@ -394,6 +394,16 @@ int phy_reset(struct phy *phy)
		}
		EXPORT_SYMBOL_GPL(phy_reset);

		/**
		* phy_calibrate() - Tunes the phy hw parameters for current configuration
		* @phy: the phy returned by phy_get()
		*
		* Used to calibrate phy hardware, typically by adjusting some parameters in
		* runtime, which are otherwise lost after host controller reset and cannot
		* be applied in phy_init() or phy_power_on().
		*
		* Returns: 0 if successful, an negative error code otherwise
		*/
		int phy_calibrate(struct phy *phy)
		{
		int ret;

Admin message