summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorMichal Suchanek <msuchanek@suse.de>2022-09-25 14:08:16 +0300
committerSimon Glass <sjg@chromium.org>2022-10-29 16:36:33 +0300
commit58ddb937e1699de241e4aa39de90a68a0be71744 (patch)
treeea6c6fe38f35e78b64255a10a7afca2de82d8531 /include
parent6b08fb5cc44f8d32260a17a4f04c5bfa8dd5f18f (diff)
downloadu-boot-58ddb937e1699de241e4aa39de90a68a0be71744.tar.xz
dm: core: Switch uclass_*_device_err to use uclass_*_device_check
Clarify documentation, fix a few more cases that could be broken by the change. Signed-off-by: Michal Suchanek <msuchanek@suse.de>
Diffstat (limited to 'include')
-rw-r--r--include/dm/uclass.h12
1 files changed, 8 insertions, 4 deletions
diff --git a/include/dm/uclass.h b/include/dm/uclass.h
index 823a16527f..b1c016ef9f 100644
--- a/include/dm/uclass.h
+++ b/include/dm/uclass.h
@@ -350,7 +350,8 @@ int uclass_next_device(struct udevice **devp);
/**
* uclass_first_device_err() - Get the first device in a uclass
*
- * The device returned is probed if necessary, and ready for use
+ * The device returned is probed if necessary, and ready for use if no error is
+ * returned
*
* @id: Uclass ID to look up
* @devp: Returns pointer to the first device in that uclass, or NULL if none
@@ -361,7 +362,8 @@ int uclass_first_device_err(enum uclass_id id, struct udevice **devp);
/**
* uclass_next_device_err() - Get the next device in a uclass
*
- * The device returned is probed if necessary, and ready for use
+ * The device returned is probed if necessary, and ready for use if no error is
+ * returned
*
* @devp: On entry, pointer to device to lookup. On exit, returns pointer
* to the next device in the uclass if no error occurred, or NULL if
@@ -373,7 +375,8 @@ int uclass_next_device_err(struct udevice **devp);
/**
* uclass_first_device_check() - Get the first device in a uclass
*
- * The device returned is probed if necessary, and ready for use
+ * The device returned is probed if necessary, and ready for use if no error is
+ * returned
*
* This function is useful to start iterating through a list of devices which
* are functioning correctly and can be probed.
@@ -389,7 +392,8 @@ int uclass_first_device_check(enum uclass_id id, struct udevice **devp);
/**
* uclass_next_device_check() - Get the next device in a uclass
*
- * The device returned is probed if necessary, and ready for use
+ * The device returned is probed if necessary, and ready for use if no error is
+ * returned
*
* This function is useful to start iterating through a list of devices which
* are functioning correctly and can be probed.