]> git.ipfire.org Git - thirdparty/u-boot.git/commitdiff
scsi: document return values of public functions
authorDavid Lechner <dlechner@baylibre.com>
Thu, 26 Mar 2026 22:59:25 +0000 (17:59 -0500)
committerTom Rini <trini@konsulko.com>
Wed, 8 Apr 2026 17:07:07 +0000 (11:07 -0600)
Add Return: documentation for some public functions in scsi.h that were
missing it.

Signed-off-by: David Lechner <dlechner@baylibre.com>
include/scsi.h

index 8d6c5116419370cccd2a76d4cc3af6cfbede7fe7..c244120c28395006749adc17b5056d654f0c08c2 100644 (file)
@@ -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);