summaryrefslogtreecommitdiff
path: root/include/android_ab.h
diff options
context:
space:
mode:
authorDmitry Rokosov <ddrokosov@salutedevices.com>2024-10-17 17:12:06 +0300
committerMattijs Korpershoek <mkorpershoek@baylibre.com>2024-10-24 09:45:55 +0200
commit01874ac7c06b8c657e7c3fda5ac555f821ef5b36 (patch)
tree8e1e20c6dbc68c736d91f590e1e69a4056516c2d /include/android_ab.h
parent97c29f868dd4e6d8f38d1cfdd964fb6b2b40267c (diff)
include/android_ab: move ab_select_slot() documentation to @ notation
There are new function documentation requirements in U-Boot, so apply these changes for android_ab. Reviewed-by: Mattijs Korpershoek <mkorpershoek@baylibre.com> Reviewed-by: Simon Glass <sjg@chromium.org> Tested-by: Guillaume La Roque <glaroque@baylibre.com> Signed-off-by: Dmitry Rokosov <ddrokosov@salutedevices.com> Tested-by: Mattijs Korpershoek <mkorpershoek@baylibre.com> # vim3_android Link: https://lore.kernel.org/r/20241017-android_ab_master-v5-1-43bfcc096d95@salutedevices.com Signed-off-by: Mattijs Korpershoek <mkorpershoek@baylibre.com>
Diffstat (limited to 'include/android_ab.h')
-rw-r--r--include/android_ab.h7
1 files changed, 4 insertions, 3 deletions
diff --git a/include/android_ab.h b/include/android_ab.h
index dbf20343da6..1e53879a25f 100644
--- a/include/android_ab.h
+++ b/include/android_ab.h
@@ -18,7 +18,10 @@ struct disk_partition;
#define NUM_SLOTS 2
/**
- * Select the slot where to boot from.
+ * ab_select_slot() - Select the slot where to boot from.
+ *
+ * @dev_desc: Place to store the device description pointer
+ * @part_info: Place to store the partition information
*
* On Android devices with more than one boot slot (multiple copies of the
* kernel and system images) selects which slot should be used to boot from and
@@ -28,8 +31,6 @@ struct disk_partition;
* registered before returning from this function so it isn't selected
* indefinitely.
*
- * @param[in] dev_desc Place to store the device description pointer
- * @param[in] part_info Place to store the partition information
* Return: The slot number (>= 0) on success, or a negative on error
*/
int ab_select_slot(struct blk_desc *dev_desc, struct disk_partition *part_info,