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>
This commit is contained in:
Dmitry Rokosov 2024-10-17 17:12:06 +03:00 committed by Mattijs Korpershoek
parent 97c29f868d
commit 01874ac7c0
2 changed files with 28 additions and 22 deletions

View file

@ -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,