Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

phy: mediatek: tphy: Clarify and add kerneldoc to mtk_phy_pdata

As struct mtk_phy_pdata was almost fully documented, transfer
the comments into kerneldoc on top.
While at it, also rewrite the comments to both improve the writing
writing and the actual information in the documentation, and add a
description for the `version` member of the structure.

Signed-off-by: AngeloGioacchino Del Regno <angelogioacchino.delregno@collabora.com>
Reviewed-by: Neil Armstrong <neil.armstrong@linaro.org>
Link: https://lore.kernel.org/r/20250623120315.109881-2-angelogioacchino.delregno@collabora.com
Signed-off-by: Vinod Koul <vkoul@kernel.org>

authored by

AngeloGioacchino Del Regno and committed by
Vinod Koul
9cc82c24 05c6f319

+10 -10
+10 -10
drivers/phy/mediatek/phy-mtk-tphy.c
··· 277 277 MTK_PHY_V3, 278 278 }; 279 279 280 + /** 281 + * mtk_phy_pdata - SoC specific platform data 282 + * @avoid_rx_sen_degradation: Avoid TX Sensitivity level degradation (MT6795/8173 only) 283 + * @sw_pll_48m_to_26m: Workaround for V3 IP (MT8195) - switch the 48MHz PLL from 284 + * fractional mode to integer to output 26MHz for U2PHY 285 + * @sw_efuse_supported: Switches off eFuse auto-load from PHY and applies values 286 + * read from different nvmem (usually different eFuse array) 287 + * that is pointed at in the device tree node for this PHY 288 + * @version: PHY IP Version 289 + */ 280 290 struct mtk_phy_pdata { 281 - /* avoid RX sensitivity level degradation only for mt8173 */ 282 291 bool avoid_rx_sen_degradation; 283 - /* 284 - * workaround only for mt8195, HW fix it for others of V3, 285 - * u2phy should use integer mode instead of fractional mode of 286 - * 48M PLL, fix it by switching PLL to 26M from default 48M 287 - */ 288 292 bool sw_pll_48m_to_26m; 289 - /* 290 - * Some SoCs (e.g. mt8195) drop a bit when use auto load efuse, 291 - * support sw way, also support it for v2/v3 optionally. 292 - */ 293 293 bool sw_efuse_supported; 294 294 enum mtk_phy_version version; 295 295 };