diff options
| author | Simon Glass | 2017-04-23 20:10:43 -0600 |
|---|---|---|
| committer | Simon Glass | 2017-07-11 10:08:19 -0600 |
| commit | 30a570a983c77cddda314cdb2bc5763112338746 (patch) | |
| tree | a47bab91f813317366d125f5248e711d104dc7c3 | |
| parent | 6b26aaef083957b75bcd69aa65bd6ffcf9245bb3 (diff) | |
dm: core: Clarify uclass_first/next_device() comments
These are not as clear as they could be. Tidy them up a bit. Also fix a
tiny code-style nit.
Signed-off-by: Simon Glass <sjg@chromium.org>
| -rw-r--r-- | drivers/core/uclass.c | 3 | ||||
| -rw-r--r-- | include/dm/uclass.h | 13 |
2 files changed, 12 insertions, 4 deletions
diff --git a/drivers/core/uclass.c b/drivers/core/uclass.c index 21dc696da35..97500f41084 100644 --- a/drivers/core/uclass.c +++ b/drivers/core/uclass.c @@ -366,8 +366,7 @@ int uclass_get_device_by_driver(enum uclass_id id, return -ENODEV; } -int uclass_get_device_tail(struct udevice *dev, int ret, - struct udevice **devp) +int uclass_get_device_tail(struct udevice *dev, int ret, struct udevice **devp) { if (ret) return ret; diff --git a/include/dm/uclass.h b/include/dm/uclass.h index 7f5a1304b5c..4dcd883ac55 100644 --- a/include/dm/uclass.h +++ b/include/dm/uclass.h @@ -241,8 +241,13 @@ int uclass_get_device_by_driver(enum uclass_id id, const struct driver *drv, * * The device returned is probed if necessary, and ready for use * + * This function is useful to start iterating through a list of devices which + * are functioning correctly and can be probed. + * * @id: Uclass ID to look up - * @devp: Returns pointer to the first device in that uclass, or NULL if none + * @devp: Returns pointer to the first device in that uclass if no error + * occurred, or NULL if there is no first device, or an error occurred with + * that device. * @return 0 if OK (found or not found), other -ve on error */ int uclass_first_device(enum uclass_id id, struct udevice **devp); @@ -263,8 +268,12 @@ int uclass_first_device_err(enum uclass_id id, struct udevice **devp); * * The device returned is probed if necessary, and ready for use * + * This function is useful to start iterating through a list of devices which + * are functioning correctly and can be probed. + * * @devp: On entry, pointer to device to lookup. On exit, returns pointer - * to the next device in the same uclass, or NULL if none + * to the next device in the uclass if no error occurred, or NULL if there is + * no next device, or an error occurred with that next device. * @return 0 if OK (found or not found), other -ve on error */ int uclass_next_device(struct udevice **devp); |