]> git.dujemihanovic.xyz Git - u-boot.git/commitdiff
dm: core: Fix a few incorrect comments on first/next functions
authorSimon Glass <sjg@chromium.org>
Thu, 19 Aug 2021 03:40:29 +0000 (21:40 -0600)
committerTom Rini <trini@konsulko.com>
Thu, 16 Sep 2021 17:19:25 +0000 (13:19 -0400)
Tighten up these comments to make the behaviour clearer.

Signed-off-by: Simon Glass <sjg@chromium.org>
include/dm/device.h
include/dm/uclass.h

index 0a9718a5b81a3096ec6c8224e6a1f8172d957f9e..ef6241bca8ba4aadd0d7f2e702b2aebb03803345 100644 (file)
@@ -738,7 +738,7 @@ int device_find_next_child(struct udevice **devp);
  *
  * @parent:    Parent device to search
  * @uclass_id: Uclass to look for
- * @devp:      Returns device found, if any
+ * @devp:      Returns device found, if any, else NULL
  * @return 0 if found, else -ENODEV
  */
 int device_find_first_inactive_child(const struct udevice *parent,
@@ -750,7 +750,7 @@ int device_find_first_inactive_child(const struct udevice *parent,
  *
  * @parent: Parent device to search
  * @uclass_id: Uclass to look for
- * @devp: Returns first child device in that uclass, if any
+ * @devp: Returns first child device in that uclass, if any, else NULL
  * @return 0 if found, else -ENODEV
  */
 int device_find_first_child_by_uclass(const struct udevice *parent,
index da0c1bfadb1efb02641d9febd7ad2c9e1f64cf55..15e5f9ef5bcd9a60a9f1e62d848d68bad599f78a 100644 (file)
@@ -354,7 +354,7 @@ int uclass_next_device(struct udevice **devp);
  * The device returned is probed if necessary, and ready for use
  *
  * @devp: On entry, pointer to device to lookup. On exit, returns pointer
- * to the next device in the uclass if no error occurred, or -ENODEV if
+ * to the next device in the uclass if no error occurred, or NULL if
  * there is no next device.
  * @return 0 if found, -ENODEV if not found, other -ve on error
  */