Commit 0d1c7e55 authored by Vinod Koul's avatar Vinod Koul
Browse files

phy: qualcomm: ipq806x-usb: Fix kernel-doc style 



The functions are documented but there were style issues, so fix
the style and add missing description for phy_dwc3

drivers/phy/qualcomm/phy-qcom-ipq806x-usb.c:130:
drivers/phy/qualcomm/phy-qcom-ipq806x-usb.c:174:
drivers/phy/qualcomm/phy-qcom-ipq806x-usb.c:212: warning:
This comment starts with '/**', but isn't a kernel-doc comment.
Refer Documentation/doc-guide/kernel-doc.rst

Reviewed-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Signed-off-by: default avatarVinod Koul <vkoul@kernel.org>
Reviewed-by: default avatarBjorn Andersson <bjorn.andersson@linaro.org>
Link: https://lore.kernel.org/r/20211120061531.410771-1-vkoul@kernel.org


Signed-off-by: default avatarVinod Koul <vkoul@kernel.org>
parent 466b1516

drivers/phy/qualcomm/phy-qcom-ipq806x-usb.c

+14 −12
Original line number Diff line number Diff line
@@ -127,12 +127,13 @@ struct phy_drvdata { 
};



/**

 * Write register and read back masked value to confirm it is written

 * usb_phy_write_readback() - Write register and read back masked value to

 * confirm it is written

 *

 * @base - QCOM DWC3 PHY base virtual address.

 * @offset - register offset.

 * @mask - register bitmask specifying what should be updated

 * @val - value to write.

 * @phy_dwc3: QCOM DWC3 phy context

 * @offset: register offset.

 * @mask: register bitmask specifying what should be updated

 * @val: value to write.

 */

static inline void usb_phy_write_readback(struct usb_phy *phy_dwc3,

					  u32 offset,
@@ -171,11 +172,11 @@ static int wait_for_latch(void __iomem *addr) 
}



/**

 * Write SSPHY register

 * usb_ss_write_phycreg() - Write SSPHY register

 *

 * @base - QCOM DWC3 PHY base virtual address.

 * @addr - SSPHY address to write.

 * @val - value to write.

 * @phy_dwc3: QCOM DWC3 phy context

 * @addr: SSPHY address to write.

 * @val: value to write.

 */

static int usb_ss_write_phycreg(struct usb_phy *phy_dwc3,

				u32 addr, u32 val)
@@ -209,10 +210,11 @@ static int usb_ss_write_phycreg(struct usb_phy *phy_dwc3, 
}



/**

 * Read SSPHY register.

 * usb_ss_read_phycreg() - Read SSPHY register.

 *

 * @base - QCOM DWC3 PHY base virtual address.

 * @addr - SSPHY address to read.

 * @phy_dwc3: QCOM DWC3 phy context

 * @addr: SSPHY address to read.

 * @val: pointer in which read is store.

 */

static int usb_ss_read_phycreg(struct usb_phy *phy_dwc3,

			       u32 addr, u32 *val)