summaryrefslogtreecommitdiff
path: root/include/ahci.h
diff options
context:
space:
mode:
authorHeinrich Schuchardt <heinrich.schuchardt@canonical.com>2022-01-19 18:05:50 +0100
committerHeinrich Schuchardt <heinrich.schuchardt@canonical.com>2022-01-19 18:11:34 +0100
commit185f812c419f1b4f0d10d9787d59cf9f11a2a600 (patch)
tree2fea02768d6005934547f075586c60ba7aca6253 /include/ahci.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/ahci.h')
-rw-r--r--include/ahci.h12
1 files changed, 6 insertions, 6 deletions
diff --git a/include/ahci.h b/include/ahci.h
index d5453042d1..d7f951c388 100644
--- a/include/ahci.h
+++ b/include/ahci.h
@@ -202,7 +202,7 @@ struct ahci_ops {
* sata_reset() - reset the controller
*
* @dev: Controller to reset
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int sata_reset(struct udevice *dev);
@@ -211,7 +211,7 @@ int sata_reset(struct udevice *dev);
*
* @dev: Controller to reset
* @port: Port number to check (0 for first)
- * @return 0 if detected, -ENXIO if nothin on port, other -ve on error
+ * Return: 0 if detected, -ENXIO if nothin on port, other -ve on error
*/
int sata_dm_port_status(struct udevice *dev, int port);
@@ -219,7 +219,7 @@ int sata_dm_port_status(struct udevice *dev, int port);
* sata_scan() - scan SATA ports
*
* @dev: Controller to scan
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int sata_scan(struct udevice *dev);
@@ -254,7 +254,7 @@ int ahci_init_dm(struct udevice *dev, void __iomem *base);
*
* @ahci_dev: AHCI parent device
* @devp: Returns new SCSI bus device
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int ahci_bind_scsi(struct udevice *ahci_dev, struct udevice **devp);
@@ -266,7 +266,7 @@ int ahci_bind_scsi(struct udevice *ahci_dev, struct udevice **devp);
*
* @ahci_dev: AHCI parent device
* @base: Base address of AHCI port
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int ahci_probe_scsi(struct udevice *ahci_dev, ulong base);
@@ -277,7 +277,7 @@ int ahci_probe_scsi(struct udevice *ahci_dev, ulong base);
* devices it finds.
*
* @ahci_dev: AHCI parent device
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int ahci_probe_scsi_pci(struct udevice *ahci_dev);