summaryrefslogtreecommitdiff
path: root/include/p2sb.h
diff options
context:
space:
mode:
authorHeinrich Schuchardt <heinrich.schuchardt@canonical.com>2022-01-19 20:05:50 +0300
committerHeinrich Schuchardt <heinrich.schuchardt@canonical.com>2022-01-19 20:11:34 +0300
commit185f812c419f1b4f0d10d9787d59cf9f11a2a600 (patch)
tree2fea02768d6005934547f075586c60ba7aca6253 /include/p2sb.h
parent6a685753ce8b6b02b67d64b239143bf19eda63c9 (diff)
downloadu-boot-185f812c419f1b4f0d10d9787d59cf9f11a2a600.tar.xz
doc: replace @return by Return:
Sphinx expects Return: and not @return to indicate a return value. find . -name '*.c' -exec \ sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \; find . -name '*.h' -exec \ sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \; Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Diffstat (limited to 'include/p2sb.h')
-rw-r--r--include/p2sb.h10
1 files changed, 5 insertions, 5 deletions
diff --git a/include/p2sb.h b/include/p2sb.h
index ddbc8d5e14..00acc8d935 100644
--- a/include/p2sb.h
+++ b/include/p2sb.h
@@ -63,7 +63,7 @@ struct p2sb_ops {
*
* @dev: P2SB device
* @hide: true to hide the device, false to show it
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int p2sb_set_hide(struct udevice *dev, bool hide);
@@ -74,7 +74,7 @@ int p2sb_set_hide(struct udevice *dev, bool hide);
*
* @dev: Device to read from
* @offset: Offset within device to read
- * @return value read
+ * Return: value read
*/
uint pcr_read32(struct udevice *dev, uint offset);
uint pcr_read16(struct udevice *dev, uint offset);
@@ -149,7 +149,7 @@ static inline void pcr_clrbits8(struct udevice *dev, uint offset, uint clr)
*
* @dev: Child device (whose parent is UCLASS_P2SB)
* @portid: Port ID of child device
- * @return 0 if OK, -ENODEV is the p2sb device could not be found
+ * Return: 0 if OK, -ENODEV is the p2sb device could not be found
*/
int p2sb_set_port_id(struct udevice *dev, int portid);
@@ -157,7 +157,7 @@ int p2sb_set_port_id(struct udevice *dev, int portid);
* p2sb_get_port_id() - Get the port ID for a p2sb child device
*
* @dev: Child device (whose parent is UCLASS_P2SB)
- * @return Port ID of that child
+ * Return: Port ID of that child
*/
int p2sb_get_port_id(struct udevice *dev);
@@ -166,7 +166,7 @@ int p2sb_get_port_id(struct udevice *dev);
*
* @dev: Child device (whose parent is UCLASS_P2SB)
* @offset: Offset within that child's address space
- * @return pointer to that offset within the child's address space
+ * Return: pointer to that offset within the child's address space
*/
void *pcr_reg_address(struct udevice *dev, uint offset);