aboutsummaryrefslogtreecommitdiff
path: root/include/syscon.h
diff options
context:
space:
mode:
authorHeinrich Schuchardt2022-01-19 18:05:50 +0100
committerHeinrich Schuchardt2022-01-19 18:11:34 +0100
commit185f812c419f1b4f0d10d9787d59cf9f11a2a600 (patch)
tree2fea02768d6005934547f075586c60ba7aca6253 /include/syscon.h
parent6a685753ce8b6b02b67d64b239143bf19eda63c9 (diff)
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/syscon.h')
-rw-r--r--include/syscon.h10
1 files changed, 5 insertions, 5 deletions
diff --git a/include/syscon.h b/include/syscon.h
index 2e02199c051..f5e6cc1a4b1 100644
--- a/include/syscon.h
+++ b/include/syscon.h
@@ -43,7 +43,7 @@ struct syscon_base_plat {
*
* @dev: Device to check (UCLASS_SCON)
* @info: Returns regmap for the device
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
struct regmap *syscon_get_regmap(struct udevice *dev);
@@ -56,7 +56,7 @@ struct regmap *syscon_get_regmap(struct udevice *dev);
*
* @driver_data: Driver data value to look up
* @devp: Returns the controller correponding to @driver_data
- * @return 0 on success, -ENODEV if the ID was not found, or other -ve error
+ * Return: 0 on success, -ENODEV if the ID was not found, or other -ve error
* code
*/
int syscon_get_by_driver_data(ulong driver_data, struct udevice **devp);
@@ -69,7 +69,7 @@ int syscon_get_by_driver_data(ulong driver_data, struct udevice **devp);
* are in use. This function looks up the regmap given this driver data.
*
* @driver_data: Driver data value to look up
- * @return register map correponding to @driver_data, or -ve error code
+ * Return: register map correponding to @driver_data, or -ve error code
*/
struct regmap *syscon_get_regmap_by_driver_data(ulong driver_data);
@@ -81,7 +81,7 @@ struct regmap *syscon_get_regmap_by_driver_data(ulong driver_data);
*
* @dev: Device using the system controller
* @name: Name of property referring to the system controller
- * @return A pointer to the regmap if found, ERR_PTR(-ve) on error
+ * Return: A pointer to the regmap if found, ERR_PTR(-ve) on error
*/
struct regmap *syscon_regmap_lookup_by_phandle(struct udevice *dev,
const char *name);
@@ -90,7 +90,7 @@ struct regmap *syscon_regmap_lookup_by_phandle(struct udevice *dev,
* syscon_get_first_range() - get the first memory range from a syscon regmap
*
* @driver_data: Driver data value to look up
- * @return first region of register map correponding to @driver_data, or
+ * Return: first region of register map correponding to @driver_data, or
* -ve error code
*/
void *syscon_get_first_range(ulong driver_data);