Skip to content

Commit 0d1c7e5

Browse files
committed
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: Randy Dunlap <[email protected]> Signed-off-by: Vinod Koul <[email protected]> Reviewed-by: Bjorn Andersson <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Vinod Koul <[email protected]>
1 parent 466b151 commit 0d1c7e5

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

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

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -127,12 +127,13 @@ struct phy_drvdata {
127127
};
128128

129129
/**
130-
* Write register and read back masked value to confirm it is written
130+
* usb_phy_write_readback() - Write register and read back masked value to
131+
* confirm it is written
131132
*
132-
* @base - QCOM DWC3 PHY base virtual address.
133-
* @offset - register offset.
134-
* @mask - register bitmask specifying what should be updated
135-
* @val - value to write.
133+
* @phy_dwc3: QCOM DWC3 phy context
134+
* @offset: register offset.
135+
* @mask: register bitmask specifying what should be updated
136+
* @val: value to write.
136137
*/
137138
static inline void usb_phy_write_readback(struct usb_phy *phy_dwc3,
138139
u32 offset,
@@ -171,11 +172,11 @@ static int wait_for_latch(void __iomem *addr)
171172
}
172173

173174
/**
174-
* Write SSPHY register
175+
* usb_ss_write_phycreg() - Write SSPHY register
175176
*
176-
* @base - QCOM DWC3 PHY base virtual address.
177-
* @addr - SSPHY address to write.
178-
* @val - value to write.
177+
* @phy_dwc3: QCOM DWC3 phy context
178+
* @addr: SSPHY address to write.
179+
* @val: value to write.
179180
*/
180181
static int usb_ss_write_phycreg(struct usb_phy *phy_dwc3,
181182
u32 addr, u32 val)
@@ -209,10 +210,11 @@ static int usb_ss_write_phycreg(struct usb_phy *phy_dwc3,
209210
}
210211

211212
/**
212-
* Read SSPHY register.
213+
* usb_ss_read_phycreg() - Read SSPHY register.
213214
*
214-
* @base - QCOM DWC3 PHY base virtual address.
215-
* @addr - SSPHY address to read.
215+
* @phy_dwc3: QCOM DWC3 phy context
216+
* @addr: SSPHY address to read.
217+
* @val: pointer in which read is store.
216218
*/
217219
static int usb_ss_read_phycreg(struct usb_phy *phy_dwc3,
218220
u32 addr, u32 *val)

0 commit comments

Comments
 (0)