aboutsummaryrefslogtreecommitdiff
path: root/include/mmc.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/mmc.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/mmc.h')
-rw-r--r--include/mmc.h22
1 files changed, 11 insertions, 11 deletions
diff --git a/include/mmc.h b/include/mmc.h
index 244d2dc5921..6bdcce881dd 100644
--- a/include/mmc.h
+++ b/include/mmc.h
@@ -390,7 +390,7 @@ struct mmc_uclass_priv {
* will be available.
*
* @dev: Device
- * @return associated mmc struct pointer if available, else NULL
+ * Return: associated mmc struct pointer if available, else NULL
*/
struct mmc *mmc_get_mmc_dev(const struct udevice *dev);
@@ -768,7 +768,7 @@ struct mmc *mmc_create(const struct mmc_config *cfg, void *priv);
* @dev: MMC device to set up
* @mmc: MMC struct
* @cfg: MMC configuration
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int mmc_bind(struct udevice *dev, struct mmc *mmc,
const struct mmc_config *cfg);
@@ -778,7 +778,7 @@ void mmc_destroy(struct mmc *mmc);
* mmc_unbind() - Unbind a MMC device's child block device
*
* @dev: MMC device
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int mmc_unbind(struct udevice *dev);
int mmc_initialize(struct bd_info *bis);
@@ -793,7 +793,7 @@ int mmc_deinit(struct mmc *mmc);
*
* @dev: MMC device
* @cfg: MMC configuration
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int mmc_of_parse(struct udevice *dev, struct mmc_config *cfg);
@@ -803,7 +803,7 @@ int mmc_of_parse(struct udevice *dev, struct mmc_config *cfg);
*
* @dev: MMC device
* @cfg: MMC configuration
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int mmc_pwrseq_get_power(struct udevice *dev, struct mmc_config *cfg);
#endif
@@ -814,7 +814,7 @@ int mmc_read(struct mmc *mmc, u64 src, uchar *dst, int size);
* mmc_voltage_to_mv() - Convert a mmc_voltage in mV
*
* @voltage: The mmc_voltage to convert
- * @return the value in mV if OK, -EINVAL on error (invalid mmc_voltage value)
+ * Return: the value in mV if OK, -EINVAL on error (invalid mmc_voltage value)
*/
int mmc_voltage_to_mv(enum mmc_voltage voltage);
@@ -823,7 +823,7 @@ int mmc_voltage_to_mv(enum mmc_voltage voltage);
* @mmc: MMC struct
* @clock: bus frequency in Hz
* @disable: flag indicating if the clock must on or off
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int mmc_set_clock(struct mmc *mmc, uint clock, bool disable);
@@ -837,7 +837,7 @@ void print_mmc_devices(char separator);
/**
* get_mmc_num() - get the total MMC device number
*
- * @return 0 if there is no MMC device, else the number of devices
+ * Return: 0 if there is no MMC device, else the number of devices
*/
int get_mmc_num(void);
int mmc_switch_part(struct mmc *mmc, unsigned int part_num);
@@ -898,7 +898,7 @@ int mmc_set_bkops_enable(struct mmc *mmc);
*
* @param mmc Pointer to a MMC device struct
* @param quiet Be quiet, do not print error messages when card is not detected.
- * @return 0 on success, <0 on error.
+ * Return: 0 on success, <0 on error.
*/
int mmc_get_op_cond(struct mmc *mmc, bool quiet);
@@ -909,7 +909,7 @@ int mmc_get_op_cond(struct mmc *mmc, bool quiet);
* initializatin.
*
* @param mmc Pointer to a MMC device struct
- * @return 0 on success, <0 on error.
+ * Return: 0 on success, <0 on error.
*/
int mmc_start_init(struct mmc *mmc);
@@ -956,7 +956,7 @@ int mmc_get_env_dev(void);
* mmc_get_blk_desc() - Get the block descriptor for an MMC device
*
* @mmc: MMC device
- * @return block device if found, else NULL
+ * Return: block device if found, else NULL
*/
struct blk_desc *mmc_get_blk_desc(struct mmc *mmc);