summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Lechner <[email protected]>2026-03-26 17:59:25 -0500
committerTom Rini <[email protected]>2026-04-08 11:07:07 -0600
commit7b824e75056a45d7c40eea9014edffa1b5289750 (patch)
treedc07733960cc81358e8a52622f0aa2fbb32f85b3
parente5d8ad260bb7de1729a6454e8b95a83e629dff7a (diff)
scsi: document return values of public functions
Add Return: documentation for some public functions in scsi.h that were missing it. Signed-off-by: David Lechner <[email protected]>
-rw-r--r--include/scsi.h3
1 files changed, 3 insertions, 0 deletions
diff --git a/include/scsi.h b/include/scsi.h
index 8d6c5116419..c244120c283 100644
--- a/include/scsi.h
+++ b/include/scsi.h
@@ -340,6 +340,7 @@ int scsi_bus_reset(struct udevice *dev);
* scsi_scan() - Scan all SCSI controllers for available devices
*
* @vebose: true to show information about each device found
+ * Return: 0 if OK, -ve on error
*/
int scsi_scan(bool verbose);
@@ -348,6 +349,7 @@ int scsi_scan(bool verbose);
*
* @dev: SCSI bus
* @verbose: true to show information about each device found
+ * Return: 0 if OK, -ve on error
*/
int scsi_scan_dev(struct udevice *dev, bool verbose);
@@ -357,6 +359,7 @@ int scsi_scan_dev(struct udevice *dev, bool verbose);
* @uuid: UUID of the partition for fetching its info
* @blk_desc_ptr: Provides the blk descriptor
* @part_info_ptr: Provides partition info
+ * Return: 0 if OK, -ve on error
*/
int scsi_get_blk_by_uuid(const char *uuid, struct blk_desc **blk_desc_ptr,
struct disk_partition *part_info_ptr);